open-telemetry
/
opentelemetry-collector-releases
mirror of https://github.com/open-telemetry/opentelemetry-collector-releases.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[chore] Document use cases for OTLP distro (#947) 

Co-authored-by: Alex Boten <223565+codeboten@users.noreply.github.com>
This commit is contained in:
Pablo Baeyens 2025-05-20 23:48:44 +02:00 committed by GitHub
parent 9f31fa872d
commit dfb2d6a1a4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
distributions/otelcol-otlp/README.md
View File

@ -2,6 +2,8 @@
This distribution only contains the receiver and exporters for the OpenTelemetry Protocol (OTLP), including both gRPC and HTTP transport.
This distribution is useful for use cases such as [TLS termination][1], proxying, batching, compression, protocol translation (e.g. using gRPC within your host but HTTP to communicate with external services) and other similar scenarios running as a sidecar.
## Configuration
Unlike the Core and Contrib distributions, this distribution does not provide a default configuration file, and one will need to be created. The location of the config file is specified with the `--config` command line option.
@ -21,3 +23,5 @@ The full list of components is available in the [manifest](manifest.yaml)
### Rules for Component Inclusion
- Only `otlpreceiver`, `otlpexporter`, and `otlphttpexporter` are allowed.
[1]: https://en.wikipedia.org/wiki/TLS_termination_proxy