This page explains how to view SpatialOS metrics within your own in-house or third-party analytics platform, using the monitoring proxy that lets you access your deployment's metrics.
You can also use the monitoring proxy to access metrics through code.
In your analytics platform, you'll need to:
- Add Prometheus and Elasticsearch as data sources.
- Add the monitoring proxy URL.
- Enter the HTTP basic authentication username and password described below.
Sending the password
Storing the password
Using the password
Make sure you use HTTPS when making requests against the monitoring proxy.
The monitoring proxy uses HTTP basic authentication. You will need to supply
longshot_user as the username, and a valid refresh token as the password.
For access from a dashboard or other automated service, we strongly recommend you use the refresh token of a service account. To set up a service account, please reach out to Improbable customer support via the helpdesk (for customers with a service agreement) or the forums.
This service is in alpha, so is subject to change. In particular, all URLs (especially
https://monitoring.service.improbable.io/@proxyhost/) and metric names are
likely to change in the future.
- Log in to your Grafana server as an admin.
- Under Data Sources, add a new Prometheus Data Source:
|Data source fields||Details|
|Data source name||SpatialOS|
|Data source type||Prometheus|
|URL||<copy this link>|
|HTTP auth||Basic auth|
|Basic auth details||The username and password received from Improbable customer support|
Only create alerts using documented metrics.
Be careful with the queries you write: if they're very expensive, you may experience problems with the metrics servers. If you're not sure, ask customer support to review the queries.
Don't set a refresh rate more frequent than 60 seconds: if the refresh rate is too frequent, requests from your dashboard may fail due to the restrictions on metric querying.
- Queries must specify the project being queried. For example:
- Each project has a limit of 200 queries per minute.
For example, if one user issues 200 of the above queries, no users will be able to query metrics for that project for up to a minute.
- Each project has a limit of 60s of query processing time, reset every minute.
- Queries will time out after 30s of processing.
2019-09-23 Page updated with editorial review: Removed Set up SpatialOS logs in your own Grafana instance
Updated about a year ago