Skip to content

Commit 1de0ef3

Browse files
update naming (docs files)
1 parent 0a8dd2c commit 1de0ef3

File tree

3 files changed

+66
-64
lines changed

3 files changed

+66
-64
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
[![Pull Request Validation](https://github.com/elastic/elastic-otel-dotnet/actions/workflows/ci.yml/badge.svg)](https://github.com/elastic/elastic-otel-dotnet/actions/workflows/ci.yml)
22

3-
# Elastic Distribution for OpenTelemetry .NET
3+
# Elastic Distribution of OpenTelemetry .NET
44

55
> [!WARNING]
6-
> The Elastic Distribution for OpenTelemetry .NET is not yet recommended for production use. Functionality may be changed or removed in future releases. Alpha releases are not subject to the support SLA of official GA features.
6+
> The Elastic Distribution of OpenTelemetry .NET is not yet recommended for production use. Functionality may be changed or removed in future releases. Alpha releases are not subject to the support SLA of official GA features.
77
>
88
> We welcome your feedback! You can reach us by [opening a GitHub issue](https://github.com/elastic/elastic-otel-dotnet/issues) or starting a discussion thread on the [Elastic Discuss forum](https://discuss.elastic.co/tags/c/observability/apm/58/dotnet).
99
10-
The Elastic Distribution for OpenTelemetry .NET (the distro) provides a zero code change extension of the [OpenTelemetry SDK for .NET](https://opentelemetry.io/docs/languages/net). The distro makes it easier to get started using OpenTelemetry in your .NET applications through strictly OpenTelemetry native means, while also providing a smooth and rich out of the box experience with [Elastic Observability](https://www.elastic.co/observability). It's an explicit goal of this distribution to introduce **no new concepts** in addition to those defined by the wider OpenTelemetry community.
10+
The Elastic Distribution of OpenTelemetry .NET (EDOT .NET) provides a zero code change extension of the [OpenTelemetry SDK for .NET](https://opentelemetry.io/docs/languages/net). EDOT .NET makes it easier to get started using OpenTelemetry in your .NET applications through strictly OpenTelemetry native means, while also providing a smooth and rich out of the box experience with [Elastic Observability](https://www.elastic.co/observability). It's an explicit goal of this distribution to introduce **no new concepts** in addition to those defined by the wider OpenTelemetry community.
1111

1212
> [!NOTE]
1313
> For more details about OpenTelemetry distributions in general, visit the [OpenTelemetry documentation](https://opentelemetry.io/docs/concepts/distributions).
1414
15-
With the distro you have access to all the features of the OpenTelemetry SDK for .NET plus:
15+
With EDOT .NET you have access to all the features of the OpenTelemetry SDK for .NET plus:
1616

1717
* Access to SDK improvements and bug fixes contributed by the Elastic team _before_ the changes are available upstream in OpenTelemetry repositories.
1818
* Elastic-specific processors that ensure optimal compatibility when exporting OpenTelemetry signal data to an Elastic backend like an Elastic Observability deployment.
@@ -23,7 +23,7 @@ With the distro you have access to all the features of the OpenTelemetry SDK for
2323

2424
## Install
2525

26-
To get started with the Elastic Distribution for OpenTelemetry .NET, you must add the
26+
To get started with the Elastic Distribution of OpenTelemetry .NET, you must add the
2727
[`Elastic.OpenTelemetry`](https://www.nuget.org/packages/Elastic.OpenTelemetry)
2828
NuGet package to your project. This can be achieved by adding the package reference to your project file.
2929

@@ -41,7 +41,7 @@ NuGet package to your project. This can be achieved by adding the package refere
4141

4242
<!-- ## Getting started
4343
44-
As the distribution is a lightweight extension of the OpenTelemetry SDK, you should be broadly
44+
As EDOT .NET is a lightweight extension of the OpenTelemetry SDK, you should be broadly
4545
familiar with the OpenTelemetry SDK concepts and instrumenting applications using the Microsoft
4646
diagnostic APIs. If you are not, we recommend you read the
4747
[OpenTelemetry SDK documentation](https://opentelemetry.io/docs/languages/net) first.
@@ -63,25 +63,25 @@ Before continuing, ensure that you have a supported
6363
> **_NOTE:_** Replace the `<LATEST>` placeholder with the latest available package from
6464
[NuGet.org](https://www.nuget.org/packages/Elastic.OpenTelemetry).
6565
66-
After adding the package reference, you can start using the Elastic Distribution for OpenTelemetry .NET
67-
in your application. The distribution includes a transitive dependency on the OpenTelemetry SDK,
66+
After adding the package reference, you can start using the Elastic Distribution of OpenTelemetry .NET
67+
in your application. EDOT .NET includes a transitive dependency on the OpenTelemetry SDK,
6868
so you do not need to add the OpenTelemetry SDK package to your project, although doing so will
69-
cause no harm and may be used to opt into newer SDK versions before the Elastic Distribution for OpenTelemetry .NET
69+
cause no harm and may be used to opt into newer SDK versions before the Elastic Distribution of OpenTelemetry .NET
7070
references them.
7171
72-
The Elastic Distribution for OpenTelemetry .NET is designed to be easy to use and integrate into your
72+
The Elastic Distribution of OpenTelemetry .NET is designed to be easy to use and integrate into your
7373
applications. This includes applications which have previously used the OpenTelemetry SDK directly.
7474
In situations where the OpenTelemetry SDK is already used, the only required change is
7575
to add the [`Elastic.OpenTelemetry`](https://www.nuget.org/packages/Elastic.OpenTelemetry) NuGet
7676
package to the project. Doing so will automatically switch to the opinionated configuration provided
77-
by the Elastic Distribution for OpenTelemetry .NET.
77+
by the Elastic Distribution of OpenTelemetry .NET.
7878
7979
### ASP.NET Core usage
8080
8181
A common requirement is to instrument ASP.NET Core applications based on the `Microsoft.Extensions.Hosting`
8282
libraries which provide dependency injection via an `IServiceProvider`.
8383
84-
The OpenTelemetry SDK and the Elastic Distribution for OpenTelemetry .NET provide extension methods to enable observability
84+
The OpenTelemetry SDK and the Elastic Distribution of OpenTelemetry .NET provide extension methods to enable observability
8585
features in your application by adding a few lines of code.
8686
8787
In this section, we'll focus on instrumenting an ASP.NET Core minimal API application using the Elastic
@@ -101,7 +101,7 @@ NuGet package to your project:
101101
102102
This package includes instrumentation to collect traces for requests handled by ASP.NET Core endpoints.
103103
104-
> **_NOTE:_** The ASP.NET Core instrumentation is not included by default in the Elastic Distribution for OpenTelemetry .NET.
104+
> **_NOTE:_** The ASP.NET Core instrumentation is not included by default in the Elastic Distribution of OpenTelemetry .NET.
105105
As with all optional instrumentation libraries, you can choose to include them in your application by
106106
adding a suitable package reference.
107107
@@ -113,7 +113,7 @@ using OpenTelemetry.Trace;
113113
```
114114
115115
The OpenTelemetry SDK provides extension methods on the `IServiceCollection` to support enabling the
116-
providers and configuring the SDK. The Elastic Distribution for OpenTelemetry .NET overrides the default SDK registration,
116+
providers and configuring the SDK. The Elastic Distribution of OpenTelemetry .NET overrides the default SDK registration,
117117
adding several opinionated defaults.
118118
119119
In the minimal API template, the `WebApplicationBuilder` exposes a `Services` property that can be used
@@ -133,12 +133,12 @@ injection container. This is NOT required to enable OpenTelemetry, but the examp
133133
send an HTTP request.
134134
135135
<2> The `AddOpenTelemetry` method registers the OpenTelemetry SDK with the dependency injection
136-
container. When available, the Elastic Distribution for OpenTelemetry .NET will override this to add opinionated defaults.
136+
container. When available, the Elastic Distribution of OpenTelemetry .NET will override this to add opinionated defaults.
137137
138138
<3> Configure tracing to instrument requests handled by ASP.NET Core.
139139
140140
With these limited changes to the `Program.cs` file, the application is now configured to use the
141-
OpenTelemetry SDK and the Elastic Distribution for OpenTelemetry .NET to collect traces and metrics, which are exported via
141+
OpenTelemetry SDK and the Elastic Distribution of OpenTelemetry .NET to collect traces and metrics, which are exported via
142142
OTLP.
143143
144144
To demonstrate the tracing capabilities, add a simple endpoint to the application:
@@ -157,7 +157,7 @@ app.MapGet("/", async (IHttpClientFactory httpClientFactory) =>
157157
```
158158
<1> Using this URL will require two redirects, allowing us to see multiple spans in the trace.
159159
160-
The Elastic Distribution for OpenTelemetry .NET will automatically enable the exporting of signals via the OTLP exporter. This
160+
The Elastic Distribution of OpenTelemetry .NET will automatically enable the exporting of signals via the OTLP exporter. This
161161
exporter requires that endpoint(s) are configured. A common mechanism for configuring endpoints is
162162
via environment variables.
163163

docs/configure.md

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Assumptions we're comfortable making about the reader:
99

1010
# Configure
1111

12+
Configure the Elastic Distribution of OpenTelemetry .NET (EDOT .NET) to send data to Elastic.
13+
1214
<!-- ✅ How users set configuration options -->
1315
## Configuration methods
1416

@@ -17,7 +19,7 @@ including:
1719

1820
* Setting [environment variables](#environment-variables)
1921
* Using the [`IConfiguration` integration](#iconfiguration-integration)
20-
* [Manually configuring](#manual-configuration) the Elastic distribution
22+
* [Manually configuring](#manual-configuration) EDOT .NET
2123

2224
<!-- Order of precedence -->
2325
Configuration options set manually in the code take precedence over environment variables, and
@@ -26,18 +28,18 @@ environment variables take precedence over configuration options set using the `
2628
### Environment variables
2729

2830
<!-- ✅ What and why -->
29-
The distro can be configured using environment variables.
30-
This is a cross-platform way to configure the distro and is especially useful in containerized environments.
31+
EDOT .NET can be configured using environment variables.
32+
This is a cross-platform way to configure EDOT .NET and is especially useful in containerized environments.
3133

3234
<!-- ✅ How -->
33-
Environment variables are read at startup and can be used to configure the Elastic distribution.
35+
Environment variables are read at startup and can be used to configure EDOT .NET.
3436
For details of the various options available and their corresponding environment variable names,
3537
see [Configuration options](#configuration-options)
3638

3739
### `IConfiguration` integration
3840

3941
<!-- ✅ What and why -->
40-
In applications that use the "host" pattern, such as ASP.NET Core and worker service, the distro
42+
In applications that use the "host" pattern, such as ASP.NET Core and worker service, EDOT .NET
4143
can be configured using the `IConfiguration` integration.
4244

4345
<!-- ✅ How -->
@@ -55,10 +57,10 @@ var currentConfig = builder.Configuration;
5557

5658
By default, at this stage, the configuration will be populated from the default configuration sources,
5759
including the `appsettings.json` file(s) and command-line arguments. You may use these sources to define
58-
the configuration for the Elastic Distribution for OpenTelemetry .NET.
60+
the configuration for the Elastic Distribution of OpenTelemetry .NET.
5961

6062
<!-- ✅ Example -->
61-
For example, you can define the configuration for the Elastic Distribution for OpenTelemetry .NET in the `appsettings.json` file:
63+
For example, you can define the configuration for the Elastic Distribution of OpenTelemetry .NET in the `appsettings.json` file:
6264

6365
```json
6466
{
@@ -74,23 +76,23 @@ For example, you can define the configuration for the Elastic Distribution for O
7476
> This example sets the file log directory to `C:\Logs` which enables diagnostic file logging.
7577
7678
Configuration from the "Elastic:OpenTelemetry" section of the `IConfiguration` instance will be
77-
bound to the `ElasticOpenTelemetryOptions` instance used to configure the Elastic distribution.
79+
bound to the `ElasticOpenTelemetryOptions` instance used to configure EDOT .NET.
7880

7981
To learn more about the Microsoft configuration system, see
8082
[Configuration in ASP.NET Core](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/configuration).
8183

8284
### Manual configuration
8385

8486
<!-- ✅ What and why -->
85-
In all other scenarios, you can configure the distro manually in code.
87+
In all other scenarios, you can configure EDOT .NET manually in code.
8688

8789
<!-- ✅ How -->
8890
Create an instance of `ElasticOpenTelemetryBuilderOptions` and pass it to the `ElasticOpenTelemetryBuilder`
8991
constructor or an overload of the `AddElasticOpenTelemetry` extension method on the `IServiceCollection`.
9092

9193
<!-- ✅ Example -->
9294
For example, in traditional console applications, you can configure the
93-
Elastic Distribution for OpenTelemetry .NET like this:
95+
Elastic Distribution of OpenTelemetry .NET like this:
9496

9597
```csharp
9698
using Elastic.OpenTelemetry;
@@ -115,7 +117,7 @@ var builderOptions = new ElasticOpenTelemetryBuilderOptions
115117
};
116118

117119
// Pass the `ElasticOpenTelemetryBuilderOptions` instance to the
118-
// `ElasticOpenTelemetryBuilder` constructor to configure the distro.
120+
// `ElasticOpenTelemetryBuilder` constructor to configure EDOT .NET.
119121
await using var session = new ElasticOpenTelemetryBuilder(builderOptions)
120122
.WithTracing(b => b.AddSource("MySource"))
121123
.Build();
@@ -124,25 +126,25 @@ await using var session = new ElasticOpenTelemetryBuilder(builderOptions)
124126
<!-- ✅ List all available configuration options -->
125127
## Configuration options
126128

127-
Because the Elastic Distribution for OpenTelemetry .NET ("the distro") is an extension of the [OpenTelemetry .NET agent](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation), it supports both:
129+
Because the Elastic Distribution of OpenTelemetry .NET (EDOT .NET) is an extension of the [OpenTelemetry .NET agent](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation), it supports both:
128130

129131
* General OpenTelemetry SDK configuration options
130-
* Elastic-specific configuration options that are only available when using the distro
132+
* Elastic-specific configuration options that are only available when using EDOT .NET
131133

132134
### OpenTelemetry SDK configuration options
133135

134-
The distro supports all configuration options listed in the [OpenTelemetry General SDK Configuration documentation](https://opentelemetry.io/docs/languages/sdk-configuration/general/).
136+
EDOT .NET supports all configuration options listed in the [OpenTelemetry General SDK Configuration documentation](https://opentelemetry.io/docs/languages/sdk-configuration/general/).
135137

136138
### Elastic-specific configuration options
137139

138-
The distro supports the following Elastic-specific options.
140+
EDOT .NET supports the following Elastic-specific options.
139141

140142
#### `FileLogDirectory`
141143

142144
* _Type_: String
143145
* _Default_: `string.Empty`
144146

145-
A string specifying the directory where the Elastic Distribution for OpenTelemetry .NET will write diagnostic log files.
147+
A string specifying the directory where the Elastic Distribution of OpenTelemetry .NET will write diagnostic log files.
146148
When not provided, no file logging will occur. Each new .NET process will create a new log file in the
147149
specified directory.
148150

@@ -156,7 +158,7 @@ specified directory.
156158
* _Type_: String
157159
* _Default_: `Information`
158160

159-
Sets the logging level for the distribution.
161+
Sets the logging level for EDOT .NET.
160162

161163
Valid options: `Critical`, `Error`, `Warning`, `Information`, `Debug`, `Trace` and `None` (`None` disables the logging).
162164

@@ -170,7 +172,7 @@ Valid options: `Critical`, `Error`, `Warning`, `Information`, `Debug`, `Trace` a
170172
* _Type_: Bool
171173
* _Default_: `false`
172174

173-
Allows the distribution to used with its defaults, but without enabling the export of telemetry data to
175+
Allows EDOT .NET to used with its defaults, but without enabling the export of telemetry data to
174176
an OTLP endpoint. This can be useful when you want to test applications without sending telemetry data.
175177

176178
| Configuration method | Key |
@@ -184,21 +186,21 @@ an OTLP endpoint. This can be useful when you want to test applications without
184186
* _Default_: `string.Empty`
185187

186188
A comma-separated list of Elastic defaults to enable. This can be useful when you want to enable
187-
only some of the Elastic Distribution for OpenTelemetry .NET opinionated defaults.
189+
only some of the Elastic Distribution of OpenTelemetry .NET opinionated defaults.
188190

189191
Valid options: `None`, `Traces`, `Metrics`, `Logs`, `All`.
190192

191193
Except for the `None` option, all other options can be combined.
192194

193-
When this setting is not configured or the value is `string.Empty`, all Elastic Distribution for OpenTelemetry .NET defaults will be enabled.
195+
When this setting is not configured or the value is `string.Empty`, all Elastic Distribution of OpenTelemetry .NET defaults will be enabled.
194196

195-
When `None` is specified, no Elastic Distribution for OpenTelemetry .NET defaults will be enabled, and you will need to manually
196-
configure the OpenTelemetry SDK to enable collection of telemetry signals. In this mode, the Elastic distribution
197+
When `None` is specified, no Elastic Distribution of OpenTelemetry .NET defaults will be enabled, and you will need to manually
198+
configure the OpenTelemetry SDK to enable collection of telemetry signals. In this mode, EDOT .NET
197199
does not provide any opinionated defaults, nor register any processors, allowing you to start with the "vanilla"
198200
OpenTelemetry SDK configuration. You may then choose to configure the various providers and register processors
199201
as required.
200202

201-
In all other cases, the Elastic Distribution for OpenTelemetry .NET will enable the specified defaults. For example, to enable only
203+
In all other cases, the Elastic Distribution of OpenTelemetry .NET will enable the specified defaults. For example, to enable only
202204
Elastic defaults only for tracing and metrics, set this value to `Traces,Metrics`.
203205

204206
| Configuration method | Key |
@@ -238,7 +240,7 @@ export OTEL_EXPORTER_OTLP_HEADERS="Authorization=ApiKey TkpXUkx...dVZGQQ=="
238240

239241
<!-- ✅ What is this -->
240242
<!-- ✅ Why use this -->
241-
[Secret tokens](https://www.elastic.co/guide/en/observability/current/apm-secret-token.html) are used to authorize requests to the APM Server. Both the distro and APM Server must be configured with the same secret token for the request to be accepted.
243+
[Secret tokens](https://www.elastic.co/guide/en/observability/current/apm-secret-token.html) are used to authorize requests to the APM Server. Both EDOT .NET and APM Server must be configured with the same secret token for the request to be accepted.
242244

243245
<!-- ✅ How do you authenticate using this method? -->
244246
You can find the values of these variables in Kibana's APM tutorial.

0 commit comments

Comments
 (0)