Skip to content

Latest commit

 

History

History
100 lines (72 loc) · 5.37 KB

README.md

File metadata and controls

100 lines (72 loc) · 5.37 KB
Raw

Datadog logo depicting a dog with the text 'Datadog'

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

Kubernetes

Detailed information about agent and extension installation in kubernetes can also be found in our documentation.

Recommended (via agent helm chart)

All extensions provide a helm chart that is also integrated in the helm-chart of the agent.

You must provide additional values to activate this extension.

--set extension-datadog.enabled=true \
--set extension-datadog.datadog.apiKey="{{API_KEY}}" \
--set extension-datadog.datadog.applicationKey="{{APPLICATION_KEY}}" \
--set extension-datadog.datadog.siteParameter="{{SITE_PARAMETER}}" \
--set extension-datadog.datadog.siteUrl="{{SITE_URL}}" \

Additional configuration options can be found in the helm-chart of the extension.

Alternative (via own helm chart)

If you need more control, you can install the extension via its dedicated helm-chart.

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-agent \
  --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

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.

Extension registration

Make sure that the extension is registered with the agent. In most cases this is done automatically. Please refer to the documentation for more information about extension registration and how to verify.

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:[email protected]:8888"