Metric Event

Description

A metric event represents a numeric value. The types are heavily inspired by the Statsd and Prometheus models.

Schema

  • counter
  • gauge
  • histogram
  • set
{
"name": "login.count",
"host": "my.host.com",
"timestamp": "2019-11-01T21:15:47+00:00",
"val": 10.2
}
4 items
structoptional

counter

A single value that can only be incremented, it cannot be incremented.

stringrequired

name

The metric name.

No default
View examples
maprequired

tags

The metric name.

No default
View examples
timestamprequired

timestamp

Time metric was created/ingested.

No default
View examples
doublerequired

val

Amount to increment.

No default
View examples
structoptional

gauge

A gauge represents a point-in-time value that can increase and decrease. Vector's internal gauge type represents changes to that value. Gauges should be used to track fluctuations in values, like current memory or CPU usage.

stringenumrequired

direction

The direction to increase or decrease the gauge value.

No default
Enum, must be one of: "plus" "minus"
View examples
stringrequired

name

The metric name.

No default
View examples
maprequired

tags

The metric name.

No default
View examples
timestamprequired

timestamp

Time metric was created/ingested.

No default
View examples
doublerequired

val

Specific value.

No default
View examples
structoptional

histogram

Also called a "timer". Ahistogram represents the frequency distribution of a value. This is commonly used for timings, helping to understand quantiles, max, min, and other aggregations.

stringrequired

name

The metric name.

No default
View examples
doubleoptional

sample_rate

The bucket/distribution the metric is a part of.

No default
View examples
maprequired

tags

The metric name.

No default
View examples
timestamprequired

timestamp

Time metric was created/ingested.

No default
View examples
doublerequired

val

Specific value.

No default
View examples
structoptional

set

A set represents a count of unique values, AKA the cardinality.

stringrequired

name

The metric name.

No default
View examples
maprequired

tags

The metric name.

No default
View examples
timestamprequired

timestamp

Time metric was created/ingested.

No default
View examples
doublerequired

val

Specific value.

No default
View examples

Components

View all metric compatible components