extension-datadog

README

Steadybit extension-datadog

A Steadybit check implementation for data exposed through Datadog.

Learn about the capabilities of this extension in our Reliability Hub.

Configuration

Environment Variable	Helm value	Meaning	Required	Default
STEADYBIT_EXTENSION_API_KEY	datadog.apiKey	Datadog API Key	yes
STEADYBIT_EXTENSION_APPLICATION_KEY	datadog.applicationKey	Datadog Application Key	yes
STEADYBIT_EXTENSION_SITE_PARAMETER	datadog.siteParameter	Datadog Site Parameter	yes
STEADYBIT_EXTENSION_SITE_URL	datadog.siteUrl	Datadog Site Url	yes
HTTPS_PROXY	via extraEnv variables	Configure the proxy to be used for Datadog communication.	no
STEADYBIT_EXTENSION_DISCOVERY_ATTRIBUTES_EXCLUDES_MONITOR	discovery.attributes.excludes.monitor	List of Target Attributes which will be excluded during discovery. Checked by key equality and supporting trailing "*"	false

The extension supports all environment variables provided by steadybit/extension-kit.

When installed as linux package this configuration is in/etc/steadybit/extension-datadog.

Datadog Permissions

The extension requires the following application key scopes:

• monitors_downtime
• monitors_read

Installation

We recommend that you install the extension with our official Helm chart.

Helm

helm repo add steadybit-extension-datadog https://steadybit.github.io/extension-datadog
helm repo update

helm upgrade steadybit-extension-datadog \
  --install \
  --wait \
  --timeout 5m0s \
  --create-namespace \
  --namespace steadybit-extension \
  --set datadog.apiKey="{{API_KEY}}" \
  --set datadog.applicationKey="{{APPLICATION_KEY}}" \
  --set datadog.siteParameter="{{SITE_PARAMETER}}" \
  --set datadog.siteUrl="{{SITE_URL}}" \
  steadybit-extension-datadog/steadybit-extension-datadog`

Docker

You may alternatively start the Docker container manually.

docker run \
  --env STEADYBIT_LOG_LEVEL=info \
  --env STEADYBIT_EXTENSION_API_KEY="{{API_KEY}}" \
  --env STEADYBIT_EXTENSION_APPLICATION_KEY="{{APPLICATION_KEY}}" \
  --env STEADYBIT_EXTENSION_SITE_PARAMETER="{{SITE_PARAMETER}}" \
  --env STEADYBIT_EXTENSION_SITE_URL="{{SITE_URL}}" \
  --expose 8090 \
  ghcr.io/steadybit/extension-datadog:latest

Register the extension

Make sure to register the extension at the steadybit platform. Please refer to the documentation for more information.

Linux Package

Please use our agent-linux.sh script to install the extension on your Linux machine. The script will download the latest version of the extension and install it using the package manager.

After installing configure the extension by editing /etc/steadybit/extension-datadog and then restart the service.

Proxy

To communicate to Datadog via a proxy, we need the environment variable https_proxy to be set. This can be set via helm using the extraEnv variable

--set "extraEnv[0].name=HTTPS_PROXY" \
--set "extraEnv[0].value=https:\\user:pwd@CompanyProxy.com:8888"