Skip to content

Commit 7da6118

Browse files
lucastemblucastemb
committed
docs: made some minor formatting fixes
Signed-off-by: Lucas Tembras <[email protected]>
1 parent ec88270 commit 7da6118

File tree

1 file changed

+65
-39
lines changed

1 file changed

+65
-39
lines changed

‎pipeline/outputs/datadog.md‎

Lines changed: 65 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -4,53 +4,79 @@ description: Send logs to Datadog
44

55
# Datadog
66

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

99
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).
1010

11-
## Configuration Parameters
12-
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. | |
28-
| 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_ |
29-
| site | _Optional_ - The Datadog site to send logs to. Use `datadoghq.com` for US or `datadoghq.eu` for EU. If not specified, defaults to `datadoghq.com`. | `datadoghq.com` |
30-
| workers | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
31-
| header | Add additional arbitrary HTTP header key/value pair. Multiple headers can be set. | _none_ |
32-
33-
### Configuration File
34-
35-
Get started quickly with this configuration file:
11+
## Configuration parameters
3612

13+
This plugin uses the following configuration parameters:
14+
15+
| Key | Description | Default |
16+
| --- | ----------- | ------- |
17+
| `Host` | The Datadog server where you are sending your logs. | `http-intake.logs.datadoghq.com` |
18+
| `TLS` | End-to-end security communications security protocol. Datadog recommends setting this to `on`. | `off` |
19+
| `compress` | Optional. Compresses the payload in GZIP format. Datadog supports and recommends setting this to `gzip`. | _none_ |
20+
| `apikey` | Your [Datadog API key](https://app.datadoghq.com/account/settings#api). | _none_ |
21+
| `Proxy` | Optional. Specifies an HTTP proxy. The expected format of this value is `http://host:port`. HTTPS isn't supported. | _none_ |
22+
| `provider` | To activate remapping, specify the configuration flag provider with the value `ecs`. | _none_ |
23+
| `json_date_key` | Date key name for output. | `timestamp` |
24+
| `include_tag_key` | If enabled, a tag is appended to the output. The key name is used `tag_key` property. | `false` |
25+
| `tag_key` | The key name of tag. If `include_tag_key` is `false`, this property is ignored. | `tagkey` |
26+
| `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_ |
27+
| `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_ |
28+
| `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). | _none_ |
29+
| `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_ |
30+
| `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_ |
31+
| `site` | Optional. The Datadog site to send logs to. Use `datadoghq.com` for US or `datadoghq.eu` for EU. If not specified, defaults to `datadoghq.com`. | `datadoghq.com` |
32+
| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
33+
| `header` | Add additional arbitrary HTTP header key/value pair. Multiple headers can be set. | _none_ |
34+
35+
### Configuration file
36+
37+
Get started with this configuration file:
38+
39+
{% tabs %}
40+
{% tab title="fluent-bit.yaml" %}
41+
42+
```yaml
43+
pipeline:
44+
45+
outputs:
46+
- name: datadog
47+
match: '*'
48+
host: http-intake.logs.datadoghq.com
49+
tls: on
50+
compress: gzip
51+
apikey: <my-datadog-api-key>
52+
site: datadoghq.com
53+
dd_service: <my-app-service>
54+
dd_source: <my-app-source>
55+
dd_tags: team:logs,foo:bar
56+
dd_hostname: myhost
3757
```
58+
59+
{% endtab %}
60+
{% tab title="fluent-bit.conf" %}
61+
62+
```text
3863
[OUTPUT]
39-
Name datadog
40-
Match *
41-
Host http-intake.logs.datadoghq.com
42-
TLS on
43-
compress gzip
44-
apikey <my-datadog-api-key>
45-
site datadoghq.com
46-
dd_service <my-app-service>
47-
dd_source <my-app-source>
48-
dd_tags team:logs,foo:bar
49-
dd_hostname myhost
64+
Name datadog
65+
Match *
66+
Host http-intake.logs.datadoghq.com
67+
TLS on
68+
compress gzip
69+
apikey <my-datadog-api-key>
70+
site datadoghq.com
71+
dd_service <my-app-service>
72+
dd_source <my-app-source>
73+
dd_tags team:logs,foo:bar
74+
dd_hostname myhost
5075
```
5176

52-
## Troubleshooting
77+
{% endtab %}
78+
{% endtabs %}
5379

54-
### 403 Forbidden
80+
## Troubleshooting
5581

5682
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).

0 commit comments

Comments
 (0)