Skip to content

Clarify OBI support, compatibility, and limitations docs#9642

Merged
theletterf merged 3 commits intoopen-telemetry:mainfrom
MrAlias:obi-support-matrix
Apr 20, 2026
Merged

Clarify OBI support, compatibility, and limitations docs#9642
theletterf merged 3 commits intoopen-telemetry:mainfrom
MrAlias:obi-support-matrix

Conversation

@MrAlias
Copy link
Copy Markdown
Contributor

@MrAlias MrAlias commented Apr 13, 2026

Updates the OBI docs under content/en/docs/zero-code/obi to make support, compatibility, and limitations clearer and more user-focused.

Follow-up to open-telemetry/opentelemetry-ebpf-instrumentation#1757 and open-telemetry/opentelemetry-ebpf-instrumentation#1760 which clarify OBI supported things.

This change:

  • removes distro-version support claims from the OBI landing page and replaces them with a narrower, requirements-based compatibility summary
  • separates support scope from limitations so the landing page is easier to scan and less repetitive
  • moves detailed instrumentation compatibility information into the feature and instrumentation docs that already own that content
  • adds explicit compatibility details for distributed tracing, protocol and library instrumentation, and GPU instrumentation
  • cleans up links and section structure affected by the landing page rewrite

Docs changes

  • updates content/en/docs/zero-code/obi/_index.md
    • merges the old Requirements content into Compatibility
    • keeps the landing page focused on platform requirements, published artifacts, support boundaries, and links to detailed support docs
    • narrows Limitations to actual observability and behavior constraints
  • updates content/en/docs/zero-code/obi/distributed-traces.md
    • adds a compatibility section for context propagation support across supported runtimes and environments
  • updates content/en/docs/zero-code/obi/configure/export-data.md
    • adds a top-level instrumentation compatibility section
    • documents supported protocol versions, runtime and server requirements, Go library compatibility, and GPU instrumentation compatibility
  • updates content/en/docs/zero-code/obi/configure/collector-receiver.md
    • removes a weak link to the OBI landing page for the “minimal overhead” statement after the Requirements section was removed

Notes

  • this change is intended to align the public docs with the current OBI support matrix without overstating support
  • detailed feature caveats remain in the feature-specific pages rather than on the top-level OBI landing page

  • I have read and followed the Contributing docs, especially the "First-time contributing?" section.
  • This PR has content that I did not fully write myself.
  • I have the experience and knowledge necessary to understand, review, and validate all content in this PR.1

Footnotes

  1. Yes, I can answer maintainer questions about the content of this PR, without using AI.

@otelbot-docs otelbot-docs bot requested a review from a team April 13, 2026 20:16
@otelbot-docs otelbot-docs bot added missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer missing:sig-approval Co-owning SIG didn't provide an approval labels Apr 13, 2026
@github-actions github-actions bot added sig:obi and removed missing:sig-approval Co-owning SIG didn't provide an approval labels Apr 13, 2026
@MrAlias MrAlias force-pushed the obi-support-matrix branch from 0146bab to dcef8c3 Compare April 13, 2026 20:20
@otelbot-docs otelbot-docs bot added the missing:sig-approval Co-owning SIG didn't provide an approval label Apr 13, 2026
@MrAlias MrAlias force-pushed the obi-support-matrix branch from dcef8c3 to efe2d11 Compare April 13, 2026 20:23
@MrAlias MrAlias marked this pull request as ready for review April 13, 2026 20:31
@MrAlias MrAlias requested a review from a team as a code owner April 13, 2026 20:31
Copilot AI review requested due to automatic review settings April 13, 2026 20:31
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refines the OpenTelemetry eBPF Instrumentation (OBI) documentation to present support scope, compatibility requirements, and limitations more clearly, moving detailed compatibility specifics into the relevant feature/configuration pages.

Changes:

  • Rewrites the OBI landing page to use requirements-based compatibility (instead of distro lists) and to separate support scope from limitations.
  • Adds explicit compatibility matrices/details for distributed tracing context propagation and for protocol/library/GPU instrumentation.
  • Cleans up wording/links impacted by the landing page restructure (including removing a now-weak cross-link in Collector receiver docs).

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
content/en/docs/zero-code/obi/_index.md Reworks landing page structure; adds requirement-based compatibility and clearer limitations with links to detailed pages.
content/en/docs/zero-code/obi/distributed-traces.md Adds a compatibility section/table for distributed tracing and clarifies network-level gRPC/HTTP2 limitations.
content/en/docs/zero-code/obi/configure/export-data.md Adds instrumentation compatibility sections covering protocols, runtime constraints, Go library support, and GPU/CUDA instrumentation.
content/en/docs/zero-code/obi/configure/collector-receiver.md Removes a weakened link reference after the landing page restructure; keeps the performance note as plain text.

Comment thread content/en/docs/zero-code/obi/distributed-traces.md Outdated
Comment thread content/en/docs/zero-code/obi/configure/export-data.md Outdated
Comment thread content/en/docs/zero-code/obi/distributed-traces.md Outdated
@otelbot-docs otelbot-docs bot removed the missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer label Apr 14, 2026
@theletterf
Copy link
Copy Markdown
Member

@open-telemetry/ebpf-instrumentation-approvers Please have a look, thanks!

@theletterf theletterf added this pull request to the merge queue Apr 20, 2026
Merged via the queue into open-telemetry:main with commit b53fd36 Apr 20, 2026
24 checks passed
@MrAlias MrAlias deleted the obi-support-matrix branch April 20, 2026 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

missing:sig-approval Co-owning SIG didn't provide an approval sig:obi

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants