Skip to main content

Monitoring

Overview​

Dragonfly Cloud provides observability through the following monitoring features:

If you have not yet created a Dragonfly Cloud data store, please refer to the getting started guide.

Public Dashboard​

  • To open a data store's public dashboard, click the dashboard icon () in the relevant data store row.
  • A Grafana-based dashboard will open in a new tab.

Prometheus Compatible Metrics Endpoint​

Generating an API Key​

In order to access the metrics endpoint, you must first acquire an API key:

  • Navigate to the Account > API Keys tab in Dragonfly Cloud.
  • Click the +API Key button to open the Create Key dialog.
  • In the Create Key dialog, enter a meaningful name for the key (e.g., metrics).
  • Leave Read Metrics selected in the Permissions dropdown.
  • Click Create, and the dialog will show the created key.
  • Click Copy API Key to copy the key to the clipboard.
  • Store the key somewhere secure for later usage. Dragonfly Cloud doesn't store the key itself.

Accessing the Metrics Endpoint​

  • Once you have the API key, you can use it to access the metrics endpoint.
  • The metrics endpoint is available for scraping at https://api.dragonflydb.cloud/v1/metrics.
  • Configure your monitoring system with the metrics endpoint and your API key to start monitoring your data store.
  • The API key should be passed in the Authorization header as a bearer token like so:
# Replace with your API key.
$> KEY="dragonflydb_eyJpI...fQ=="

# Send a request to the metrics endpoint.
$> curl https://api.dragonflydb.cloud/v1/metrics -H "Authorization: Bearer $KEY"