Skip to content

Migrate beyla documentation for OBI #7399

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

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

Conversation

svrnm
Copy link
Member

@svrnm svrnm commented Jul 24, 2025

As discussed in #7295, this branch allows us to work on the integration

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

TODO List:

  • Remove front matter aliases that point to other grafana docs
  • Remove or replace "beyla"
  • 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"
  • Incorporate changes from Improve YAML config docs grafana/beyla#2085
  • Copy images or remove references to images

Follow-Up issues to be created:

  • content/en/docs/zero-code/obi/performance.md was removed, tag for measuring performance impact later.

Co-authored-by: Jay DeLuca <[email protected]>
Co-authored-by: Mario Macias <[email protected]>
belongs to the OpenTelemetry demo with the following query:

```
count(beyla_network_flow_bytes_total) by (k8s_src_namespace, k8s_dst_namespace)
Copy link
Member Author

Choose a reason for hiding this comment

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

#7295 (comment) via @mariomac

Note: beyla_network_flow_bytes_total will be renamed at some point. First probably we'll rename it to obi_network_flow_bytes_total, but at some point we would like to agree on a common semantic convention with other SIGs.

Choose a reason for hiding this comment

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

FYI current main version of OBI already reports the metric as obi_network_flow_bytes.

Copy link
Member Author

Choose a reason for hiding this comment

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

would it be ok to replace all instances of beyla_network (and similar) with obi_network (and similar) for now?

Choose a reason for hiding this comment

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

Totally

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 starting point looks great to me!

We can start modifying the documents on this branch, removing all the Beyla and Grafana-specific contents.

@svrnm
Copy link
Member Author

svrnm commented Jul 24, 2025

Status of occurrences of "beyla", "grafana", "alloy" -- we probably don't need to replace all of them but we need to check most of them if they can be removed or replaced with "obi"

❯ grep "beyla" . -Ri | wc
     920    8116   96151
❯ grep "grafana" . -Ri | wc
     234    1541   24078
❯ grep "alloy" . -Ri | wc
      10     123    1545

spec:
containers:
- name: nodejs-service
image: ghcr.io/grafana/beyla-test/nodejs-testserver
Copy link
Member Author

Choose a reason for hiding this comment

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

@open-telemetry/ebpf-instrumentation-approvers do we have published images that replace those testservers?

Choose a reason for hiding this comment

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

For the images we used in our integration tests, we have some example servers as different tags of the ghcr.io/open-telemetry/obi-testimg image: https://github.com/open-telemetry/opentelemetry-ebpf-instrumentation/pkgs/container/obi-testimg/versions?filters%5Bversion_type%5D=tagged

However we haven't yet any image for nodejs. Any nodejs sample/dummy image that just accepts requests should work.

We can anyway extend the set of obi-testimg images to node, Python, etc... It would be positive because it would accelerate our integration tests by not having to rebuild them.

Comment on lines +16 to +20
```
curl -OL https://raw.githubusercontent.com/grafana/beyla/main/examples/quickstart/cpp/httplib.h
curl -OL https://raw.githubusercontent.com/grafana/beyla/main/examples/quickstart/cpp/quickstart.cpp
g++ -std=c++11 quickstart.cpp -o quickstart && ./quickstart
```
Copy link
Member Author

Choose a reason for hiding this comment

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

@open-telemetry/ebpf-instrumentation-approvers it looks like those examples files have not (yet) been migrated to the repo?

Comment on lines +15 to +20
Find the latest image of OBI on
[Docker Hub](https://hub.docker.com/r/grafana/beyla) with the following name:

```
grafana/beyla:latest
```
Copy link
Member Author

Choose a reason for hiding this comment

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

@open-telemetry/ebpf-instrumentation-approvers
Do we publish images to dockerhub already, and if so what are the updated names?

Choose a reason for hiding this comment

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

https://hub.docker.com/r/otel/ebpf-instrument/tags

otel/ebpf-instrument:main

(still no 0.1.0 nor latest tag available)

Comment on lines +29 to +31
```sh
helm repo add grafana https://grafana.github.io/helm-charts
```
Copy link
Member Author

Choose a reason for hiding this comment

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

do we provide helm charts already?

Choose a reason for hiding this comment

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

@svrnm svrnm added sig:obi and removed lang:zh labels Jul 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants