Setup

Supported Metric Hosts

When you integrate an end-to-end monitoring setup, you need somewhere to store your metrics data. There are a few popular cloud-hosted and self-hosted options.

We support Datadog. Datadog is a hosted service that provides you with metric aggregation, logs, dashboards, and alert integrations.

We plan to soon have support for Prometheus. Prometheus is a time-series database that provides you with metric aggregation. It can be self-hosted (frequently in conjunction with Grafana for visualization), or hosted as a service which can come with logs, dashboards, and alerts, for a fully-featured setup.

Initial Setup

Initial setup is done once, to integrate Deviceplane with your metrics host.

In order to integrate with Datadog:

  1. Create or log into your Datadog account
  2. Create a Datadog API Key and add it on Deviceplane (Monitoring > Integrations)

Next, configure metrics to pick which metrics/tags are sent to your metrics host.

Metrics Configuration

The more metrics and tags you have, the higher the cardinality of your metric data. This increases the amount of data needed to store your metrics, and usually increases the amount you have to pay to have your metrics hosted. For that reason, we use a whitelist to determine which metrics and tags to expose.

To configure metrics, log in to Deviceplane and select Monitoring sidebar. Under there, you can whitelist and tag project, device, and service metrics.

Whitelisting Metrics

  • For project metrics, all available metrics are listed, simply select whether you want them enabled or not
  • For device metrics, click "add device metrics". Then select or type the names of the metrics you want
  • For service metrics, select the application/service in the dropdown, and click "add service metrics". Enter the names of the metrics you want to whitelist. You can use the "*" character to whitelist all metrics.

Tagging Metrics

  • You can optionally add the "device" and "application" tags to be forwarded. Note that the project name will always be a forwarded tag.
  • You can also enter a list of device labels that you wish to be forwarded on metric tags
    • For example, if you've tagged each device with a "customer" label, you could use this to view your metrics on a per-customer basis