diff --git a/README.md b/README.md index 42ed102f..70bf5fea 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ [![Build](https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/unit-tests.yml/badge.svg?branch=main)](https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/unit-tests.yml) [![OATS](https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/oats.yml/badge.svg?branch=main)](https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/oats.yml) -[![Nuget](https://img.shields.io/nuget/v/Grafana.OpenTelemetry.svg)](https://www.nuget.org/profiles/Grafana) +[![NuGet](https://img.shields.io/nuget/v/Grafana.OpenTelemetry?logo=nuget&label=NuGet&color=blue)](https://www.nuget.org/profiles/Grafana) [![SDK](https://img.shields.io/badge/otel--sdk-1.9.0-blue?style=flat&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-dotnet) [![Slack](https://img.shields.io/badge/join%20slack-%23app--o11y-brightgreen.svg?logo=slack)](https://grafana.slack.com/archives/C05E87XRK3J) @@ -32,7 +32,7 @@ reference to the [`Grafana.OpenTelemetry`](https://www.nuget.org/packages/Grafan package to your project. ```sh -dotnet add package --prerelease Grafana.OpenTelemetry +dotnet add package Grafana.OpenTelemetry ``` ### Step 2: Enable the Grafana distribution at application startup diff --git a/docs/migration.md b/docs/migration.md index 8c676ff9..e75440b2 100644 --- a/docs/migration.md +++ b/docs/migration.md @@ -5,20 +5,19 @@ installing and configuring upstream OpenTelemetry .NET packages. Follow these steps if you want to migrate from this distribution to the upstream OpenTelemetry .NET project. -- Set appropriate environment variables or web.config/app.config values as -explained [here](https://grafana.com/docs/grafana-cloud/send-data/otlp/send-data-otlp/#push-directly-from-applications-using-the-opentelemetry-sdks) +- Set appropriate environment variables or `web.config`/`app.config` values as +explained here: [Send data to the Grafana Cloud OTLP endpoint][publish-otlp] - Install and activate the OpenTelemetry SDK, -as covered in the upstream [Getting Started](https://github.com/open-telemetry/opentelemetry-dotnet#getting-started) -guide +as covered in the upstream [Getting Started][getting-started] guide - Setup the OTLP exporter for metrics, logs, and traces - see the -[exporter README](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md) -for details. The exporter will respect the previously set environment variables: +[exporter README][exporter-readme] for details. The exporter will respect the +previously set environment variables: - `OTEL_EXPORTER_OTLP_PROTOCOL` - `OTEL_EXPORTER_OTLP_ENDPOINT` - `OTEL_EXPORTER_OTLP_HEADERS` - Install and configure any desired instrumentation packages -[listed here](./supported-instrumentations.md) -- [Add the OpenTelemetry resource attributes](https://grafana.com/docs/opentelemetry/instrumentation/configuration/resource-attributes/) + [listed here](./supported-instrumentations.md) +- [Add the OpenTelemetry resource attributes][resource-attributes] via the `OTEL_RESOURCE_ATTRIBUTES` environment variable - `service.name` - `service.namespace` @@ -29,3 +28,8 @@ via the `OTEL_RESOURCE_ATTRIBUTES` environment variable ```shell export OTEL_RESOURCE_ATTRIBUTES=service.instance.id=,deployment.environment=... ``` + +[exporter-readme]: https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md +[getting-started]: https://github.com/open-telemetry/opentelemetry-dotnet#getting-started +[publish-otlp]: https://grafana.com/docs/grafana-cloud/send-data/otlp/send-data-otlp/#quickstart-architecture +[resource-attributes]: https://grafana.com/docs/grafana-cloud/monitor-applications/application-observability/instrument/resource-attributes/