Skip to content

Commit

Permalink
[docs] add status information for OTLP exporter (open-telemetry#5374)
Browse files Browse the repository at this point in the history
* [docs] add status information for OTLP exporter

Adds the status header for the OTLP exporter.

* add stability per signal

* Update README.md
  • Loading branch information
codeboten authored May 17, 2022
1 parent 19cc093 commit 1f31c1a
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions exporter/otlpexporter/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# OTLP gRPC Exporter

| Status | |
| ------------------------ | --------------------- |
| Stability | traces [stable] |
| | metrics [stable] |
| | logs [beta] |
| Supported pipeline types | traces, metrics, logs |
| Distributions | [core], [contrib] |

Exports data via gRPC using [OTLP](
https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md)
format. By default, this exporter requires TLS and offers queued retry capabilities.

Supported pipeline types: traces, metrics, logs

:warning: OTLP logs format is currently marked as "Beta" and may change in
incompatible ways.

## Getting Started

The following settings are required:
Expand Down Expand Up @@ -50,3 +53,8 @@ Several helper files are leveraged to provide additional capabilities automatica
- [gRPC settings](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configgrpc/README.md)
- [TLS and mTLS settings](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md)
- [Queuing, retry and timeout settings](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/exporterhelper/README.md)

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[core]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol
[stable]: https://github.com/open-telemetry/opentelemetry-collector#stable

0 comments on commit 1f31c1a

Please sign in to comment.