Skip to content

Pipeline: output: datadog: style #1931

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 17, 2025
Merged

Pipeline: output: datadog: style #1931

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6c42bc2
Pipeline: output: datadog: style
esmerel Jul 16, 2025
9611102
Apply suggestions from code review
esmerel Jul 17, 2025
af91a15
Update pipeline/outputs/datadog.md
esmerel Jul 17, 2025
0ef692e
Merge branch 'master' into lynettemiles/sc-136235/update-fluent-bit-d…
esmerel Jul 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 26 additions & 26 deletions pipeline/outputs/datadog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,41 +4,43 @@ description: Send logs to Datadog

# Datadog

The Datadog output plugin allows to ingest your logs into [Datadog](https://app.datadoghq.com/signup).
The _Datadog_ output plugin lets you ingest your logs into [Datadog](https://app.datadoghq.com/signup).

Before you begin, you need a [Datadog account](https://app.datadoghq.com/signup), a [Datadog API key](https://docs.datadoghq.com/account_management/api-app-keys/), and you need to [activate Datadog Logs Management](https://app.datadoghq.com/logs/activation).

## Configuration Parameters

| Key | Description | Default |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
| Host | _Required_ - The Datadog server where you are sending your logs. | `http-intake.logs.datadoghq.com` |
| TLS | _Required_ - End-to-end security communications security protocol. Datadog recommends setting this to `on`. | `off` |
| compress | _Recommended_ - compresses the payload in GZIP format, Datadog supports and recommends setting this to `gzip`. | |
| apikey | _Required_ - Your [Datadog API key](https://app.datadoghq.com/account/settings#api). | |
| Proxy | _Optional_ - Specify an HTTP Proxy. The expected format of this value is [http://host:port](http://host/:port). Note that _https_ is **not** supported yet. | |
| provider | To activate the remapping, specify configuration flag provider with value `ecs`. | |
| json_date_key | Date key name for output. | `timestamp` |
| include_tag_key | If enabled, a tag is appended to output. The key name is used `tag_key` property. | `false` |
| tag_key | The key name of tag. If `include_tag_key` is false, This property is ignored. | `tagkey` |
| dd_service | _Recommended_ - The human readable name for your service generating the logs (e.g. the name of your application or database). If unset, Datadog will look for the service using [Service Remapper](https://docs.datadoghq.com/logs/log_configuration/pipelines/?tab=service#service-attribute)." | |
| dd_source | _Recommended_ - A human readable name for the underlying technology of your service (e.g. `postgres` or `nginx`). If unset, Datadog will look for the source in the [`ddsource` attribute](https://docs.datadoghq.com/logs/log_configuration/pipelines/?tab=source#source-attribute). | |
| dd_tags | _Optional_ - The [tags](https://docs.datadoghq.com/tagging/) you want to assign to your logs in Datadog. If unset, Datadog will look for the tags in the [`ddtags` attribute](https://docs.datadoghq.com/api/latest/logs/#send-logs). | |
| dd_message_key | By default, the plugin searches for the key 'log' and remap the value to the key 'message'. If the property is set, the plugin will search the property name key. | |
| dd_hostname | The host the emitted logs should be associated with. If unset, Datadog expects the host to be set with `host`, `hostname`, or `syslog.hostname` attributes. See [Datadog Logs preprocessor documentation](https://docs.datadoghq.com/logs/log_configuration/pipelines/?tab=host#preprocessing) for recognized attributes. | _none_ |
## Configuration parameters

This plugin uses the following configuration parameters:

| Key | Description | Default |
| --- | ----------- | ------- |
| `Host` | The Datadog server where you are sending your logs. | `http-intake.logs.datadoghq.com` |
| `TLS` | End-to-end security communications security protocol. Datadog recommends setting this to `on`. | `off` |
| `compress` | Optional. Compresses the payload in GZIP format, Datadog supports and recommends setting this to `gzip`. | _none_ |
| `apikey` | Your [Datadog API key](https://app.datadoghq.com/account/settings#api). | _none_ |
| `Proxy` | Optional. Specify an HTTP Proxy. The expected format of this value is `http://host:port`. HTTPS isn't supported. | _none_ |
| `provider` | To activate remapping, specify the configuration flag provider with the value `ecs`. | _none_ |
| `json_date_key` | Date key name for output. | `timestamp` |
| `include_tag_key` | If enabled, a tag is appended to output. The key name is used `tag_key` property. | `false` |
| `tag_key` | The key name of tag. If `include_tag_key` is false, This property is ignored. | `tagkey` |
| `dd_service` | Recommended. The human readable name for your service generating the logs. For example, the name of your application or database. If not set, Datadog looks for the service using [service remapper](https://docs.datadoghq.com/logs/log_configuration/pipelines/?tab=service#service-attribute). | _none_ |
| `dd_source` | Recommended. A human readable name for the underlying technology of your service like `postgres` or `nginx`. If unset, Datadog looks for the source in the [`ddsource` attribute](https://docs.datadoghq.com/logs/log_configuration/pipelines/?tab=source#source-attribute). | _none_ |
| `dd_tags` | Optional. The [tags](https://docs.datadoghq.com/tagging/) you want to assign to your logs in Datadog. If unset, Datadog will look for the tags in the [`ddtags` attribute](https://docs.datadoghq.com/api/latest/logs/#send-logs). | |
| `dd_message_key` | By default, the plugin searches for the key `log` and remaps the value to the key `message`. If the property is set, the plugin will search the property name key. | _none_ |
| `dd_hostname` | The host the emitted logs should be associated with. If unset, Datadog expects the host to be set with `host`, `hostname`, or `syslog.hostname` attributes. See [Datadog Logs preprocessor documentation](https://docs.datadoghq.com/logs/log_configuration/pipelines/?tab=host#preprocessing) for recognized attributes. | _none_ |
| workers | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
| header | Add additional arbitrary HTTP header key/value pair. Multiple headers can be set. | _none_ |

### Configuration File
### Configuration file

Get started quickly with this configuration file:
Get started with this configuration file:

{% tabs %}
{% tab title="fluent-bit.yaml" %}

```yaml
pipeline:

outputs:
- name: datadog
match: '*'
Expand All @@ -49,7 +51,7 @@ pipeline:
dd_service: <my-app-service>
dd_source: <my-app-source>
dd_tags: team:logs,foo:bar
dd_hostname: myhost
dd_hostname: myhost
```

{% endtab %}
Expand All @@ -74,6 +76,4 @@ pipeline:

## Troubleshooting

### 403 Forbidden

If you get a `403 Forbidden` error response, double check that you have a valid [Datadog API key](https://docs.datadoghq.com/account_management/api-app-keys/) and that you have [activated Datadog Logs Management](https://app.datadoghq.com/logs/activation).
If you get a `403 Forbidden` error response, double check that you have a valid [Datadog API key](https://docs.datadoghq.com/account_management/api-app-keys/) and that you have [activated Datadog Logs Management](https://app.datadoghq.com/logs/activation).
2 changes: 2 additions & 0 deletions vale-styles/FluentBit/Spelling-exceptions.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ Podman
Postgres
PowerShell
prepopulate
preprocessor
Profiler
Prometheus
PromQL
Expand All @@ -148,6 +149,7 @@ Queryable
Raspbian
rdkafka
Redpanda
remapper
rollup
Rollup
rollups
Expand Down