1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
unleash.unleash/website/docs/reference/integrations/datadog.md
David Leek 0938b2e545
docs: improve datadog integration docs (#4802)
## About the changes

Improvement to the description of the datadog integration. Adds 2
missing event types, removes an event type that is deprecated and about
to be completely removed, adds missing description of extra json headers
and source type name, and adds description for the new configuration
option for JSON body support

---------

Co-authored-by: Nuno Góis <github@nunogois.com>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-09-26 11:15:22 +01:00

3.3 KiB

id title
datadog Datadog

This feature was introduced in Unleash v4.0.0.

The Datadog integration allows Unleash to post Updates to Datadog when a feature toggle is updated. To set up this integration, you need to set up a webhook connector for your channel. You can follow Submitting events to Datadog on how to do that.

The Datadog integration will perform a single retry if the HTTP POST against the Datadog Webhook URL fails (either a 50x or network error). Duplicate events may happen, and you should never assume events always comes in order.

Configuration

Events

You can choose to trigger updates for the following events:

  • feature-created
  • feature-updated (*)
  • feature-metadata-updated
  • feature-project-change
  • feature-archived
  • feature-revived
  • feature-strategy-update
  • feature-strategy-add
  • feature-strategy-remove
  • feature-stale-on
  • feature-stale-off
  • feature-environment-enabled
  • feature-environment-disabled
  • feature-environment-variants-updated
  • feature-potentially-stale-on

*) Deprecated, and will not be used after transition to environments in Unleash v4.3

Parameters

Unleash Datadog integration takes the following parameters.

Example:

{
  "SOME_CUSTOM_HTTP_HEADER": "SOME_VALUE",
  "SOME_OTHER_CUSTOM_HTTP_HEADER": "SOME_OTHER_VALUE"
}

:::info Body template availability

The body template property will be introduced as a beta feature in Unleash 5.5 and is expected to be made generally available in Unleash 5.6.

:::

  • Body template - This is an optional property. The template is used to override the body template used by Unleash when performing the HTTP POST. You can format your message using a Mustache template. Refer to the Unleash event types reference to find out which event properties you have access to in the template.

Example:

{
  "event": "{{event.type}}",
  "createdBy": "{{event.createdBy}}",
  "featureToggle": "{{event.data.name}}",
  "timestamp": "{{event.data.createdAt}}"
}

If you don't specify anything Unleash will send a formatted markdown body.

Example:

username created feature toggle (featurename)[http://your.url/projects/projectname/features/featurename] in project *projectname*

Tags

Datadog's incoming webhooks are app specific. You will be able to create multiple integrations to support messaging on different apps.