Skip to content

Commit 1c86957

Browse files
authored
Merge pull request openshift#13 from max-cx/distributed-tracing-3.0_extension_basic_auth
distr-otel: add description of the basic auth extension
2 parents 8541093 + 4dc5a8a commit 1c86957

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

modules/distr-tracing-otel-config-collector.adoc

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -365,3 +365,56 @@ The Logging exporter prints data to the standard output.
365365
exporters: [logging]
366366
----
367367
<1> Verbosity of the logging export: `detailed` or `normal` or `basic`. When set to `detailed`, pipeline data is verbosely logged. Defaults to `normal`.
368+
369+
[id="extensions_{context}"]
370+
=== Extensions
371+
372+
[id="basicauth-extension_{context}"]
373+
==== BasicAuth extension
374+
375+
You can use the BasicAuth extension as an authenticator on receivers and exporters.
376+
Client authentication and server authentication for the BasicAuth extension are configured in separate sections in the OpenTelemetry Collector custom resource.
377+
378+
* Support level: link:https://access.redhat.com/support/offerings/techpreview[Technology Preview]
379+
* Supported signals: traces, metrics, logs
380+
381+
.OpenTelemetry Collector custom resource with client and server authentication configured for the BasicAuth extension
382+
[source,yaml]
383+
----
384+
config: |
385+
extensions:
386+
basicauth/server:
387+
htpasswd:
388+
file: .htpasswd <1>
389+
inline: |
390+
${env:BASIC_AUTH_USERNAME}:${env:BASIC_AUTH_PASSWORD} <2>
391+
392+
basicauth/client:
393+
client_auth:
394+
username: username <3>
395+
password: password <4>
396+
397+
receivers:
398+
otlp:
399+
protocols:
400+
http:
401+
auth:
402+
authenticator: basicauth/server <5>
403+
exporters:
404+
otlp:
405+
auth:
406+
authenticator: basicauth/client <6>
407+
408+
service:
409+
extensions: [basicauth/server, basicauth/client]
410+
pipelines:
411+
traces:
412+
receivers: [otlp]
413+
exporters: [otlp]
414+
----
415+
<1> The BasicAuth extension can be configured as a server authenticator that reads credentials from a `.htpasswd` file.
416+
<2> The BasicAuth extension can be configured as a client authenticator to read the credentials from an inline string that consists of environment variables.
417+
<3> The client username is configured as a client authenticator for the BasicAuth extension.
418+
<4> The client password is configured as a client authenticator for the BasicAuth extension.
419+
<5> The authenticator configuration can be assigned to an OTLP receiver.
420+
<6> The authenticator configuration can be assigned to an OTLP exporter.

0 commit comments

Comments
 (0)