Skip to content

[draft/wip] Migrate beyla documentation for OBI #7295

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

Draft
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

svrnm
Copy link
Member

@svrnm svrnm commented Jul 10, 2025

This PR takes the documentation from https://github.com/grafana/beyla/tree/main/docs and integrates it into our documentation.

Preview: Preview: https://deploy-preview-7295--opentelemetry.netlify.app/docs/zero-code/obi/

Copy link

@mariomac mariomac left a comment

Choose a reason for hiding this comment

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

As a first step, it is Ok just to start moving everything here, but this will need a lot of rework:

  • Replace BEYLA_ by OTEL_EBPF_ in environment variables.
  • Remove references to Alloy
  • Remove references to Process metrics
  • Fix broken links
  • Replace references and labels mentioning Beyla by "OBI" or "OpenTelemetry eBPF instrumentation"

@grafsean
Copy link

Hi @svrnm could you incorporate our improvements to some of the YAML configuration docs grafana/beyla#2085

@svrnm
Copy link
Member Author

svrnm commented Jul 22, 2025

@grafsean @mariomac @open-telemetry/docs-approvers revisting this right now, and following up on a conversation @mariomac and I had over at CNCF slack: I think it would be best for us to find some time to chat how we can collaborate on making sure that we do not duplicate efforts for OBI and beyla docs. Would it be possible for you to come to the SIG Comms meeting this Wednesday 7 to 8pm? Also happy to find another time, which we best coordinate via slack?

Thanks

@grafsean
Copy link

Hello @svrnm , I caught up with @mariomac and he had a good suggestion to organise the remaining work:

  • Could you merge your progress into a docs branch
  • Then we can all address the existing comments there before merging back to main
  • I think it would be a great way to organise the work into a task list we can all share

What do you think of the plan? Once we get this into place we can meet if there are any blockers 🙂

@svrnm
Copy link
Member Author

svrnm commented Jul 24, 2025

Creating a dedicated branch such that we can collaborate on it sounds like a good idea to me, let me do that 👍

We talked about this PR and how we want to integrate OBI documentation in the future during yesterday's SIG Communications call:

  • We (@open-telemetry/docs-maintainers) are here for you to drive the integration of the docs, since we are the experts on this repo, how all things are structured and connected, and we want to make sure that this big addition to our docs goes smoothly:-)
  • We'd like to understand your plans around the beyla docs, in which form or shape will they continue to exist? Our interest is to avoid duplication. If you plan to drop it after the integration here, great! Otherwise, this is the part where we need to talk how to keep them in sync.
  • Post-Merge of the integration the docs are co-owned by SIG eBPF Instrumentation & SIG Documentation. This especially means we need help to have the docs written and kept up-to-date.

Thanks!

@svrnm
Copy link
Member Author

svrnm commented Jul 24, 2025

Created the branch: https://github.com/open-telemetry/opentelemetry.io/tree/beyla-docs-integration, you are now able to provide PRs against it and we can easily merge with without all the CI checks&review checks passing.

I created the "final PR" already to track how it is in sync:

#7399

@grafsean
Copy link

Thank you @svrnm, let's start turning the comments into tasks! Nice one 😄

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

Successfully merging this pull request may close these issues.

4 participants