Skip to content

docs(observability): datadog credential_ref slug rule + list all exporter kinds in ops doc #576

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
moonming merged 1 commit into from
Jun 9, 2026
Merged

docs(observability): datadog credential_ref slug rule + list all exporter kinds in ops doc #576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/configuration/observability-exporters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ Sends each request event as one log to the Datadog Logs HTTP intake. The data pl
| `content_mode` | string | No | `metadata_only` | `metadata_only` or `full`. See [Content capture](#content-capture). |
| `content_max_bytes` | integer | No | `131072` | Per-field byte cap under `full`; minimum `1`, maximum `1048576` (1 MiB). Ignored under `metadata_only`. |

The data plane resolves `credential_ref` to `DD_CRED_<SLUG>_API_KEY`, read from its local environment, where `<SLUG>` is the reference upper-cased with every character that is not an ASCII letter or digit folded to `_` (so `acme_dd` becomes `ACME_DD`).
The data plane resolves `credential_ref` to `DD_CRED_<SLUG>_API_KEY`, read from its local environment, where `<SLUG>` is the reference upper-cased with every character that is not an ASCII letter or digit folded to `_` (so `acme_dd` becomes `ACME_DD`). To keep that mapping unambiguous — so two different references cannot silently fold onto the same variable — use only lowercase letters, digits, and underscores in `credential_ref`; the control plane and dashboard enforce `^[a-z0-9_]+$`.

```bash title="Create a datadog exporter"
curl -sS -X POST http://127.0.0.1:3001/admin/v1/observability_exporters \
Expand Down
2 changes: 1 addition & 1 deletion docs/operations/metrics-and-logs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Those headers are often the fastest per-request debugging hints available to a c

Observability exporters are dynamic resources configured through `/admin/v1/observability_exporters`.

Current exporter support is `otlp_http` only.
Four kinds are supported — `otlp_http` (request traces), `object_store` (batched NDJSON to S3 / GCS / Azure Blob), `aliyun_sls` (Alibaba Cloud SLS logstore), and `datadog` (Datadog Logs intake). See [Observability Exporters](../configuration/observability-exporters.md) for each kind's fields, credential resolution, and destination validation.

## Operator Workflow

Expand Down
Loading