APM metric object
The following objects are directly related to the apmmetric API.
Each property, except type, corresponds to a column in the metric tables (otel_metrics_gauge, otel_metrics_sum, otel_metrics_histogram, and otel_metrics_exponential_histogram) of the telemetry data source.
Most properties correspond to the column with the same name (e.g., metric_name property corresponds to the MetricName column).
Where the names differ, the data source columns are specified in the tables below.
For the list of columns, see Supported telemetry data columns.
APM metric
The APM metric object represents a data point of a metric (the value, or aggregated values, of a measurement at a specific time).
The APM metric object has the following properties:
| Property | Type | Description |
|---|---|---|
| type | integer | Type of the data point. Possible values: 0 - Gauge; 1 - Sum; 2 - Histogram; 3 - Exponential histogram. The type is determined by the table that holds the data point: otel_metrics_gauge, otel_metrics_sum, otel_metrics_histogram, or otel_metrics_exponential_histogram.Property behavior: - read-only |
| resource_attributes | object | Key-value resource attributes of the data point (e.g., host.name: eabf8c2a5ddc).Property behavior: - read-only |
| resource_schema_url | string | URL, if any, of the OpenTelemetry schema of the resource attributes. Property behavior: - read-only |
| scope_name | string | Name of the instrumentation scope that produced the data point. Property behavior: - read-only |
| scope_version | string | Version, if any, of the instrumentation scope. Property behavior: - read-only |
| scope_attributes | object | Key-value attributes of the instrumentation scope. Property behavior: - read-only |
| scope_schema_url | string | URL, if any, of the OpenTelemetry schema of the instrumentation scope and its attributes. Property behavior: - read-only |
| service_name | string | Name of the service that produced the data point (e.g., zabbix-frontend), taken from the OpenTelemetry service.name resource attribute.Property behavior: - read-only |
| metric_name | string | Name of the metric that the data point belongs to (e.g., http.server.request.duration).Property behavior: - read-only |
| metric_description | string | Description, if any, of the metric. Property behavior: - read-only |
| metric_unit | string | Unit, if any, of the metric values (e.g., s or By; see UCUM).Property behavior: - read-only |
| attributes | object | Key-value data point attributes (e.g., http.request.method: POST).Property behavior: - read-only |
| start_time_unix | integer | Unix time (in nanoseconds) when the measurement period of the data point started. Property behavior: - read-only |
| time_unix | integer | Unix time (in nanoseconds) of the data point. For Sum, Histogram, and Exponential histogram data points, this is the end of the measurement period. Property behavior: - read-only |
| value | float | Value of the data point. Applies to Gauge and Sum data points. Default: 0.Property behavior: - read-only |
| flags | integer | Bitmask of data point flags. If the least significant bit is set (value 1), no value was recorded for the data point.Property behavior: - read-only |
| exemplars | array | Array of exemplar objects, that is, individual measurements kept as examples, with the trace and span during which they were recorded. Property behavior: - read-only |
| aggregation_temporality | integer | How the values of the data point are aggregated over time. Applies to Sum, Histogram, and Exponential histogram data points. Possible values: 0 - (default) Unspecified; 1 - Delta (aggregated over the period since the previous data point); 2 - Cumulative (aggregated over the period since start_time_unix).Property behavior: - read-only |
| is_monotonic | boolean | Whether the sum can only increase or stay the same over time. Applies to Sum data points. Default: false.Property behavior: - read-only |
| count | integer | Number of measurements in the data point. Applies to Histogram and Exponential histogram data points. Default: 0.Property behavior: - read-only |
| sum | float | Sum of all measurements in the data point. Applies to Histogram and Exponential histogram data points. Default: 0.Property behavior: - read-only |
| bucket_counts | array | Array of integers with the number of measurements in each histogram bucket. The buckets are defined by explicit_bounds.Applies to Histogram data points. Default: [].Property behavior: - read-only |
| explicit_bounds | array | Array of floats with the boundaries between histogram buckets. Applies to Histogram data points. Default: [].Property behavior: - read-only |
| min | float | Smallest of the measurements in the data point. Applies to Histogram and Exponential histogram data points. Default: 0.Property behavior: - read-only |
| max | float | Largest of the measurements in the data point. Applies to Histogram and Exponential histogram data points. Default: 0.Property behavior: - read-only |
| scale | integer | Scale of the exponential histogram, which determines the bucket boundaries and resolution. A higher scale gives narrower buckets and finer resolution; a lower scale gives wider buckets and coarser resolution. Applies to Exponential histogram data points. Default: 0.Property behavior: - read-only |
| zero_count | integer | Number of measurements in the zero bucket of the exponential histogram. Applies to Exponential histogram data points. Default: 0.Property behavior: - read-only |
| positive_bucket_counts | array | Array of integers with the number of positive measurements in each exponential histogram bucket. The bucket boundaries are determined by scale; the index of the first bucket is set in positive_offset.Applies to Exponential histogram data points. Default: [].Property behavior: - read-only |
| positive_offset | integer | Index of the first bucket in positive_bucket_counts.Applies to Exponential histogram data points. Default: 0.Property behavior: - read-only |
| negative_bucket_counts | array | Array of integers with the number of negative measurements in each exponential histogram bucket. The bucket boundaries are determined by scale; the index of the first bucket is set in negative_offset.Applies to Exponential histogram data points. Default: [].Property behavior: - read-only |
| negative_offset | integer | Index of the first bucket in negative_bucket_counts.Applies to Exponential histogram data points. Default: 0.Property behavior: - read-only |
Exemplar
The exemplar object has the following properties:
| Property | Type | Description |
|---|---|---|
| traceid | string | ID, if any, of the trace during which the measurement was recorded. Data source column: Exemplars.TraceId. |
| spanid | string | ID, if any, of the span during which the measurement was recorded. Data source column: Exemplars.SpanId. |
| value | float | Value of the measurement. Data source column: Exemplars.Value. |
| time_unix | integer | Unix time (in nanoseconds) when the measurement was recorded. Data source column: Exemplars.TimeUnix. |
| filtered_attributes | object | Key-value attributes of the measurement that are not included in the attributes of the data point.Data source column: Exemplars.FilteredAttributes. |