summary

Documentation

Index

• Variables

Variables

var Count = recent(
	"summarize.count",
	func(slice []float64) float64 {
		count := 0
		for i := range slice {
			if math.IsNaN(slice[i]) {
				continue
			}
			count++
		}
		return float64(count)
	},
)

Count computes the number of non-missing points in the line

var Current = function.MakeFunction(
	"summarize.current",
	func(list api.SeriesList) function.ScalarSet {
		result := function.ScalarSet{}
		for i := range list.Series {
			values := list.Series[i].Values
			result = append(result, function.TaggedScalar{
				TagSet: list.Series[i].TagSet,
				Value:  values[len(values)-1],
			})
		}
		return result
	},
)

Current computes the last tagged scalar for each time series.

var FirstNotNaN = recent(
	"summarize.first_not_nan",
	func(slice []float64) float64 {
		for i := range slice {
			if !math.IsNaN(slice[i]) {
				return slice[i]
			}
		}
		return math.NaN()
	},
)

FirstNotNaN computes the first not NaN tagged scalar for each time series.

var Integral = recentScaled(
	"summarize.integral",
	func(slice []float64, timerange api.Timerange) float64 {
		sum := 0.0
		for i := range slice {
			if math.IsNaN(slice[i]) {
				continue
			}
			sum += slice[i]
		}
		return sum * timerange.Resolution().Seconds()
	},
)

Integral computes the (scaled) integral of the time series line.

var LastNotNaN = recent(
	"summarize.last_not_nan",
	func(slice []float64) float64 {
		for i := range slice {
			if !math.IsNaN(slice[len(slice)-1-i]) {
				return slice[len(slice)-1-i]
			}
		}
		return math.NaN()
	},
)

LastNotNaN computes the last not NaN tagged scalar for each time series.

var Max = recent(
	"summarize.max",
	func(slice []float64) float64 {
		max := math.NaN()
		for i := range slice {
			if math.IsNaN(max) {
				max = slice[i]
			}
			if math.IsNaN(slice[i]) {
				continue
			}
			max = math.Max(max, slice[i])
		}
		return max
	},
)

Max computes a maximum tagged scalar for each time series line.

var Mean = recent(
	"summarize.mean",
	func(slice []float64) float64 {
		sum := 0.0
		count := 0
		for i := range slice {
			if math.IsNaN(slice[i]) {
				continue
			}
			sum += slice[i]
			count++
		}
		return sum / float64(count)
	},
)

Mean computes an average tagged scalar for each time series line.

var Min = recent(
	"summarize.min",
	func(slice []float64) float64 {
		min := math.NaN()
		for i := range slice {
			if math.IsNaN(min) {
				min = slice[i]
			}
			if math.IsNaN(slice[i]) {
				continue
			}
			min = math.Min(min, slice[i])
		}
		return min
	},
)

Min computes a minimum tagged scalar for each time series line.

var Oldest = function.MakeFunction(
	"summarize.oldest",
	func(list api.SeriesList) function.ScalarSet {
		result := function.ScalarSet{}
		for i := range list.Series {
			values := list.Series[i].Values
			result = append(result, function.TaggedScalar{
				TagSet: list.Series[i].TagSet,
				Value:  values[0],
			})
		}
		return result
	},
)

Oldest computes the first tagged scalar for each time series.

var Total = recent(
	"summarize.total",
	func(slice []float64) float64 {
		return float64(len(slice))
	},
)

Total computes the total number of points in the line