Get Metrics Data Points

Gets metrics data.

Notes

  • As a pre-requiste user should be aware of the PromQL
  • Default time interval is 2 hrs
  • Default step size is 60 sec.
  • Max 11000 metric data points on given step size
  • User needs to adjust the step size accoringly to the time interval queried
  • Upto 1 week → step size = 60
  • Greater than 1 week and less than 1 month → step size = 250 sec
  • Greater than 1 month and less than 3 months → step size = 730 sec
  • Greater than 3 months and less than 6 months → step size = 1450 sec
  • Greater than 6 months and less than 1 year → step size = 2875 sec

Max data size supported

  • 16MB per endpoint call

Max PromQL Length

  • 8K Characters

Reference for query language

Example endpoint

  • `https://<server.com>/metricsql/api/v3/tenants//metrics?query=synthetic_response_time{instance=~"MonitoringChannel|Test old binary"}&start=1635470492&end=1635488492'
get
/metricsql/api/v3/tenants/{tenantId}/metrics

Get metrics data points with timestamps

Path Parameters

  • tenantIdstringrequired

    Describes clientId of the tenant

Query Parameters

  • querystringrequired

    PromQl supported query format. Refer: https://prometheus.io/docs/prometheus/latest/querying/basics/

  • startstring

    startTime - Timestamp in seconds

  • endstring

    EndTime

  • stepnumber

    step size

    Default: 60

00