sumologic-otel-collector icon indicating copy to clipboard operation
sumologic-otel-collector copied to clipboard

Consistent order of configuration sections in docs/examples

Open calebhailey opened this issue 2 years ago • 0 comments

It would be helpful for new users if we would organize configuration documentation and/or examples logically.

It has been helpful in my own exploration of OpenTelemetry to arrange my configuration files in the same order that the data flows, i.e. receivers => processors => exporters => [service.]pipelines. In this same model, I place extensions as modules to be loaded before configuring the observability pipelines.

---
# /etc/otelcol-sumo/config.yaml
extensions: {} # enable OT extensions

receivers: {} # collect data
processors: {} # filter, aggregate/correlate, and enrich data
exporters: {} # send data

service: {} # daemon runtime instructions

In most examples in our configuration documentation we organize these sections in order of exporters, extensions, receivers, and service (with no empty processors section). In other examples we use other orders, which is inconsistent at best and confusing for new users at worst.

It would be great if we restructured the examples in our documentation to consistently order configuration sections. 👌 🙏

calebhailey avatar Aug 02 '22 21:08 calebhailey