Skip to content

Commit

Permalink
doc: add datadog connection json structure. (apache#40198)
Browse files Browse the repository at this point in the history
  • Loading branch information
gabeschenz authored Jun 17, 2024
1 parent 7ecbf39 commit 86190aa
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/apache-airflow-providers-datadog/connections/datadog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,25 @@ Extra
``app_key``: Datadog `application key <https://docs.datadoghq.com/account_management/api-app-keys/#application-keys>`__

``source_type_name``: Datadog `source type name <https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value/>`__ (defaults to my_apps).


Secret Management
-----------------

When storing the connection details in a secret management system, it can be convenient to name the secret with the default value::

secret name: airflow/connections/datadog_default

The following json is an example of what the secret contents should look like::

{
"conn_type": "datadog",
"description": "Datadog connection for my app",
"extra": {
"api_host": "https://api.datadoghq.com",
"api_key": "my api key",
"app_key": "my app key",
"source_type_name": "apache"
},
"host": "environment-region-application.domain.com"
}

0 comments on commit 86190aa

Please sign in to comment.