package
1.5.0
Repository: https://github.com/m3db/m3.git
Documentation: pkg.go.dev

# Functions

Alias takes one metric or a wildcard seriesList and a string in quotes.
AliasSub runs series names through a regex search/replace.
Changed will output a 1 if the value changed or 0 if not.
CompareOutputsAndExpected compares the actual output with the expected output.
ConstantLine draws a horizontal line at a specified value.
ConstantSeries returns a new constant series with a granularity of one data point per second.
Count draws a horizontal line representing the number of nodes found in the seriesList.
Derivative returns a function that computes the derivative among the values it has seen.
ErrInvalidPercentile is used when the percentile specified is incorrect.
FetchWithBootstrap requests the same data but with a bootstrap period at the beginning.
Filter removes data that does not satisfy a given predicate.
GetPercentile computes the percentile cut off for an array of floats.
GreaterThan is a ThresholdComparator function for when a value is greater than a threshold.
Head returns the first n elements of a series list or the entire list.
Identity returns datapoints where the value equals the timestamp of the datapoint.
Integral returns a function that accumulates values it has seen.
IsNonNull replaces datapoints that are non-null with 1, and null values with 0.
LessThan is a ThresholdComparator function for when a value is less than a threshold.
Logarithm takes one series or a series list, and draws the y-axis in logarithmic format.
MaintainNaNTransformer only applies a given ValueTransformer to non-NaN values.
NewChildContextOptions returns an initialized ChildContextOptions struct.
NewConsolidationTestSeries returns multiple static series for consolidation.
NewContext creates a new context.
NewEngine creates a new query engine.
NewStatelessTransformer creates a new stateless transformer.
NewTestContext creates a new test context.
NewTestSeriesList creates a test series and values from a set of inputs.
NewTestSeriesValues creates a new ts.Values with given step size and values.
NonNegativeDerivative returns a function that computes the derivative among the values it has seen but ignores datapoints that trend down.
Normalize normalizes all input series to the same start time, step size, and end time.
NPercentile returns percentile-percent of each series in the seriesList.
Offset adds a value to each element of a series list.
ParseInterval parses an interval string and returns the corresponding duration.
PerSecond computes the derivative between consecutive values in the a time series, taking into account the time interval between the values.
Range distills down a set of inputs into the range of the series.
RemoveByPercentile removes all series above or below the given percentile, as determined by the PercentileComparator.
RemoveEmpty removes all series that have NaN data.
SafeAverage returns the average of the input slice and the number of NaNs in the input.
SafeCount returns the number of valid values in the input slice and the number of NaNs in the input.
SafeDiff returns the subtracted value of all the subsequent numbers from the 1st one and the number of NaNs in the input.
SafeLast returns the last value of the input slice and the number of NaNs in the input.
SafeMax returns the maximum value of the input slice and the number of NaNs in the input.
SafeMedian returns the median value of the input slice and the number of NaNs in the input.
SafeMin returns the minimum value of the input slice and the number of NaNs in the input.
SafeMul returns the product value of the input slice and the number of NaNs in the input.
SafeRange returns the range value of the input slice and the number of NaNs in the input.
SafeSort sorts the input slice and returns the number of NaNs in the input.
SafeStddev returns the standard deviation value of the input slice and the number of NaNs in the input.
SafeSum returns the sum of the input slice and the number of NaNs in the input.
Scale multiplies each element of a series list by a given value.
Stdev takes one metric or a wildcard seriesList followed by an integer N.
Transform applies a specified ValueTransform to all values in each series, renaming each series with the given SeriesRenamer.
TransformNull transforms all nulls in a series to a value.

# Constants

FloatingPointFormat is the floating point format for naming.
MillisPerMinute is for milliseconds per minute.
MillisPerSecond is for millis per second.
SecondsPerMinute is for seconds per minute.

# Variables

ErrEmptySeriesList occurs when a function requires a series as input.
ErrInvalidIntervalFormat occurs when invalid interval string encountered.
ErrNegativeCount occurs when the request count is < 0.
SafeAggregationFns is the collection of safe aggregation functions.

# Structs

ChildContextOptions is a set of options to pass when creating a child context.
Context is the parameters to a query evaluation.
ContextOptions provides the options to create the context with.
The Engine for running queries.
ExplicitBootstrap is an explicit bootstrap that's expected at a block start.
MovingFunctionStorage is a special test construct for all moving functions.
SeriesNameAndValues is a series name and a set of values.
TestSeries is used to create a tsdb.timeSeries.
TimeRangeAdjustment is an applied time range adjustment.
A Trace is tracing information about a function or fetch within a query.
TraceStats tracks the number of timeseries used by a trace.

# Interfaces

QueryEngine is the generic engine interface.
Transformer transforms a value.

# Type aliases

PercentileNamer formats a string with a percentile.
PredicateFn is a predicate function.
RenamerWithNumPoints is a signature for renaming a single series that is passed to Stdev.
SafeAggregationFn is a safe aggregation function.
SeriesListRenamer is a signature for renaming multiple series into a single name.
SeriesRenamer is a signature for renaming a single series.
ThresholdComparator compares two floats for other comparison functions such as Percentile checks.
A Tracer is used to record a Trace.
TransformFunc is used by Transform to apply a function to all values in a series.
TransformFuncFactory creates transformation functions.