メインコンテンツへスキップ

Datadog Alerts Integration — Self-hosted 2.0

Datadog Alerts Integration enables you to receive PerfectScale Alerts directly into your Datadog dashboard, ensuring you stay informed about any resilience risks identified in your Kubernetes environment, and helping you prioritize tasks to eliminate the issues before they impact performance and user experience.

Datadog Alerts Integration could be enabled in a few simple steps:

  1. Create an API Key in Datadog.
  2. Configure Datadog Alerts Profile.
  3. Apply the profile to the desired cluster(s).

:tools: How to create API Kye in Datadog

  1. Log in to your Datadog profile.

  2. Hover over your account icon and click API Keys

    PerfectScale documentation illustration

    Datadog API key

  3. Click New Key button, name your key, and click Create Key.

    PerfectScale documentation illustration

    New key1

  4. Copy the API Key. You will need it for the Datadog Alerts Profile configuration.

    PerfectScale documentation illustration

    New key2

Configuring Datado integration with the profile

:tools: How to create Datadog Alerts Profile

There are two options for creating a Profile: from the Settings tab or directly from the Overview.

From the Settings tab

Go to the Settings tab on the left panel -> select Integrations -> click the +Add Integration button and select Datadog from the drop-down -> insert the required data.

PerfectScale documentation illustration

Datadog alerts profile from settings

From the Overview tab

Go to the Overview tab on the left panel -> find the cluster to which you want to apply the Profile and click gear button -> go to Customizations -> find Integrations and click the Monitoring drop-down list -> click the Add New Profile button -> insert the required data.

PerfectScale documentation illustration

Datadog alerts profile from overview

Datadog alerts Profile Configuration

PerfectScale documentation illustration

Datadog alerts profile configuration

  1. Name the Profile
  2. datadog_api_key - Datadog API Key. See the details here.

    datadog_site_region - specifies the Datadog regional domain where your data is sent and managed (example: datadoghq.com).

The available datadog_site_region:

CodeDomain
US1datadoghq.com
US3us3.datadoghq.com
US5datadoghq.com
EUdatadoghq.eu
AP1ap1.datadoghq.com
US1-FEDddog-gov.com
  1. Use Set as default checkbox to automatically assign the profile to the clusters.

    💡 NOTE: The manually assigned profile takes priority over the default one.

:tools: How to apply Datadog Alerts Profile

Apply to a single cluster

To apply Datadog Alerts Profile to the cluster, go to the Overview tab on the left panel -> find the cluster to which you want to apply the Datadog Alerts Profile and click gear button -> go to Customizations -> select the needed profile in the Monitoring drop-down list.

PerfectScale documentation illustration

Applying Datadog alerts profile to a single cluster

Apply to multiple clusters

To apply the profile to multiple clusters from a single view, use the Manage Assignments feature.

Go to the Settings tab on the left panel -> select the Integrations -> click the Manage Assignments button -> go to Monitoring section and apply the profiles for the needed clusters -> click the Save Changes button.

PerfectScale documentation illustration

Applying Datadog alerts profile to multiple clusters

How to uninstall Datadog Alerts Integration

In order to stop submitting Alerts to Datadog, the profile should be unassigned from the cluster.

Go to the Settings tab on the left panel -> select the Integrations -> click the Manage Assignments button -> go to Monitoring section and select None for the needed clusters -> click the Save Changes button.

PerfectScale documentation illustration

Uninstall Datadog alerts integration

Configuring Datadog integration with CRD

To enable Datadog alerts using a Custom Resource Definition (CRD), you’ll need to define and apply a Custom Resource (CR) with the required parameters. This approach allows you to manage Datadog alerting directly through Kubernetes manifests.

注意

The Custom Resource (CR) must be created in the perfectscale namespace.

Setup instructions

  1. Log in to your Datadog account.
  2. Navigate to Organization Settings > API Keys.
  3. Create or copy an API key.
  4. Copy the API key (you will need it for the Datadog API Key secret in the next steps).

Apply the Datadog API Key secret first:

apiVersion: v1
kind: Secret
metadata:
name: datadog-credentials
namespace: perfectscale
type: Opaque
stringData:
api-key: "your-datadog-api-key-here"
情報

Ensure that the secret is created in the same namespace as the exporter - perfectscale.

Configure the CR:

apiVersion: perfectscale.io/v1
kind: ClusterSettings
metadata:
name: cluster-settings-main
namespace: perfectscale
spec:
profiles:
integrations:
- type: datadog
name: production-monitoring
assigned: true
value:
datadog_api_key_from:
secretKeyRef:
name: datadog-credentials
key: api-key
datadog_site_region: "datadoghq.com"

⚙️ CR parameters:

ParameterDescription
datadog_api_key_fromA secret that contains a Datadog API Key. Learn more how to create it here.
datadog_site_regionSpecifies the Datadog regional domain where your data is sent and managed.
情報

Available datadog_site_region values:

  • US1: datadoghq.com
  • US3: us3.datadoghq.com
  • US5: us5.datadoghq.com
  • EU: datadoghq.eu
  • AP1: ap1.datadoghq.com
  • US1-FED: ddog-gov.com