From 4c4e9814f78e252cc74591adca588ca9d56f4659 Mon Sep 17 00:00:00 2001 From: Reiley Yang Date: Thu, 22 Feb 2024 11:46:21 -0800 Subject: [PATCH] Improve OTLP Exporter doc - provide recommendation on custom AuthN --- .../README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md index 290e9daa6b5..4281b1091cb 100644 --- a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md +++ b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md @@ -350,6 +350,13 @@ services.AddOpenTelemetry() })); ``` +> [!NOTE] +> `DefaultRequestHeaders` can be used for [HTTP Basic Access +Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication), for +more complex authentication requirement, `DelegatingHandler` can be used to +handle token refresh, as explained +[here](https://stackoverflow.com/questions/56204350/how-to-refresh-a-token-using-ihttpclientfactory). + For users using [IHttpClientFactory](https://docs.microsoft.com/dotnet/architecture/microservices/implement-resilient-applications/use-httpclientfactory-to-implement-resilient-http-requests) you may also customize the named "OtlpTraceExporter" and/or "OtlpMetricExporter" @@ -362,8 +369,9 @@ services.AddHttpClient( client.DefaultRequestHeaders.Add("X-MyCustomHeader", "value")); ``` -Note: The single instance returned by `HttpClientFactory` is reused by all -export requests. +> [!NOTE] +> The single instance returned by `HttpClientFactory` is reused by all export +requests. ## Troubleshooting