Skip to content

[Request]: Clean up OpenTelemetry content #4843

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.

Sign up for GitHub

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

Jump to bottom
Open
colleenmcginnis opened this issue Mar 11, 2025 · 4 comments · Fixed by elastic/docs-content#985
Open

[Request]: Clean up OpenTelemetry content #4843

colleenmcginnis opened this issue Mar 11, 2025 · 4 comments · Fixed by elastic/docs-content#985
Labels
Docset:All Lead:Product

Comments

@colleenmcginnis
Copy link
Contributor

Description

We need to clean up OpenTelemetry-related content for the 9.0 release. This might include:

  • Removing content that is outdated (for example, non-EDOT methods described in Use OpenTelemetry with APM).
  • Limiting details about OpenTelemtery in the Observability guide, linking to the new GitHub pages site that is built from files that live in elastic/opentelemetry instead.
  • Moving detailed OpenTelemetry content to the GitHub pages site.

I'll work with @akhileshpok to figure out how to handle all OpenTelemetry content listed below.

Resources

Here are the stateful Observability guide pages with mentions of OpenTelemetry:

Note: This list includes existing stateful docs, but the decisions we make will affect how we document both stateful and serverless.

Which documentation set does this change impact?

Stateful and Serverless

Feature differences

TBD

What release is this request related to?

9.0

Collaboration model

The product team

Point of contact.

Main contact: @akhileshpok @colleenmcginnis

Stakeholders: @mlunadia @AlexanderWert
@mdbirnstiehl mdbirnstiehl mentioned this issue Mar 31, 2025
Merged
@theletterf theletterf mentioned this issue Apr 11, 2025
Closed
@theletterf
Copy link

Let's also execute the cleanup in the old repo.

@colleenmcginnis colleenmcginnis mentioned this issue Apr 11, 2025
Closed
10 tasks
@colleenmcginnis
Copy link
Contributor Author

@AlexanderWert @carsonip @simitt @kruskall can you outline what you'd like to see here so we can keep @akhileshpok in the loop, too?

cc @theletterf @mlunadia

@carsonip
Copy link
Member

elastic/docs-content#985 seemed to have removed some docs (e.g. limitations, known issues) on supported (GA) OTel ingest paths of APM Server and MIS, and may result in user confusion and support cases. The scope of any clean up should be limited to removing outdated and irrelevant content.

Moving forward, I suggest that we

@theletterf theletterf mentioned this issue Apr 14, 2025
Merged
@carsonip carsonip mentioned this issue Apr 14, 2025
Closed
theletterf added a commit to elastic/docs-content that referenced this issue Apr 14, 2025
@theletterf
Revert "Clean up OpenTelemetry content" (#1129)
4e7ef74 
Reverts #985

See
elastic/observability-docs#4843 (comment)
@theletterf theletterf mentioned this issue Apr 17, 2025
Merged
@akhileshpok
Copy link

@colleenmcginnis, @theletterf - Let's keep the APM server related content as is, unless it is not applicable anymore. From a top level APM docs pov, we should provide new users either the OTel or the Elastic APM option. The OTel option should point users to the new EDOT related content. Existing APM users can continue to rely on the APM server related docs until they are ready to migrate to the EDOT Collector.

theletterf added a commit to elastic/docs-content that referenced this issue Apr 24, 2025
@theletterf @carsonip
Add ECS conversion tables (#1186)
b3223b8 
Fixes elastic/apm-server#15509

Take the content in
elastic/observability-docs#4843, converts it
to Markdown and apply edits for style and structure.

+CC @harshithsaiv

---------

Co-authored-by: Carson Ip <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docset:All Lead:Product
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Clean up OpenTelemetry content mdbirnstiehl/docs-content
5 participants
@theletterf @carsonip @colleenmcginnis @akhileshpok @mdbirnstiehl