From fce0339bf495475fc01f4240d21172b799cf062d Mon Sep 17 00:00:00 2001 From: Mario Macias Date: Tue, 19 Dec 2023 09:17:27 +0100 Subject: [PATCH] Documented Grafana OTLP credentials setup with new OpenTelemetry box (#509) --- docs/sources/configure/options.md | 10 ++++++++++ docs/sources/tutorial/index.md | 12 ++++++------ 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/docs/sources/configure/options.md b/docs/sources/configure/options.md index c776373f3..d64a21225 100644 --- a/docs/sources/configure/options.md +++ b/docs/sources/configure/options.md @@ -42,6 +42,8 @@ A quick description of the components: the incoming data will be directly forwarded to the next stage. - [Kubernetes decorator](#kubernetes-decorator) will decorate the metrics and traces with Kubernetes metadata of the instrumented Pods. +- [Grafana Cloud OTEL exporter for metrics and traces](#using-the-grafana-cloud-otel-endpoint-to-ingest-metrics-and-traces) + simplifies the submission of OpenTelemetry metrics and traces to Grafana cloud. - [OTEL metrics exporter](#otel-metrics-exporter) exports metrics data to an external [OpenTelemetry](https://opentelemetry.io/) metrics collector. - [OTEL traces exporter](#otel-traces-exporter) exports span data to an external @@ -536,6 +538,10 @@ document/d/*/edit ## OTEL metrics exporter +> ℹ️ If you plan to use Beyla to send metrics to Grafana Cloud, +> please check the [Grafana Cloud OTEL exporter for metrics and traces](#using-the-grafana-cloud-otel-endpoint-to-ingest-metrics-and-traces) +> section for easier configuration. + YAML section `otel_metrics_export`. This component exports OpenTelemetry metrics to a given endpoint. It will be enabled if @@ -668,6 +674,10 @@ conventions recommend a different set of bucket boundaries. ## OTEL traces exporter +> ℹ️ If you plan to use Beyla to send metrics to Grafana Cloud, +> please check the [Grafana Cloud OTEL exporter for metrics and traces](#using-the-grafana-cloud-otel-endpoint-to-ingest-metrics-and-traces) +> section for easier configuration. + YAML section `otel_traces_export`. This component exports OpenTelemetry traces to a given endpoint. It will be enabled if diff --git a/docs/sources/tutorial/index.md b/docs/sources/tutorial/index.md index cf69724d9..9699daed1 100644 --- a/docs/sources/tutorial/index.md +++ b/docs/sources/tutorial/index.md @@ -182,15 +182,15 @@ There are two ways to forward your OpenTelemetry traces to Grafana Cloud: ### Running Grafana Beyla with your Grafana Credentials -In your Grafana Cloud Portal, click on the "Details" button in the "Grafana" box. Next, -copy your Grafana Instance ID and Zone, as in the image below. +In your Grafana Cloud Portal, click on the "Details" button in the "OpenTelemetry" box. Next, +copy your Grafana OTLP Endpoint and Instance ID, as in the image below. -![](https://grafana.com/media/docs/grafana-cloud/beyla/tutorial/grafana-cloud-instance-id.png) +![](https://grafana.com/media/docs/grafana-cloud/beyla/tutorial/otlp-connection-details.png) -Also create a Grafana API Key with metrics push privileges. +Also generate a Password/API token with metrics push privileges. Now you can run Beyla by using the above information to set the -`GRAFANA_CLOUD_ZONE`, `GRAFANA_CLOUD_INSTANCE_ID` and `GRAFANA_CLOUD_API_KEY` +`OTEL_EXPORTER_OTLP_ENDPOINT`, `GRAFANA_CLOUD_INSTANCE_ID` and `GRAFANA_CLOUD_API_KEY` environment variables. The `GRAFANA_CLOUD_SUBMIT` environment variable (whose value defaults to `traces`) @@ -201,8 +201,8 @@ we will set `GRAFANA_CLOUD_SUBMIT=metrics`. For example: ```sh +export OTEL_EXPORTER_OTLP_ENDPOINT=https://otlp-gateway-prod-eu-west-0.grafana.net/otlp export GRAFANA_CLOUD_SUBMIT=metrics -export GRAFANA_CLOUD_ZONE=prod-eu-west-0 export GRAFANA_CLOUD_INSTANCE_ID=123456 export GRAFANA_CLOUD_API_KEY="your api key here..."