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

Initial Ingest OTel collector docs for Elastic Agent #1086

Closed
kilfoyle opened this issue May 24, 2024 · 4 comments
Closed

Initial Ingest OTel collector docs for Elastic Agent #1086

kilfoyle opened this issue May 24, 2024 · 4 comments
Assignees

Comments

@kilfoyle
Copy link
Contributor

kilfoyle commented May 24, 2024

From Bill:

We've been asked to push up the release of the OTel collector and to make onboarding available via the UI in 8.15.0.

We'd like to start producing the initially internal docs for using the "OTel-mode" of Elastic Agent. In the beginning we just want to document basic (how to start OTel-mode, how to configure OTel, etc) usage but it'll probably expand out to several documents as we get closer to GA.

Resources
configuration: https://opentelemetry.io/docs/collector/configuration/
transforming: https://opentelemetry.io/docs/collector/transforming-telemetry/
architecture: https://opentelemetry.io/docs/collector/architecture/
deployment (agent): https://opentelemetry.io/docs/collector/deployment/agent/
Readme on using agent in otel mode: https://github.com/elastic/elastic-agent/blob/main/internal/pkg/otel/README.md?plain=1

To be visible only in the 8.15+ versions of the Fleet & Agent guide, starting at the 8.15 GA date (July 30).

Use Beta ([preview]) admonition:
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

@kilfoyle kilfoyle self-assigned this May 24, 2024
@kilfoyle kilfoyle changed the title Initial OTel collector docs for Elastic Agent, 8.15 Initial OTel collector docs for Elastic Agent Jun 4, 2024
@strawgate strawgate changed the title Initial OTel collector docs for Elastic Agent Initial Ingest OTel collector docs for Elastic Agent Jun 11, 2024
@bmorelli25
Copy link
Member

@kilfoyle have you seen https://github.com/elastic/opentelemetry-dev/issues/242? Does this issue cover all of the asks in that issue?

@kilfoyle
Copy link
Contributor Author

@bmorelli25 Thanks for the heads up! I wasn't aware of that issue.

  • My PR for this issue so far includes the install steps for all platforms.
  • For troubleshooting, I'd need someone to provide guidance on whatever troubleshooting steps we can add to the docs. Even for agent in regular, non-OTel mode we only have troubleshooting docs for specific scenarios and not much in the way of general troubleshooting procedures. It would be a great thing to add.

CC @strawgate

@strawgate
Copy link

documentation for troubleshooting onboarding flows should live in the onboarding guides, we can expand this out as desired

@kilfoyle
Copy link
Contributor Author

Closed by #1250

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants