You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add valid tokens for HTTP Server and Splunk HEC sources (#38358)
* add info
* small edit
* update field and value
* fix typo
* Apply suggestions from code review
Co-authored-by: Josué AGBEKODO <josue.agbekodo@datadoghq.com>
Co-authored-by: May Lee <may.lee@datadoghq.com>
---------
Co-authored-by: Josué AGBEKODO <josue.agbekodo@datadoghq.com>
Copy file name to clipboardExpand all lines: content/en/observability_pipelines/sources/http_server.md
+20-1Lines changed: 20 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,14 +33,33 @@ After you select the HTTP/S Server source in the pipeline UI:
33
33
-**Note**: Only enter the identifier for the address. Do **not** enter the actual address.
34
34
1. Select your authorization strategy. If you selected {{< ui >}}Plain{{< /ui >}}:
35
35
- Enter the identifiers for your HTTP/S Server username and password. If you leave it blank, the [default](#secret-defaults) is used.
36
+
1. (Optional) Set up authentication tokens. See [Configure authentication tokens](#configure-authentication-tokens) for details.
36
37
1. Select the decoder you want to use on the HTTP messages. Your HTTP client logs must be in this format. **Note**: If you select `bytes` decoding, the raw log is stored in the `message` field.
37
38
38
-
### Optional TLS settings
39
+
### Optional settings
40
+
41
+
#### Enable TLS
39
42
40
43
{{% observability_pipelines/tls_settings %}}
41
44
42
45
{{% observability_pipelines/tls_settings_mtls %}}
43
46
47
+
#### Configure authentication tokens
48
+
49
+
If you store tokens as credentials in your HTTP request's authorization header, you can configure the Worker to check if incoming HTTP requests have a valid token. Request events that do not have a valid token are dropped. The Worker can also look up an endpoint path or an IP address instead of a header.
50
+
51
+
**Note**: You cannot configure authentication tokens with the {{< ui >}}Plain{{< /ui >}} authorization strategy.
52
+
53
+
To configure authentication tokens, enable the {{< ui >}}Configure authentication tokens{{< /ui >}} toggle:
54
+
55
+
1. Click {{< ui >}}Manage Tokens{{< /ui >}} and then {{< ui >}}Add Token{{< /ui >}}.
56
+
1. Enter the identifier for your token key.<br>**Note**: If you are using environment variables, the environment variable for this token is the identifier you entered prepended with `DD_OP_`.
57
+
1. (Optional) Enter a field and value if you want to add additional information to logs successfully authenticated with this specific token.
58
+
1. Select the path to token in the {{< ui >}}Path to Token{{< /ui >}} dropdown menu:
59
+
- {{< ui >}}Header{{< /ui >}} for an authorization header (optionally, enter the header name)
Copy file name to clipboardExpand all lines: content/en/observability_pipelines/sources/splunk_hec.md
+14-2Lines changed: 14 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ Use Observability Pipelines' Splunk HTTP Event Collector (HEC) source to receive
29
29
30
30
Set up this source when you [set up a pipeline][1]. You can set up a pipeline in the [UI][6], using the [API][7], or with [Terraform][8]. The instructions in this section are for setting up the source in the UI.
31
31
32
-
<divclass="alert alert-danger">For Secrets Management: Only enter the identifiers for the Splunk HEC address and, if applicable, the TLS key pass. Do <b>not</b> enter the actual values.</div>
32
+
<divclass="alert alert-danger">For Secrets Management: Only enter the identifiers for the Splunk HEC address and, if applicable, the TLS key pass and authentication token keys. Do <b>not</b> enter the actual values.</div>
@@ -40,12 +40,24 @@ After you select the Splunk HEC source in the pipeline UI:
40
40
- Use a Splunk HEC destination with the {{< ui >}}From Source{{< /ui >}} token strategy.
41
41
- Use an Enrichment Table processor to map Splunk HEC tokens from a local file.
42
42
43
-
### Optional TLS settings
43
+
### Optional settings
44
+
45
+
#### Enable TLS
44
46
45
47
{{% observability_pipelines/tls_settings %}}
46
48
47
49
{{% observability_pipelines/tls_settings_mtls %}}
48
50
51
+
#### Configure authentication tokens
52
+
53
+
If you store Splunk HEC tokens in your HTTP request's authorization header, you can configure Observability Pipelines to check if incoming HTTP requests have a valid token. Request events that do not have a valid token are dropped.
54
+
55
+
To configure authentication tokens, enable the {{< ui >}}Configure authentication tokens{{< /ui >}} toggle:
56
+
57
+
1. Click {{< ui >}}Manage Tokens{{< /ui >}} and then {{< ui >}}Add Token{{< /ui >}}.
58
+
1. Enter the identifier for your token key.<br>**Note**: If you are using environment variables, the environment variable for this token is the identifier you entered prepended with `DD_OP_`.
59
+
1. (Optional) Enter a field and value if you want to add additional information to logs successfully authenticated with this specific token.
0 commit comments