Skip to content
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.

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

Additional information and more structure for the otelcol docs #373

Open
ptodev opened this issue Aug 24, 2023 · 4 comments
Open

Additional information and more structure for the otelcol docs #373

ptodev opened this issue Aug 24, 2023 · 4 comments
Assignees
Labels
enhancement New feature or request type/docs Docs Squad label across all Grafana Labs repos

Comments

@ptodev
Copy link
Contributor

ptodev commented Aug 24, 2023

Request

The docs of otelcol flow components should be more clear regarding things like:

  • Which version of Otel Collector is used
  • If a component if imported, then have a link to the otel repo for that component
  • Similarly, if the component is not imported (e.g. otelcol.receiver.prometheus) then this should be also clearly stated.
  • Which signal types (logs/metrics/traces) the component accepts as an input, and which ones it accepts as an output
  • Clarify the difference between a "connector" and a "processor"
    • A processor processes different signal types independently of each other, whereas a collector takes one signal type and outputs another.
  • Mention the "stability" of each component in the same way the otel docs do, at the top of each component's page?
    • Link to the definition of the particular stability - e.g. alpha, beta, stable

We should consider options other than free text for such information. E.g. a table might be nice.

Use case

Making the Otel documentation easier to understand.

@ptodev ptodev added enhancement New feature or request type/docs Docs Squad label across all Grafana Labs repos labels Aug 24, 2023
@ptodev
Copy link
Contributor Author

ptodev commented Aug 31, 2023

Additional docs improvements for otelcol components are also mentioned in #384.

@GrafanaWriter
Copy link

@clayton-cornell - FYI

@clayton-cornell
Copy link
Contributor

This is being worked on in: grafana/agent#4948 but on hold at the moment.

@rfratto rfratto transferred this issue from grafana/agent Apr 11, 2024
@clayton-cornell
Copy link
Contributor

@ptodev is this issue still valid?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request type/docs Docs Squad label across all Grafana Labs repos
Projects
No open projects
Development

No branches or pull requests

3 participants