Add tutorial for running Beyla in Alloy's Helm #776
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
docs/sources/tutorial/helm-alloy.md
Outdated
| - tutorial | ||
| --- | ||
|
|
||
| # Run Beyla in Kubernetes using Grafana Alloy Helm's chart. |
There was a problem hiding this comment.
[Grafana.GoogleHeadingPunctuation] Don't put a period at the end of a heading.
For more information, refer to https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings.
If the rule is incorrect or needs improving, report an issue.
If you have reason to diverge from the style guidance, to skip a rule, refer to Skip rules.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
docs/sources/tutorial/helm-alloy.md
Outdated
|
|
||
| The `output` section configures that Beyla component sends traces to `otelcol.exporter.otlp` component. The `otelcol.exporter.otlp` section configures the [OTLP exporter]({{< relref "docs/alloy/latest/reference/components/otelcol.exporter.otlp/" >}}) to send the traces to Grafana Cloud Tempo. | ||
|
|
||
| For further details on the configuration options, refer to the documentation of the [Grafana Alloy Beyla component]({{< relref "docs/alloy/latest/reference/components/beyla.ebpf" >}}) |
There was a problem hiding this comment.
🚫 [doc-validator] reported by reviewdog 🐶
The relref '{{< relref "docs/alloy/latest/reference/components/beyla.ebpf" >}}' can resolve ambiguously because it is not a relative or absolute path.
If a relref has ambiguous resolution, the link won't work and will instead point to the current page.
A relative path begins with either ./ or ../.
An absolute path begins with a /.
docs/sources/tutorial/helm-alloy.md
Outdated
|
|
||
| The `prometheus.scrape` section configures the Prometheus scrape configuration to collect the metrics from Beyla. The `prometheus.remote_write` section configures the remote write to send the metrics to Grafana Cloud Prometheus. | ||
|
|
||
| The `output` section configures that Beyla component sends traces to `otelcol.exporter.otlp` component. The `otelcol.exporter.otlp` section configures the [OTLP exporter]({{< relref "/docs/alloy/latest/reference/components/otelcol.exporter.otlp" >}}) to send the traces to Grafana Cloud Tempo. |
There was a problem hiding this comment.
🚫 [doc-validator] reported by reviewdog 🐶
The link '{{< relref "/docs/alloy/latest/reference/components/otelcol.exporter.otlp" >}}' references a page in the project that does not exist.
Check if the page has moved within the repository.
Verify the link by building the docs locally using the make docs webserver.
docs/sources/tutorial/helm-alloy.md
Outdated
|
|
||
| The `output` section configures that Beyla component sends traces to `otelcol.exporter.otlp` component. The `otelcol.exporter.otlp` section configures the [OTLP exporter]({{< relref "/docs/alloy/latest/reference/components/otelcol.exporter.otlp" >}}) to send the traces to Grafana Cloud Tempo. | ||
|
|
||
| For further details on the configuration options, refer to the documentation of the [Grafana Alloy Beyla component]({{< relref "/docs/alloy/latest/reference/components/beyla.ebpf" >}}) |
There was a problem hiding this comment.
🚫 [doc-validator] reported by reviewdog 🐶
The link '{{< relref "/docs/alloy/latest/reference/components/beyla.ebpf" >}}' references a page in the project that does not exist.
Check if the page has moved within the repository.
Verify the link by building the docs locally using the make docs webserver.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #776 +/- ##
===========================================
- Coverage 76.39% 39.34% -37.06%
===========================================
Files 112 107 -5
Lines 9362 9280 -82
===========================================
- Hits 7152 3651 -3501
- Misses 1831 5422 +3591
+ Partials 379 207 -172
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
My only concern is that we should also add soon a Beyla Helm document (as soon as this PR gets merged grafana/helm-charts#3093 ). We should later discuss how to avoid generating confusion to the users between different helm charts. |
Agreed! We should document in a page the different deployment modes and their benefits. |
This tutorial explains how to run Beyla using Alloy's Helm
in a Kubernetes cluster.