Skip to content

[DOCS] Enhance OpenTelemetry resource attributes documentation with detailed mapping information #4834

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

Closed
wants to merge 3 commits into from

Conversation

harshithsaiv
Copy link

@harshithsaiv harshithsaiv commented Mar 1, 2025

Description

This PR enhances the OpenTelemetry resource attributes documentation to provide clear explanations about how different types of attributes are mapped to Elastic Common Schema (ECS) fields. It expands on the existing documentation to clarify how unmapped attributes are handled, how OpenTelemetry spans map to APM concepts, and how attribute values are conditionally translated.

Documentation sets edited in this PR

Check all that apply.

  • Stateful (docs/en/observability/*)
  • Serverless (docs/en/serverless/*)
  • Integrations Developer Guide (docs/en/integrations/*)
  • None of the above

Related issue

Closes #elastic/apm-server#15509 (comment)

Checklist

  • Product/Engineering Review
  • Writer Review

Follow-up tasks

Select one.

  • This PR does not need to be ported to another doc set because:
    • The concepts in this PR only apply to one doc set (serverless or stateful)
    • The PR contains edits to both doc sets (serverless and stateful)
  • This PR needs to be ported to another doc set:
    • Port to stateful docs: <link to PR or tracking issue>
    • Port to serverless docs: <link to PR or tracking issue>

Labels

This PR is for serverless documentation, so it should have the backport-skip label applied as per guidance for serverless docs. It should also have the appropriate review labels (needs-writer-review, needs-dev-review) added.

@harshithsaiv harshithsaiv requested a review from a team as a code owner March 1, 2025 06:39
Copy link

cla-checker-service bot commented Mar 1, 2025

💚 CLA has been signed

Copy link
Contributor

github-actions bot commented Mar 1, 2025

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link
Contributor

github-actions bot commented Mar 1, 2025

Warning

It looks like this PR modifies one or more .asciidoc files. These files are being migrated to Markdown, and any changes merged now will be lost. See the migration guide for details.

Copy link
Contributor

mergify bot commented Mar 1, 2025

This pull request does not have a backport label. Could you fix it @harshithsaiv? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Mar 1, 2025
@harshithsaiv harshithsaiv reopened this Mar 1, 2025
Copy link
Contributor

github-actions bot commented Mar 1, 2025

Warning

It looks like this PR modifies one or more .asciidoc files. These files are being migrated to Markdown, and any changes merged now will be lost. See the migration guide for details.

@harshithsaiv harshithsaiv reopened this Mar 1, 2025
Copy link
Contributor

github-actions bot commented Mar 1, 2025

Warning

It looks like this PR modifies one or more .asciidoc files. These files are being migrated to Markdown, and any changes merged now will be lost. See the migration guide for details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-skip Skip notification from the automated backport with mergify needs-writer-review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant