Metrics¶
Provider¶
A provider in Iter8 is a data source that supplies metric values.
Fully qualified names¶
Metrics are scoped by providers. Providers have unique names, and within the scope of a provider, metrics have unique names. In addition, multiple endpoints and metric aggregation will determine the metric name. The fully qualified metric name will be in the form provider[-endpoint]/metric[/aggregation].
Following are some examples of fully qualified metric names: 1. http/latency-mean 2. grpc/latency/mean 3. http-httpbin/latency-mean 4. grpc-getFeature/latency/mean 5. abn/sample_metric/count
Built-in metrics provider¶
Iter8 has built-in metrics providers, namely, http and grpc.
Custom metrics provider¶
You can use metrics from any (RESTful) database in Iter8 experiments. Metrics fetched by Iter8 from databases are also referred to as custom metrics. See here to learn more about custom metrics.
Metric types¶
Iter8 defines counter and gauge metric types which are analogous to the corresponding metric types defined by Prometheus. We quote from the Prometheus documentation below for their definitions.
Counter
A counter is a cumulative metric that represents a single monotonically increasing counter whose value can only increase or be reset to zero on restart.
For example, you can use a counter to represent the number of requests served, tasks completed, or errors. Do not use a counter to expose a value that can decrease. For example, do not use a counter for the number of currently running processes; instead use a gauge.
Gauge
A gauge is a metric that represents a single numerical value that can arbitrarily go up and down.
Gauges are typically used for measured values like temperatures or current memory usage, but also "counts" that can go up and down, like the number of concurrent requests.
Multiple endpoints¶
Some built-in metrics providers, such as http and grpc, allow you to specify and test multiple endpoints. In these cases, the endpoint name will be appended to the provider name in the metric name. See the documentation for examples.