Skip to content

Commit 81a8675

Browse files
authored
out_datadog: Update the description of the field mapping options (fluent#1360)
Follow-up on the similar changes to the help docs in fluent-bit: fluent/fluent-bit#8751 Ref: fluent/fluent-bit#8751 Ref: fluent/fluent-bit#8687 Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>
1 parent bd9b3fe commit 81a8675

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

pipeline/outputs/datadog.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@ Before you begin, you need a [Datadog account](https://app.datadoghq.com/signup)
1010

1111
## Configuration Parameters
1212

13-
| Key | Description | Default |
14-
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
15-
| Host | _Required_ - The Datadog server where you are sending your logs. | `http-intake.logs.datadoghq.com` |
16-
| TLS | _Required_ - End-to-end security communications security protocol. Datadog recommends setting this to `on`. | `off` |
17-
| compress | _Recommended_ - compresses the payload in GZIP format, Datadog supports and recommends setting this to `gzip`. | |
18-
| apikey | _Required_ - Your [Datadog API key](https://app.datadoghq.com/account/settings#api). | |
19-
| 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. | |
20-
| provider | To activate the remapping, specify configuration flag provider with value `ecs`. | |
21-
| json_date_key | Date key name for output. | `timestamp` |
22-
| include_tag_key | If enabled, a tag is appended to output. The key name is used `tag_key` property. | `false` |
23-
| tag_key | The key name of tag. If `include_tag_key` is false, This property is ignored. | `tagkey` |
24-
| dd_service | _Recommended_ - The human readable name for your service generating the logs - the name of your application or database. | |
25-
| dd_source | _Recommended_ - A human readable name for the underlying technology of your service. For example, `postgres` or `nginx`. | |
26-
| dd_tags | _Optional_ - The [tags](https://docs.datadoghq.com/tagging/) you want to assign to your logs in Datadog. | |
27-
| 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. | |
13+
| Key | Description | Default |
14+
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
15+
| Host | _Required_ - The Datadog server where you are sending your logs. | `http-intake.logs.datadoghq.com` |
16+
| TLS | _Required_ - End-to-end security communications security protocol. Datadog recommends setting this to `on`. | `off` |
17+
| compress | _Recommended_ - compresses the payload in GZIP format, Datadog supports and recommends setting this to `gzip`. | |
18+
| apikey | _Required_ - Your [Datadog API key](https://app.datadoghq.com/account/settings#api). | |
19+
| 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. | |
20+
| provider | To activate the remapping, specify configuration flag provider with value `ecs`. | |
21+
| json_date_key | Date key name for output. | `timestamp` |
22+
| include_tag_key | If enabled, a tag is appended to output. The key name is used `tag_key` property. | `false` |
23+
| tag_key | The key name of tag. If `include_tag_key` is false, This property is ignored. | `tagkey` |
24+
| 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)." | |
25+
| 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). | |
26+
| 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). | |
27+
| 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. | |
2828

2929
### Configuration File
3030

0 commit comments

Comments
 (0)