otelcol.auth.bearer
otelcol.auth.bearer
exposes a handler
that can be used by other otelcol
components to authenticate requests using bearer token authentication.
This component supports both server and client authentication.
Note
otelcol.auth.bearer
is a wrapper over the upstream OpenTelemetry Collectorbearertokenauth
extension. Bug reports or feature requests will be redirected to the upstream repository, if necessary.
Multiple otelcol.auth.bearer
components can be specified by giving them different labels.
Usage
otelcol.auth.bearer "LABEL" {
token = "TOKEN"
}
Arguments
otelcol.auth.bearer
supports the following arguments:
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.
Blocks
The following blocks are supported inside the definition of
otelcol.auth.bearer
:
debug_metrics block
The debug_metrics
block configures the metrics that this component generates to monitor its state.
The following arguments are supported:
disable_high_cardinality_metrics
is the Grafana Alloy equivalent to the telemetry.disableHighCardinalityMetrics
feature gate in the OpenTelemetry Collector.
It removes attributes that could cause high cardinality metrics.
For example, attributes with IP addresses and port numbers in metrics about HTTP and gRPC connections are removed.
Note
If configured,disable_high_cardinality_metrics
only applies tootelcol.exporter.*
andotelcol.receiver.*
components.
level
is the Alloy equivalent to the telemetry.metrics.level
feature gate in the OpenTelemetry Collector.
Possible values are "none"
, "basic"
, "normal"
and "detailed"
.
Exported fields
The following fields are exported and can be referenced by other components:
Component health
otelcol.auth.bearer
is only reported as unhealthy if given an invalid
configuration.
Debug information
otelcol.auth.bearer
does not expose any component-specific debug information.
Examples
Default scheme via gRPC transport
The example below configures otelcol.exporter.otlp to use a bearer token authentication.
If we assume that the value of the API_KEY
environment variable is SECRET_API_KEY
, then the Authorization
RPC metadata is set to Bearer SECRET_API_KEY
.
otelcol.exporter.otlp "example" {
client {
endpoint = "my-otlp-grpc-server:4317"
auth = otelcol.auth.bearer.creds.handler
}
}
otelcol.auth.bearer "creds" {
token = sys.env("API_KEY")
}
Custom scheme via HTTP transport
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
the Authorization
HTTP header is set to MyScheme SECRET_API_KEY
.
otelcol.exporter.otlphttp "example" {
client {
endpoint = "my-otlp-grpc-server:4317"
auth = otelcol.auth.bearer.creds.handler
}
}
otelcol.auth.bearer "creds" {
token = sys.env("API_KEY")
scheme = "MyScheme"
}