Skip to main content

Monitor performance metrics

The Metrics export API lets you monitor the performance of your Polaris organization in the monitoring tool of your choice. You can configure your existing monitoring solution to call the Metrics export API and import your Polaris metrics data points.

The Metrics export API reports metrics in the OpenMetrics standard.

Use the Metrics export API​

To call the Metrics export API, you need a Polaris API key with the AccessMetrics permission. See Authenticate with API keys to obtain an API key and assign service account permissions. For more information on permissions, visit Permissions reference.

The minimum granularity on metrics is one minute.

Rate limit​

The Metrics export API has a rate limit of 200 requests per hour per organization. Since metrics are available at minute granularity, you should not need to issue more than 60 requests per hour to capture performance data. Thus, the rate limit allows for testing and retries.

If you exceed the rate limit, the Metrics export API returns an HTTP 429 Too Many Requests status code.

Integrate with monitoring solutions​

You can configure your existing monitoring solution to scrape the /v1/metrics/export endpoint and import Polaris metric data points. The endpoint returns the most recent data point for each metric in the OpenMetrics standard.

info

You may accrue charges from your third-party monitoring solution based upon their billing model.

To assess the size of the payload and approximate number of metrics, call the Metrics export API (such as with curl):

curl "https://ORGANIZATION_NAME.api.imply.io/v1/metrics/export" \
-w '%{size_download}' \
--header "Authorization: Basic $POLARIS_API_KEY" \
--compressed

The following topics contain more information on scraping the Metrics export API endpoint for various monitoring tools:

To integrate with other monitoring tools, search the tool's documentation for instructions on how to extract metrics from OpenMetrics compliant endpoints. Use the following configurations:

  • The URL exposing metrics in the OpenMetrics format: https://ORGANIZATION_NAME.api.imply.io/v1/metrics/export. Replace ORGANIZATION_NAME with the name of your organization.
  • Authentication: A Polaris API key with the AccessMetrics permission.
  • Scrape interval: 60 seconds.

Learn more​

See the following topics for more information: