Skip to content
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

fix: Update documentation for using filename in otelcol.auth.bearer component #2213

Merged
merged 2 commits into from
Dec 11, 2024
Merged

fix: Update documentation for using filename in otelcol.auth.bearer component #2213

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8c4c01
Add documentation for filename usage
ravishankar15 Dec 7, 2024
7601fc2
Update docs/sources/reference/components/otelcol/otelcol.auth.bearer.md
wildum Dec 11, 2024
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
6 changes: 5 additions & 1 deletion docs/sources/reference/components/otelcol/otelcol.auth.bearer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ Name | Type | Description | Default
When sending the token, the value of `scheme` is prepended to the `token` value.
The string is then sent out as either a header (in case of HTTP) or as metadata (in case of gRPC).

If you use a file to store the token, you can use `[local.file`][local.file] to retrieve the `token` value from the file.

[local.file]: ../../local/local.file/

## Blocks

The following blocks are supported inside the definition of
Expand Down Expand Up @@ -97,7 +101,7 @@ otelcol.auth.bearer "creds" {

The example below configures [otelcol.exporter.otlphttp][] to use a bearer token authentication.

If we assume that the value of the `API_KEY` environment variable is `SECRET_API_KEY`, then
If we assume that the value of the `API_KEY` environment variable is `SECRET_API_KEY`, then
the `Authorization` HTTP header is set to `MyScheme SECRET_API_KEY`.

```alloy
Expand Down
Loading