diff --git a/README.md b/README.md index 2c3b590..074b892 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,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) -[![SDK](https://img.shields.io/badge/otel--sdk-1.7.0-blue?style=flat&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-dotnet) +[![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) @@ -21,7 +21,7 @@ This is a pre-configured and pre-packaged bundle of [OpenTelemetry .NET componen optimized for [Grafana Cloud Application Observability](https://grafana.com/docs/grafana-cloud/monitor-applications/application-observability/). It requires only minimal setup and configuration and makes it very easy to emit -OpenTelemetry traces, logs, and metrics from your .NET application. +OpenTelemetry metrics, logs, and traces from your .NET application. ## Getting Started @@ -39,7 +39,7 @@ dotnet add package --prerelease Grafana.OpenTelemetry The `UseGrafana` extension method on the `TracerProviderBuilder` or the `MetricProviderBuilder` can be used to set up the Grafana distribution. By -default, telemetry data will be sent to a Grafana agent or an OTel collector +default, telemetry data will be sent to Grafana Alloy or an OTel collector that runs locally and listens to default OTLP ports. ```csharp @@ -71,6 +71,7 @@ documents: * [Installation](./docs/installation.md) * [Configuration](./docs/configuration.md) * [Supported instrumentations](./docs/supported-instrumentations.md) +* [Migrating to upstream](./docs/migration.md) ## Troubleshooting diff --git a/docs/migration.md b/docs/migration.md index a1c7d14..8c676ff 100644 --- a/docs/migration.md +++ b/docs/migration.md @@ -5,8 +5,8 @@ installing and configuring upstream OpenTelemetry .NET packages. Follow these steps if you want to migrate from this distribution to the upstream OpenTelemetry .NET project. -- Replace all environment variables or web.config/app.config values with the -"grafana" prefix 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](https://grafana.com/docs/grafana-cloud/send-data/otlp/send-data-otlp/#push-directly-from-applications-using-the-opentelemetry-sdks) - Install and activate the OpenTelemetry SDK, as covered in the upstream [Getting Started](https://github.com/open-telemetry/opentelemetry-dotnet#getting-started) guide @@ -18,9 +18,7 @@ for details. The exporter will respect the previously set environment variables: - `OTEL_EXPORTER_OTLP_HEADERS` - Install and configure any desired instrumentation packages [listed here](./supported-instrumentations.md) -- Add `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable to opt-in to the -latest HTTP semantic conventions -- [Add the recommended OpenTelemetry resource attributes](https://grafana.com/docs/opentelemetry/instrumentation/configuration/resource-attributes/) +- [Add the OpenTelemetry resource attributes](https://grafana.com/docs/opentelemetry/instrumentation/configuration/resource-attributes/) via the `OTEL_RESOURCE_ATTRIBUTES` environment variable - `service.name` - `service.namespace` @@ -29,6 +27,5 @@ via the `OTEL_RESOURCE_ATTRIBUTES` environment variable - `deployment.environment` ```shell -export OTEL_SEMCONV_STABILITY_OPT_IN=http export OTEL_RESOURCE_ATTRIBUTES=service.instance.id=,deployment.environment=... ``` diff --git a/src/Grafana.OpenTelemetry.Base/ExporterSettings/AgentOtlpExporter.cs b/src/Grafana.OpenTelemetry.Base/ExporterSettings/AgentOtlpExporter.cs index a453fea..93beaee 100644 --- a/src/Grafana.OpenTelemetry.Base/ExporterSettings/AgentOtlpExporter.cs +++ b/src/Grafana.OpenTelemetry.Base/ExporterSettings/AgentOtlpExporter.cs @@ -12,12 +12,12 @@ namespace Grafana.OpenTelemetry { /// - /// Settings for exporting telemetry to a Grafana Agent or collector. + /// Settings for exporting telemetry to a Grafana Alloy or collector. /// public class AgentOtlpExporter : ExporterSettings { /// - /// Gets or sets the address of the Grafana Agent or collector. If not set, the OpenTelemetry + /// Gets or sets the address of the Grafana Alloy or collector. If not set, the OpenTelemetry /// default is used (`http://localhost:4817` for http/protobuf, and `http://localhost:4818` /// for grpc). /// diff --git a/src/Grafana.OpenTelemetry.Base/ExporterSettings/CloudOtlpExporter.cs b/src/Grafana.OpenTelemetry.Base/ExporterSettings/CloudOtlpExporter.cs index 997af1f..1c3677e 100644 --- a/src/Grafana.OpenTelemetry.Base/ExporterSettings/CloudOtlpExporter.cs +++ b/src/Grafana.OpenTelemetry.Base/ExporterSettings/CloudOtlpExporter.cs @@ -13,7 +13,7 @@ namespace Grafana.OpenTelemetry { /// - /// Settings for exporting telemetry directly to Grafana Agent via OTLP. + /// Settings for exporting telemetry directly to Grafana Alloy via OTLP. /// [Obsolete("This class is obsolete. Use OtlpExporter instead.")] public class CloudOtlpExporter : ExporterSettings