Skip to content

[otlp] Add readme toc and clarify endpoint confusion #5385

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

Merged
merged 6 commits into from
Mar 12, 2024
Merged

[otlp] Add readme toc and clarify endpoint confusion #5385

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5bdde2e
organize readme and clarify endpoint confusion
vishweshbankwar Feb 23, 2024
5a24f74
reword
vishweshbankwar Feb 23, 2024
ab30bcb
indent
vishweshbankwar Feb 23, 2024
b12e3e2
fix link
vishweshbankwar Feb 23, 2024
c0a67a8
re-arrange sequence
vishweshbankwar Feb 23, 2024
9b77cf0
Merge branch 'main' into vibankwa/organize-otlp-readme
vishweshbankwar Mar 12, 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
4 changes: 4 additions & 0 deletions src/OpenTelemetry.Exporter.OpenTelemetryProtocol/OtlpExporterOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,10 @@ internal OtlpExporterOptions(
/// * http://localhost:4317 for <see cref="OtlpExportProtocol.Grpc"/>
/// * http://localhost:4318 for <see cref="OtlpExportProtocol.HttpProtobuf"/>.
/// </summary>
/// <remarks>
/// When using <see cref="OtlpExportProtocol.HttpProtobuf"/>, the full URL MUST be provided, including the signal-specific path v1/{signal}.
/// For example, for traces, the full URL will look like http://your-custom-endpoint/v1/traces.
/// </remarks>
public Uri Endpoint
{
get
Expand Down
25 changes: 25 additions & 0 deletions src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,26 @@
[The OTLP (OpenTelemetry Protocol) exporter](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md)
implementation.

<!-- markdownlint-disable MD033 -->
<details>
<summary>Table of Contents</summary>

* [Installation](#installation)
* [Enable Trace Exporter](#enable-trace-exporter)
* [Enable Metric Exporter](#enable-metric-exporter)
* [Enable Log Exporter](#enable-log-exporter)
* [Configuration](#configuration)
* [OtlpExporterOptions](#otlpexporteroptions)
* [LogRecordExportProcessorOptions](#logrecordexportprocessoroptions)
* [MetricReaderOptions](#metricreaderoptions)
* [Environment Variables](#environment-variables)
* [Experimental Features](#environment-variables-for-experimental-features)
* [Configure HttpClient](#configure-httpclient)
* [Troubleshooting](#troubleshooting)

</details>
<!-- markdownlint-enable MD033 -->

## Prerequisite

* An endpoint capable of accepting OTLP, like [OpenTelemetry
Expand Down Expand Up @@ -169,6 +189,11 @@ appBuilder.Services.AddOptions<OtlpExporterOptions>()
`OtlpExportProtocol.Grpc` and "localhost:4318" for
`OtlpExportProtocol.HttpProtobuf`.

> [!NOTE]
> When using `OtlpExportProtocol.HttpProtobuf`, the full URL MUST be
> provided, including the signal-specific path v1/{signal}. For example, for
> traces, the full URL will look like <http://your-custom-endpoint/v1/traces>.

* `Headers`: Optional headers for the connection.

* `HttpClientFactory`: A factory function called to create the `HttpClient`
Expand Down