Skip to content

Commit 28507be

Browse files
authored
Doc updates (#109)
1 parent f25b01f commit 28507be

File tree

4 files changed

+10
-12
lines changed

4 files changed

+10
-12
lines changed

README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
[![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)
1212
[![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)
1313
[![Nuget](https://img.shields.io/nuget/v/Grafana.OpenTelemetry.svg)](https://www.nuget.org/profiles/Grafana)
14-
[![SDK](https://img.shields.io/badge/otel--sdk-1.7.0-blue?style=flat&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-dotnet)
14+
[![SDK](https://img.shields.io/badge/otel--sdk-1.9.0-blue?style=flat&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-dotnet)
1515
[![Slack](https://img.shields.io/badge/join%20slack-%23app--o11y-brightgreen.svg?logo=slack)](https://grafana.slack.com/archives/C05E87XRK3J)
1616
<!-- markdown-link-check-enable -->
1717

@@ -21,7 +21,7 @@ This is a pre-configured and pre-packaged bundle of [OpenTelemetry .NET componen
2121
optimized for [Grafana Cloud Application Observability](https://grafana.com/docs/grafana-cloud/monitor-applications/application-observability/).
2222

2323
It requires only minimal setup and configuration and makes it very easy to emit
24-
OpenTelemetry traces, logs, and metrics from your .NET application.
24+
OpenTelemetry metrics, logs, and traces from your .NET application.
2525

2626
## Getting Started
2727

@@ -39,7 +39,7 @@ dotnet add package --prerelease Grafana.OpenTelemetry
3939

4040
The `UseGrafana` extension method on the `TracerProviderBuilder` or the
4141
`MetricProviderBuilder` can be used to set up the Grafana distribution. By
42-
default, telemetry data will be sent to a Grafana agent or an OTel collector
42+
default, telemetry data will be sent to Grafana Alloy or an OTel collector
4343
that runs locally and listens to default OTLP ports.
4444

4545
```csharp
@@ -71,6 +71,7 @@ documents:
7171
* [Installation](./docs/installation.md)
7272
* [Configuration](./docs/configuration.md)
7373
* [Supported instrumentations](./docs/supported-instrumentations.md)
74+
* [Migrating to upstream](./docs/migration.md)
7475

7576
## Troubleshooting
7677

docs/migration.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ installing and configuring upstream OpenTelemetry .NET packages. Follow these
55
steps if you want to migrate from this distribution to the upstream
66
OpenTelemetry .NET project.
77

8-
- Replace all environment variables or web.config/app.config values with the
9-
"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)
8+
- Set appropriate environment variables or web.config/app.config values as
9+
explained [here](https://grafana.com/docs/grafana-cloud/send-data/otlp/send-data-otlp/#push-directly-from-applications-using-the-opentelemetry-sdks)
1010
- Install and activate the OpenTelemetry SDK,
1111
as covered in the upstream [Getting Started](https://github.com/open-telemetry/opentelemetry-dotnet#getting-started)
1212
guide
@@ -18,9 +18,7 @@ for details. The exporter will respect the previously set environment variables:
1818
- `OTEL_EXPORTER_OTLP_HEADERS`
1919
- Install and configure any desired instrumentation packages
2020
[listed here](./supported-instrumentations.md)
21-
- Add `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable to opt-in to the
22-
latest HTTP semantic conventions
23-
- [Add the recommended OpenTelemetry resource attributes](https://grafana.com/docs/opentelemetry/instrumentation/configuration/resource-attributes/)
21+
- [Add the OpenTelemetry resource attributes](https://grafana.com/docs/opentelemetry/instrumentation/configuration/resource-attributes/)
2422
via the `OTEL_RESOURCE_ATTRIBUTES` environment variable
2523
- `service.name`
2624
- `service.namespace`
@@ -29,6 +27,5 @@ via the `OTEL_RESOURCE_ATTRIBUTES` environment variable
2927
- `deployment.environment`
3028

3129
```shell
32-
export OTEL_SEMCONV_STABILITY_OPT_IN=http
3330
export OTEL_RESOURCE_ATTRIBUTES=service.instance.id=<pod123>,deployment.environment=...
3431
```

src/Grafana.OpenTelemetry.Base/ExporterSettings/AgentOtlpExporter.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212
namespace Grafana.OpenTelemetry
1313
{
1414
/// <summary>
15-
/// Settings for exporting telemetry to a Grafana Agent or collector.
15+
/// Settings for exporting telemetry to a Grafana Alloy or collector.
1616
/// </summary>
1717
public class AgentOtlpExporter : ExporterSettings
1818
{
1919
/// <summary>
20-
/// Gets or sets the address of the Grafana Agent or collector. If not set, the OpenTelemetry
20+
/// Gets or sets the address of the Grafana Alloy or collector. If not set, the OpenTelemetry
2121
/// default is used (`http://localhost:4817` for http/protobuf, and `http://localhost:4818`
2222
/// for grpc).
2323
/// </summary>

src/Grafana.OpenTelemetry.Base/ExporterSettings/CloudOtlpExporter.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
namespace Grafana.OpenTelemetry
1414
{
1515
/// <summary>
16-
/// Settings for exporting telemetry directly to Grafana Agent via OTLP.
16+
/// Settings for exporting telemetry directly to Grafana Alloy via OTLP.
1717
/// </summary>
1818
[Obsolete("This class is obsolete. Use OtlpExporter instead.")]
1919
public class CloudOtlpExporter : ExporterSettings

0 commit comments

Comments
 (0)