Telemetry - script API
Functions for accessing telemetry.
This page describes StackState version 4.2.
The StackState 4.2 version range is End of Life (EOL) and no longer supported. We encourage customers still running the 4.2 version range to upgrade to a more recent release.
Function query
query
A telemetry query is a conjunction of equality conditions. E.g. name = 'system.load.norm.15' and host='localhost'
. There are several builder methods available that help to refine query time range, limit the number of points returned, or set a metric field.
Args:
dataSourceName
- name of the data source.query
- set of equality conditions.
Returns:
AsyncScriptResult[TelemetryScriptApiQueryResponse]
Builder methods:
aggregation(method: String, bucketSize: String)
- returns aggregated telemetry usingmethod
andbucketSize
.limit(points: Int)
- limits the number of points returned, applicable to none aggregated queries.metricField(fieldName: String)
- sets a field that holds metric value.compileQuery()
- returns the telemetry query that was created with this function and the builder methods. After this builder method no more builder methods can be called.
Examples:
Get raw metric by query
Get metric aggregated using Mean during with bucket size 1 minute:
Query metrics starting 3 hours ago till now:
Query metrics starting beginning of the data till last hour ago:
Query metrics within time range starting 3 hours ago up to 1 hour ago:
Query metrics from field "value" and limits points returned:
Last updated