Telemetry - script API
StackState Self-hosted v5.0.x
This page describes StackState version 5.0.
A telemetry query is a conjunction of equality conditions. For example,
name = 'system.load.norm.15' and host='localhost'
. There are several builder methods available that help to refine the query time range, limit the number of points returned, or set a metric field.Telemetry queries only support metric queries. If you need event queries, please enter a feature request at support.stackstate.com
dataSourceName
- name of the data source.query
- set of equality conditions.
The output format of the Telemetry API changed in StackState v5.0. If you are running an earlier version of StackState, see the documentation for StackState v4.6 documentation (docs.stackstate.com/v/4.6).
StreamingScriptResult[MetricTimeSeriesResult]
.groupBy(fieldName: String)
- optional. Used to return grouped results from Elasticsearch. Requires.aggregation()
to be used. If there is no aggregation, a plain metric stream will be returned.aggregation(method: String, bucketSize: String)
- returns aggregated telemetry usingmethod
andbucketSize
. See the available aggregation methods.window(start: Instant, end: Instant)
- sets query time range. Use onlystart
to get all telemetry up to now or onlyend
to get all telemetry up to an instant in time.limit(points: Int)
- limits the number of points returned, applicable to non-aggregated queries.metricField(fieldName: String)
- optional, but may be required for some data sources. 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.
Query
Example JSON output
Telemetry
.query("StackState Multi Metrics", "")
.groupBy("host")
.metricField("jvm_threads_current")
.start("-15m")
.aggregation("mean", "15m")
[{
"_type": "MetricTimeSeriesResult",
"query": {
"_type": "TelemetryMetricQuery",
"aggregation": {
"bucketSize": 900000,
"method": "MEAN"
},
"conditions": [
{
"key": "name",
"value": "jvm_threads_current"
}
],
"dataSourceId": 277422153298283,
"endTime": 1643294849765,
"groupBy": {
"fields": ["host"]
},
"includeAnnotations": false,
"metricField": "stackstate.jvm_threads_current",
"startTime": 1643293949765
},
"timeSeries": {
"_type": "TimeSeries",
"annotations": [],
"id": {
"_type": "TimeSeriesId",
"groups": {
"host": "sts-kafka-to-es-multi-metrics_generic-events_topology-events_state-events_sts-events"
}
},
"points": [[1643293800000, 49.46666666666667]],
"tags": []
}
},
{
"_type": "MetricTimeSeriesResult",
"query": {
"_type": "TelemetryMetricQuery",
"aggregation": {
"bucketSize": 900000,
"method": "MEAN"
},
"conditions": [
{
"key": "name",
"value": "jvm_threads_current"
}
],
"dataSourceId": 277422153298283,
"endTime": 1643294849765,
"groupBy": {
"fields": ["host"]
},
"includeAnnotations": false,
"metricField": "stackstate.jvm_threads_current",
"startTime": 1643293949765
},
"timeSeries": {
"_type": "TimeSeries",
"annotations": [],
"id": {
"_type": "TimeSeriesId",
"groups": {
"host": "sts-kafka-to-es-trace-events"
}
},
"points": [[1636293800000, 54.7]],
"tags": []
}
}]
Query
Example JSON output
Telemetry
.query("StackState Multi Metrics", "")
.groupBy("host")
.metricField("jvm_threads_current")
.start("-15m")
.aggregation("mean", "15m")
.then { it.timeSeries.id }
[
{
"_type": "TimeSeriesId",
"groups": {
"host": "sts-kafka-to-es-multi-metrics_generic-events_topology-events_state-events_sts-events"
}
},
{
"_type": "TimeSeriesId",
"groups": {
"host": "sts-kafka-to-es-trace-events"
}
}
}
]
Telemetry
.query("StackState Metrics", "name='system.load.norm' and host='host1'")
.metricField("value")
Telemetry
.query("StackState Metrics", "name='system.load.norm' and host='host1'")
.metricField("value")
.aggregation("99th percentile", "1m") // get 99th percentile of each minute
Telemetry
.query("StackState Metrics", "name='system.load.norm' and host='host1'")
.metricField("value")
.start("-3h") // starting from 3 hours ago
Telemetry
.query("StackState Metrics", "name='system.load.norm' and host='host1'")
.metricField("value")
.end("-1h") // ending 1 hour ago
Telemetry
.query("StackState Metrics", "name='system.load.norm' and host='host1'")
.metricField("value")
.window("-3h", "-1h") // from 3 hours ago to 1 hour ago
Telemetry
.query("StackState Metrics", "name='system.load.norm' and host='host1'")
.metricField("value")
.limit(100)
Last modified 7mo ago