From c5730ef6f72e2c4c6adaba538b9b162bd92eb516 Mon Sep 17 00:00:00 2001 From: Sean Packham Date: Mon, 15 Jul 2024 13:34:27 +0100 Subject: [PATCH] Documentation to set up Asserts network (#1007) Co-authored-by: Mario Macias Co-authored-by: Goutham Veeramachaneni --- docs/sources/network/asserts.md | 64 +++++++++++++++++++++++++++++++++ docs/sources/network/config.md | 4 +-- 2 files changed, 66 insertions(+), 2 deletions(-) create mode 100644 docs/sources/network/asserts.md diff --git a/docs/sources/network/asserts.md b/docs/sources/network/asserts.md new file mode 100644 index 000000000..67a6d68ab --- /dev/null +++ b/docs/sources/network/asserts.md @@ -0,0 +1,64 @@ +--- +title: Set up Beyla network metrics in Kubernetes with Helm for Asserts +menuTitle: Set up Asserts network +description: A guide to install Beyla network metrics in Kubernetes with Helm for Asserts. +weight: 1 +keywords: + - Beyla + - eBPF + - Network +--- + +# Set up Beyla network metrics in Kubernetes with Helm for Asserts + +[Asserts](/docs/grafana-cloud/monitor-applications/asserts/) works with Beyla and requires Beyla network metrics. Learn how to set up Beyla network metrics in Kubernetes with Helm to export telemetry data to Asserts. + +To learn more about Beyla network metrics, consult the [Network](/docs/beyla/latest/network/) documentation. + +## Prerequisites + +Before you install Beyla network metrics and export telemetry data to Asserts you need: + +1. A free Grafana Cloud account. +1. Access rights to a Kubernetes cluster, enough to create components with privileges. + +You can register for a [free forever Grafana Cloud account](/auth/sign-up/create-user) in minutes and start sending telemetry data and monitoring your infrastructure and applications. + +There are two configuration options to collect metrics to send to Grafana Cloud for Asserts. First, through Kubernetes monitoring or alternatively with an OpenTelemetry Collector. + +## Configuration for Kubernetes monitoring + +If you use Kubernetes monitoring and a Helm chart for scraping metrics, create a `values.yml` with the following configuration: + +```yaml +preset: network + +podAnnotations: + k8s.grafana.com/scrape: true + k8s.grafana.com/job: beyla-network + k8s.grafana.com/metrics.portName: metrics +``` + +## Configure for OpenTelemetry Collector + +If you use an OpenTelemetry Collector for metrics collection, either Grafana Alloy the upstream collector, create a `values.yml` with the following configuration: + +```sh +preset: network + +env: + OTEL_EXPORTER_OTLP_ENDPOINT: your-otlp-endpoint:4318 +``` + +## Install and run Beyla network metrics for Asserts + +Run the following `helm` commands to add the `grafana` repository and install and run `beyla` with your configuration for network metrics: + +```sh +helm repo add grafana https://grafana.github.io/helm-charts +helm install beyla --create-namespace -n beyla -f values.yaml grafana/beyla +``` + +## Observe your services in Asserts + +Finally, navigate to Asserts in [Grafana Cloud](/auth/sign-in/) and view your instrumented services. diff --git a/docs/sources/network/config.md b/docs/sources/network/config.md index 254b923d5..dd3b7db49 100644 --- a/docs/sources/network/config.md +++ b/docs/sources/network/config.md @@ -2,7 +2,7 @@ title: Beyla Network Metrics configuration options menuTitle: Configuration description: Learn about the configuration options available for Beyla network metrics -weight: 2 +weight: 3 keywords: - Beyla - eBPF @@ -64,7 +64,7 @@ The available options are: `tc` and `socket_filter`. When `tc` is used as an event source, Beyla uses the Linux Traffic Control ingress and egress filters to capture the network events, in a direct action mode. This event source mode assumes -that no other eBPF programs are attaching to the same Linux Traffic Control interface, in +that no other eBPF programs are attaching to the same Linux Traffic Control interface, in direct action mode. For example, the Cilium Kubernetes CNI uses the same approach, therefore if you have Cilium CNI installed in your Kubernetes cluster, configure Beyla to capture the network events with the `socket_filter` mode.