-
Notifications
You must be signed in to change notification settings - Fork 1.5k
[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
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: svrnm <[email protected]>
There was a problem hiding this 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_
byOTEL_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"
Hi @svrnm could you incorporate our improvements to some of the YAML configuration docs grafana/beyla#2085 |
@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 |
Hello @svrnm , I caught up with @mariomac and he had a good suggestion to organise the remaining work:
What do you think of the plan? Once we get this into place we can meet if there are any blockers 🙂 |
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:
Thanks! |
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: |
Co-authored-by: Jay DeLuca <[email protected]> Co-authored-by: Mario Macias <[email protected]>
Co-authored-by: Jay DeLuca <[email protected]> Co-authored-by: Mario Macias <[email protected]>
Co-authored-by: Mario Macias <[email protected]> Co-authored-by: Jay DeLuca <[email protected]>
Thank you @svrnm, let's start turning the comments into tasks! Nice one 😄 |
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/