Integrating Datadog

Connecting Datadog to your Altinity.Cloud environment

Datadog is a popular observability platform for monitoring applications and infrastructure. Datadog’s access to Altinity.Cloud is controlled at two levels:

  • The Environment level - To use Datadog, you must enable it for your environment.
  • The Cluster level - Once Datadog is enabled at the environment level, you can enable Datadog monitoring for individual clusters.

Enabling Datadog at the environment level

To enable Datadog at the environment level, click the Environments tab on the left. You’ll see the list of environments in your account.

Environment list

Figure 1 - Environment list

Click the radio button next to the environment you want to enable, then click the vertical dots icon next to it. Select Edit from the menu.

The Edit Environment menu

Figure 2 - The Edit Environment menu

In the Environment Details panel, click the Logs tab. Click the Turn On Datadog slider to turn Datadog on or off. When Datadog is turned on, you need to enter the API key from your Datadog account. (The Datadog API and Application Keys page has complete details on how to create and manage API keys.) Click the down arrow to select your nearest Datadog region.

Turning on Datadog

Figure 3 - Turning on Datadog

Once Datadog is turned on, the three options below the region allow you to send logs, metrics on the ClickHouse cluster, and/or table-level metrics in your ClickHouse cluster.

See Datadog's ClickHouse integration documentation for the details on configuring Datadog and the ClickHouse metrics that Datadog can monitor.

Finally, click OK to save your changes.

Enabling Datadog at the cluster level

If you’re creating a new ClickHouse cluster and your environment is enabled for Datadog, the Datadog integration options are enabled on the Connection Configuration tab of the Launch Cluster Wizard. Simply click the checkboxes to send logs and/or metrics to Datadog. (If the environment isn’t enabled for Datadog, the Datadog section of the Connection Configuration tab is disabled.)

If your ClickHouse cluster has already been created, you can use the Cluster Settings dialog to enable Datadog. From the Clusters tab of the ACM, click the Configure button, then choose Connections from the menu:

Editing a cluster's connections

Figure 4 - Editing a cluster’s connections

In the Connection Configuration dialog, select the checkboxes in the Datadog integration section:

Enabling Datadog at the cluster level

Figure 5 - Enabling Datadog at the cluster level

The three options here allow you to send logs, metrics on the ClickHouse cluster, and/or table-level metrics in your ClickHouse cluster.

Click CONFIRM to save your changes.