Skip to content

Commit dedf8a3

Browse files
authored
Merge pull request #75487 from max-cx/OBSDOCS-937
OBSDOCS-937/TRACING-4071: Write documentation for oidcauthextension component
2 parents 8fff6ec + 4d4eab6 commit dedf8a3

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

modules/otel-collector-components.adoc

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1190,6 +1190,48 @@ The File Storage Extension supports traces, metrics, and logs. This extension ca
11901190
<5> Defines the maximum size of the compaction transaction. To ignore the transaction size, set to zero. If omitted, the default is `+65536+` bytes.
11911191
<6> When set, forces the database to perform an `fsync` call after each write operation. This helps to ensure database integrity if there is an interruption to the database process, but at the cost of performance.
11921192

1193+
[id="oidcauth-extension_{context}"]
1194+
=== OIDC Auth Extension
1195+
1196+
:FeatureName: The OIDC Auth Extension
1197+
include::snippets/technology-preview.adoc[]
1198+
1199+
The OIDC Auth Extension authenticates incoming requests to receivers by using the OpenID Connect (OIDC) protocol.
1200+
It validates the ID token in the authorization header against the issuer and updates the authentication context of the incoming request.
1201+
1202+
.OpenTelemetry Collector custom resource with the configured OIDC Auth Extension
1203+
[source,yaml]
1204+
----
1205+
config: |
1206+
extensions:
1207+
oidc:
1208+
attribute: authorization # <1>
1209+
issuer_url: https://example.com/auth/realms/opentelemetry # <2>
1210+
issuer_ca_path: /var/run/tls/issuer.pem # <3>
1211+
audience: otel-collector # <4>
1212+
username_claim: email # <5>
1213+
receivers:
1214+
otlp:
1215+
protocols:
1216+
grpc:
1217+
auth:
1218+
authenticator: oidc
1219+
exporters:
1220+
otlp:
1221+
endpoint: <endpoint>
1222+
service:
1223+
extensions: [oidc]
1224+
pipelines:
1225+
traces:
1226+
receivers: [otlp]
1227+
exporters: [otlp]
1228+
----
1229+
<1> The name of the header that contains the ID token. The default name is `authorization`.
1230+
<2> The base URL of the OIDC provider.
1231+
<3> Optional: The path to the issuer's CA certificate.
1232+
<4> The audience for the token.
1233+
<5> The name of the claim that contains the username. The default name is `sub`.
1234+
11931235
[id="jaegerremotesampling-extension_{context}"]
11941236
=== Jaeger Remote Sampling extension
11951237

0 commit comments

Comments
 (0)