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

Improve OTLP Exporter doc - provide recommendation on custom AuthN #5380

Merged
merged 4 commits into from
Feb 22, 2024
Merged

Improve OTLP Exporter doc - provide recommendation on custom AuthN #5380

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4c4e981
Improve OTLP Exporter doc - provide recommendation on custom AuthN
reyang Feb 22, 2024
b79b151
link
reyang Feb 22, 2024
62b5b99
Update src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md
reyang Feb 22, 2024
1b5ec4e
Update src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md
reyang Feb 22, 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
13 changes: 11 additions & 2 deletions src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,14 @@ services.AddOpenTelemetry()
}));
```

> [!NOTE]
> `DefaultRequestHeaders` can be used for [HTTP Basic Access
Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). For
more complex authentication requirements,
[`System.Net.Http.DelegatingHandler`](https://learn.microsoft.com/dotnet/api/system.net.http.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"
Expand All @@ -362,8 +370,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

Expand Down