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

Clarify OpenTelemetry collector setup in our docs #417

Closed
ppf2 opened this issue Mar 2, 2021 · 4 comments
Closed

Clarify OpenTelemetry collector setup in our docs #417

ppf2 opened this issue Mar 2, 2021 · 4 comments
Assignees
Labels

Comments

@ppf2
Copy link
Member

ppf2 commented Mar 2, 2021

We are working with some users who are trying to set up OpenTelemetry collector to work with APM Server. They are familiar with our APM agents but not OpenTelemetry:
https://www.elastic.co/guide/en/apm/get-started/current/open-telemetry-elastic.html

It will be helpful to clarify the following directly in our docs (for users who do not know anything about OpenTelemetry):

@ppf2 ppf2 added the docs label Mar 2, 2021
@graphaelli
Copy link
Member

This page and guide are getting overhauled following the addition of native OpenTelemetry intake support. @bmorelli25 / @jalvz does this duplicate any open issues or can you link prs to this issue?

@bmorelli25
Copy link
Member

Gil, we do have this issue for documenting native support for OTLP/gRPC: elastic/apm-server#4678

Pius, thanks for opening this issue! I really appreciate the level of detail.

(for users who do not know anything about OpenTelemetry)

To provide some background, when we initially doc'd the OptenTelemetry integration (way back in 7.7), we decided to focus only on users who were already using OpenTelemetry. We didn't want to make architecture recommendations or dive too deep into what OTel is and how it works. That's why there's a lot of linking off to the OTel docs to learn the basics, and a note that says: "This guide assumes you’ve already instrumented your services with the OpenTelemetry API and/or SDK..."

We were (and still are) worried about the maintenance cost of providing too much documentation (duplicating docs?) for products we can't control. But if getting started with OTel from scratch is a common ask from our users, then maybe we should reconsider the initial documentation decision. This has come up at least once before on Slack.

In the meantime, yes, your improvements seem easy enough to make (and low-cost to maintain) 😄

@tbragin
Copy link

tbragin commented Mar 2, 2021

cc @cyrille-leclerc

@bmorelli25
Copy link
Member

Closing this as the OpenTelemetry Collector exporter for Elastic was deprecated in 7.13. See also elastic/observability-docs#467.

@ppf2 Please feel free to reopen this if you feel like anything is still missing.

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

No branches or pull requests

5 participants