From 474d528a5a2428c989853b91d7d03aa1cda6bd05 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Thu, 14 Jul 2022 08:35:45 -0700 Subject: [PATCH 1/2] [docs] add descriptions for distros As the distributions are linked from various places, it makes sense to provide end-users a bit more clarity on what each distro includes. --- distributions/otelcol-contrib/README.md | 16 ++++++++++++++++ distributions/otelcol/README.md | 7 +++++++ 2 files changed, 23 insertions(+) create mode 100644 distributions/otelcol-contrib/README.md create mode 100644 distributions/otelcol/README.md diff --git a/distributions/otelcol-contrib/README.md b/distributions/otelcol-contrib/README.md new file mode 100644 index 00000000..f3ded466 --- /dev/null +++ b/distributions/otelcol-contrib/README.md @@ -0,0 +1,16 @@ +# OpenTelemetry Collector Contrib Distro + +This distribution contains all the components from both the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector) repository and the [OpenTelemetry Collector Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) repository. This distribution includes open source and vendor supported components. + +## Recommendation + +As this distribution contains many components, it is a good starting point to try various configurations. However, when running in production, it is recommended to limit the collector to contain only the components necessary for an environment. Some reasons to do this: + +* reduce the size of the collector, reducing deployment times for the collector +* improve the security of the collector by reducing the available attack surface area + +Building a custom collector can be achieved using the [OpenTelemetry Collector Builder](https://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/builder). + +## Components + +The full list of components is available in the [manifest](manifest.yaml) diff --git a/distributions/otelcol/README.md b/distributions/otelcol/README.md new file mode 100644 index 00000000..b44218de --- /dev/null +++ b/distributions/otelcol/README.md @@ -0,0 +1,7 @@ +# OpenTelemetry Collector Distro + +This distribution contains all the components from the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector) repository and a small selection of components tied to open source projects from the [OpenTelemetry Collector Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) repository. + +## Components + +The full list of components is available in the [manifest](manifest.yaml) From 2b0e2ca887973fd5f678cd1bc3f388f3d69138db Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Thu, 27 Oct 2022 08:25:51 -0700 Subject: [PATCH 2/2] Update distributions/otelcol-contrib/README.md --- distributions/otelcol-contrib/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/distributions/otelcol-contrib/README.md b/distributions/otelcol-contrib/README.md index f3ded466..5ec5f762 100644 --- a/distributions/otelcol-contrib/README.md +++ b/distributions/otelcol-contrib/README.md @@ -9,7 +9,7 @@ As this distribution contains many components, it is a good starting point to tr * reduce the size of the collector, reducing deployment times for the collector * improve the security of the collector by reducing the available attack surface area -Building a custom collector can be achieved using the [OpenTelemetry Collector Builder](https://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/builder). +Building a [custom collector](https://opentelemetry.io/docs/collector/custom-collector/) can be achieved using the [OpenTelemetry Collector Builder](https://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/builder). ## Components