Skip to content

Commit

Permalink
Documented Grafana OTLP credentials setup with new OpenTelemetry box (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
mariomac authored Dec 19, 2023
1 parent 7002516 commit fce0339
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
10 changes: 10 additions & 0 deletions docs/sources/configure/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions docs/sources/tutorial/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`)
Expand All @@ -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..."

Expand Down

0 comments on commit fce0339

Please sign in to comment.