Skip to content

Commit 7d9efb1

Browse files
committed
fix #115 ensure the branding matches OpenTelemetry requirements
1 parent 2adf5c7 commit 7d9efb1

13 files changed

+51
-51
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
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 OpenTelemetry .NET Distribution
3+
# Elastic Distribution for OpenTelemetry .NET
44

5-
The Elastic OpenTelemetry .NET Distribution provides a zero code change extension
5+
The Elastic Distribution for OpenTelemetry .NET provides a zero code change extension
66
to [OpenTelemetry SDK for .NET](https://opentelemetry.io/docs/languages/net). These extensions ensure
77
a smooth and rich out of the box experience with [Elastic Observability](https://www.elastic.co/observability)
88
through strictly OpenTelemetry native means.
99

1010
This ensures there are no new concepts to learn with the full OpenTelemetry ecosystem remains at ones
1111
fingertips. Read more about the concept of [OpenTelemetry Distributions](https://opentelemetry.io/docs/concepts/distributions).
1212

13-
The Elastic distribution includes some Elastic-specific processors to ensure the best
13+
The Elastic Distribution for OpenTelemetry .NET includes some Elastic-specific processors to ensure the best
1414
compatibility when exporting OpenTelemetry signal data [Elastic Observability](https://www.elastic.co/observability).
1515
The distribution also preconfigures the collection of tracing, metrics and logs signals, applying
1616
some opinionated defaults, such as which sources are collected by default. The distribution also
1717
ensures that the OTLP exporter is enabled by default.
1818

19-
> **_IMPORTANT:_** The Elastic distribution is currently in early alpha release status. It is not yet feature
20-
complete and may contain bugs. We are actively working on improving the distribution and
19+
> **_IMPORTANT:_** The Elastic Distribution for OpenTelemetry .NET is currently in early alpha release status.
20+
> It is not yet feature complete and may contain bugs. We are actively working on improving the distribution and
2121
adding new features.
2222
>
2323
> If you would like to experience the alpha and help us improve the distribution by providing
@@ -40,7 +40,7 @@ Before continuing, ensure that you have a supported
4040

4141
### Installation
4242

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

@@ -50,25 +50,25 @@ NuGet package to your project. This can be achieved by adding the package refere
5050
> **_NOTE:_** Replace the `<LATEST>` placeholder with the latest available package from
5151
[NuGet.org](https://www.nuget.org/packages/Elastic.OpenTelemetry).
5252

53-
After adding the package reference, you can start using the Elastic OpenTelemetry distribution
53+
After adding the package reference, you can start using the Elastic Distribution for OpenTelemetry .NET
5454
in your application. The distribution includes a transitive dependency on the OpenTelemetry SDK,
5555
so you do not need to add the OpenTelemetry SDK package to your project, although doing so will
56-
cause no harm and may be used to opt into newer SDK versions before the Elastic distribution
56+
cause no harm and may be used to opt into newer SDK versions before the Elastic Distribution for OpenTelemetry .NET
5757
references them.
5858

59-
The Elastic OpenTelemetry distribution is designed to be easy to use and integrate into your
59+
The Elastic Distribution for OpenTelemetry .NET is designed to be easy to use and integrate into your
6060
applications. This includes applications which have previously used the OpenTelemetry SDK directly.
6161
In situations where the OpenTelemetry SDK is already used, the only required change is
6262
to add the [`Elastic.OpenTelemetry`](https://www.nuget.org/packages/Elastic.OpenTelemetry) NuGet
6363
package to the project. Doing so will automatically switch to the opinionated configuration provided
64-
by the Elastic distribution.
64+
by the Elastic Distribution for OpenTelemetry .NET.
6565

6666
### ASP.NET Core usage
6767

6868
A common requirement is to instrument ASP.NET Core applications based on the `Microsoft.Extensions.Hosting`
6969
libraries which provide dependency injection via an `IServiceProvider`.
7070

71-
The OpenTelemetry SDK and the Elastic distribution provide extension methods to enable observability
71+
The OpenTelemetry SDK and the Elastic Distribution for OpenTelemetry .NET provide extension methods to enable observability
7272
features in your application by adding a few lines of code.
7373

7474
In this section, we'll focus on instrumenting an ASP.NET Core minimal API application using the Elastic
@@ -88,7 +88,7 @@ NuGet package to your project:
8888
8989
This package includes instrumentation to collect traces for requests handled by ASP.NET Core endpoints.
9090

91-
> **_NOTE:_** The ASP.NET Core instrumentation is not included by default in the Elastic OpenTelemetry distribution.
91+
> **_NOTE:_** The ASP.NET Core instrumentation is not included by default in the Elastic Distribution for OpenTelemetry .NET.
9292
As with all optional instrumentation libraries, you can choose to include them in your application by
9393
adding a suitable package reference.
9494

@@ -100,7 +100,7 @@ using OpenTelemetry.Trace;
100100
```
101101

102102
The OpenTelemetry SDK provides extension methods on the `IServiceCollection` to support enabling the
103-
providers and configuring the SDK. The Elastic distribution overrides the default SDK registration,
103+
providers and configuring the SDK. The Elastic Distribution for OpenTelemetry .NET overrides the default SDK registration,
104104
adding several opinionated defaults.
105105

106106
In the minimal API template, the `WebApplicationBuilder` exposes a `Services` property that can be used
@@ -120,12 +120,12 @@ injection container. This is NOT required to enable OpenTelemetry, but the examp
120120
send an HTTP request.
121121

122122
<2> The `AddOpenTelemetry` method registers the OpenTelemetry SDK with the dependency injection
123-
container. When available, the Elastic distribution will override this to add opinionated defaults.
123+
container. When available, the Elastic Distribution for OpenTelemetry .NET will override this to add opinionated defaults.
124124

125125
<3> Configure tracing to instrument requests handled by ASP.NET Core.
126126

127127
With these limited changes to the `Program.cs` file, the application is now configured to use the
128-
OpenTelemetry SDK and the Elastic distribution to collect traces and metrics, which are exported via
128+
OpenTelemetry SDK and the Elastic Distribution for OpenTelemetry .NET to collect traces and metrics, which are exported via
129129
OTLP.
130130

131131
To demonstrate the tracing capabilities, add a simple endpoint to the application:
@@ -144,7 +144,7 @@ app.MapGet("/", async (IHttpClientFactory httpClientFactory) =>
144144
```
145145
<1> Using this URL will require two redirects, allowing us to see multiple spans in the trace.
146146

147-
The Elastic distribution will automatically enable the exporting of signals via the OTLP exporter. This
147+
The Elastic Distribution for OpenTelemetry .NET will automatically enable the exporting of signals via the OTLP exporter. This
148148
exporter requires that endpoint(s) are configured. A common mechanism for configuring endpoints is
149149
via environment variables.
150150

docs/configure.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ title: Configure
66
Configuration of the OpenTelemetry SDK should be performed through the
77
mechanisms [documented on the OpenTelemetry website](https://opentelemetry.io/docs/languages/net/automatic/configuration/).
88

9-
The Elastic distribution can be further configured using advanced settings when
9+
The Elastic Distribution for OpenTelemetry .NET can be further configured using advanced settings when
1010
you need complete control of its behaviour. Configuration can be achieved by setting environment variables,
1111
using the `IConfiguration` integration, or manually configuring the Elastic distribution.
1212

1313
## Environment variables
1414

15-
The Elastic distribution can be configured using environment variables. This is a cross-platform
16-
way to configure the Elastic distribution and is especially useful in containerized environments.
15+
The Elastic Distribution for OpenTelemetry .NET can be configured using environment variables. This is a cross-platform
16+
way to configure the Elastic Distribution for OpenTelemetry .NET and is especially useful in containerized environments.
1717

1818
Environment variables are read at startup and can be used to configure the Elastic distribution.
1919
For details of the various options available and their corresponding environment variable names,
@@ -39,9 +39,9 @@ var currentConfig = builder.Configuration; [^1]
3939

4040
By default, at this stage, the configuration will be populated from the default configuration sources,
4141
including the `appsettings.json` file(s) and command-line arguments. You may use these sources to define
42-
the configuration for the Elastic distribution.
42+
the configuration for the Elastic Distribution for OpenTelemetry .NET.
4343

44-
For example, you can define the configuration for the Elastic distribution in the `appsettings.json` file:
44+
For example, you can define the configuration for the Elastic Distribution for OpenTelemetry .NET in the `appsettings.json` file:
4545

4646
```json
4747
{
@@ -66,7 +66,7 @@ In all other scenarios, configuration can be achieved manually in code. This is
6666
an instance of `ElasticOpenTelemetryBuilderOptions` and passing it to the `ElasticOpenTelemetryBuilder` constructor
6767
or an overload of the `AddElasticOpenTelemetry` extension method on the `IServiceCollection`.
6868

69-
For example, in traditional console applications, you can configure the Elastic distribution like this:
69+
For example, in traditional console applications, you can configure the Elastic Distribution for OpenTelemetry .NET like this:
7070

7171
```csharp
7272
using Elastic.OpenTelemetry;
@@ -94,13 +94,13 @@ await using var session = new ElasticOpenTelemetryBuilder(builderOptions) [^4]
9494
setting the corresponding property.
9595
[^3]: This example sets the file log directory to `C:\Logs` which enables diagnostic file logging.
9696
[^4]: Pass the `ElasticOpenTelemetryBuilderOptions` instance to the `ElasticOpenTelemetryBuilder` constructor
97-
to configure the Elastic distribution.
97+
to configure the Elastic Distribution for OpenTelemetry .NET.
9898

9999
## Configuration options
100100

101101
### `FileLogDirectory`
102102

103-
A string specifying the directory where the Elastic distribution will write diagnostic log files.
103+
A string specifying the directory where the Elastic Distribution for OpenTelemetry .NET will write diagnostic log files.
104104
When not provided, no file logging will occur. Each new .NET process will create a new log file in the
105105
specified directory.
106106

@@ -144,21 +144,21 @@ an OTLP endpoint. This can be useful when you want to test applications without
144144
### `EnabledElasticDefaults`
145145

146146
A comma-separated list of Elastic defaults to enable. This can be useful when you want to enable
147-
only some of the Elastic distribution opinionated defaults.
147+
only some of the Elastic Distribution for OpenTelemetry .NET opinionated defaults.
148148

149149
Valid options: `None`, `Tracing`, `Metrics`, `Logging`.
150150

151151
Except for the `None` option, all other options can be combined.
152152

153-
When this setting is not configured or the value is `string.Empty`, all Elastic distribution defaults will be enabled.
153+
When this setting is not configured or the value is `string.Empty`, all Elastic Distribution for OpenTelemetry .NET defaults will be enabled.
154154

155-
When `None` is specified, no Elastic distribution defaults will be enabled, and you will need to manually
155+
When `None` is specified, no Elastic Distribution for OpenTelemetry .NET defaults will be enabled, and you will need to manually
156156
configure the OpenTelemetry SDK to enable collection of telemetry signals. In this mode, the Elastic distribution
157157
does not provide any opinionated defaults, nor register any processors, allowing you to start with the "vanilla"
158158
OpenTelemetry SDK configuration. You may then choose to configure the various providers and register processors
159159
as required.
160160

161-
In all other cases, the Elastic distribution will enable the specified defaults. For example, to enable only
161+
In all other cases, the Elastic Distribution for OpenTelemetry .NET will enable the specified defaults. For example, to enable only
162162
Elastic defaults only for tracing and metrics, set this value to `Tracing,Metrics`.
163163

164164
| Environment variable name | IConfiguration key |

docs/elastic-otel-dotnet.docnav.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"id": "elastic-otel-dotnet",
44
"landingPageSlug": "/otel-dotnet/intro",
55
"icon": "logoObservability",
6-
"description": "Elastic OpenTelemetry Distribution for .NET",
6+
"description": "Elastic Distribution for OpenTelemetry .NET",
77
"items": [
88
{
99
"label": "Get started",

docs/get-started.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,17 @@ https://dotnet.microsoft.com/en-us/download/dotnet[.NET SDK version] installed l
2727

2828
## Installation
2929

30-
To get started with the Elastic OpenTelemetry distribution, you must add the Elastic OpenTelemetry
30+
To get started with the Elastic OpenTelemetry Distribution for .NET, you must add the `Elastic.OpenTelemetry`
3131
NuGet package to your project. This can be achieved by adding the package reference to your project file.
3232

3333
```xml
3434
<PackageReference Include="Elastic.OpenTelemetry" Version="0.1.0-alpha.1" />
3535
```
3636

37-
After adding the package reference, you can start using the Elastic OpenTelemetry distribution
37+
After adding the package reference, you can start using the Elastic OpenTelemetry Distribution for .NET
3838
in your application. The distribution includes a transitive dependency on the OpenTelemetry SDK,
3939
so you do not need to add the OpenTelemetry SDK package to your project, although doing so will
40-
cause no harm and may be used to opt into newer SDK versions before the Elastic distribution
40+
cause no harm and may be used to opt into newer SDK versions before the Elastic OpenTelemetry Distribution for .NET
4141
references them.
4242

4343
The Elastic OpenTelemetry distribution is designed to be easy to use and integrate into your
@@ -51,7 +51,7 @@ switch to the opinionated configuration provided by the Elastic distribution.
5151
A common requirement is to instrument ASP.NET Core applications based on the `Microsoft.Extensions.Hosting`
5252
libraries which provide dependency injection via an `IServiceProvider`.
5353

54-
The OpenTelemetry SDK and the Elastic distribution provide extension methods to enable observability
54+
The OpenTelemetry SDK and the Elastic Distribution for OpenTelemetry .NET provide extension methods to enable observability
5555
features in your application by adding a few lines of code.
5656

5757
In this section, we'll focus on instrumenting an ASP.NET Core minimal API application using the Elastic
@@ -73,7 +73,7 @@ NuGet package to your project:
7373
This package includes instrumentation to collect traces for requests handled by ASP.NET Core endpoints.
7474

7575
<DocCallOut title="Note">
76-
The ASP.NET Core instrumentation is not included by default in the Elastic OpenTelemetry distribution.
76+
The ASP.NET Core instrumentation is not included by default in the Elastic Distribution for OpenTelemetry .NET.
7777
As with all optional instrumentation libraries, you can choose to include them in your application by
7878
adding a suitable package reference.
7979
</DocCallOut>
@@ -86,7 +86,7 @@ using OpenTelemetry.Trace;
8686
```
8787

8888
The OpenTelemetry SDK provides extension methods on the `IServiceCollection` to support enabling the
89-
providers and configuring the SDK. The Elastic distribution overrides the default SDK registration,
89+
providers and configuring the SDK. The Elastic Distribution for OpenTelemetry .NET overrides the default SDK registration,
9090
adding several opinionated defaults.
9191

9292
In the minimal API template, the `WebApplicationBuilder` exposes a `Services` property that can be used
@@ -105,11 +105,11 @@ builder.Services
105105
injection container. This is NOT required to enable OpenTelemetry, but the example endpoint will use it to
106106
send an HTTP request.
107107
[^2]: The `AddOpenTelemetry` method registers the OpenTelemetry SDK with the dependency injection
108-
container. When available, the Elastic distribution will override this to add opinionated defaults.
108+
container. When available, the Elastic Distribution for OpenTelemetry .NET will override this to add opinionated defaults.
109109
[^3]: Configure tracing to instrument requests handled by ASP.NET Core.
110110

111111
With these limited changes to the `Program.cs` file, the application is now configured to use the
112-
OpenTelemetry SDK and the Elastic distribution to collect traces and metrics, which are exported via
112+
OpenTelemetry SDK and the Elastic Distribution for OpenTelemetry .NET to collect traces and metrics, which are exported via
113113
OTLP.
114114

115115
To demonstrate the tracing capabilities, add a simple endpoint to the application:
@@ -128,7 +128,7 @@ app.MapGet("/", async (IHttpClientFactory httpClientFactory) =>
128128
```
129129
[^1]: Using this URL will require two redirects, allowing us to see multiple spans in the trace.
130130

131-
The Elastic distribution will automatically enable the exporting of signals via the OTLP exporter. This
131+
The Elastic Distribution for OpenTelemetry .NET will automatically enable the exporting of signals via the OTLP exporter. This
132132
exporter requires that endpoint(s) are configured. A common mechanism for configuring endpoints is
133133
via environment variables.
134134

docs/intro.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ title: Elastic OpenTelemetry Distribution for .NET
1212
early feedback, see [get started](get-started).
1313
</DocCallOut>
1414

15-
The `Elastic.OpenTelemetry` package contains an Elastic distribution of the
15+
The `Elastic.OpenTelemetry` package contains an Elastic Distribution for OpenTelemetry .NET of the
1616
[OpenTelemetry SDK for .NET](https://opentelemetry.io/docs/languages/net). A distribution
1717
is a wrapper around an upstream OpenTelemetry repository with some customizations. For
1818
more details about distributions in general, visit the
1919
[OpenTelemetry documentation](https://opentelemetry.io/docs/concepts/distributions).
2020

21-
The Elastic distribution includes some Elastic-specific processors to ensure the best
21+
The Elastic Distribution for OpenTelemtry .NET includes some Elastic-specific processors to ensure the best
2222
compatibility when exporting OpenTelemetry signal data to an Elastic backend such
2323
as Elastic APM server. The distribution also preconfigures the collection of tracing
2424
and metrics signals, applying some opinionated defaults, such as which sources are

src/Elastic.OpenTelemetry/Configuration/ElasticOpenTelemetryOptions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ private static string GetDefaultLogDirectory()
148148
public string LogDirectoryDefault => _defaultLogDirectory;
149149

150150
/// <summary>
151-
/// The output directory where the Elastic distribution of OpenTelemetry will write log files.
151+
/// The output directory where the Elastic Distribution for OpenTelemetry .NET will write log files.
152152
/// </summary>
153153
/// <remarks>
154154
/// When configured, a file log will be created in this directory with the name

src/Elastic.OpenTelemetry/Diagnostics/LoggerMessages.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@ internal static partial class LoggerMessages
3636
public static void LogAgentPreamble(this ILogger logger)
3737
{
3838
var process = Process.GetCurrentProcess();
39-
logger.LogInformation("Elastic OpenTelemetry Distribution: {AgentInformationalVersion}", VersionHelper.InformationalVersion);
39+
logger.LogInformation("Elastic Distribution for OpenTelemetry .NET: {AgentInformationalVersion}", VersionHelper.InformationalVersion);
4040
if (logger is CompositeLogger distributionLogger)
4141
{
4242
if (distributionLogger.LogFileEnabled)
43-
logger.LogInformation("Elastic OpenTelemetry Distribution, log file: {LogFilePath}", distributionLogger.LogFilePath);
43+
logger.LogInformation("Elastic Distribution for OpenTelemetry .NET, log file: {LogFilePath}", distributionLogger.LogFilePath);
4444
else
45-
logger.LogInformation("Elastic OpenTelemetry Distribution, log file: <disabled>");
45+
logger.LogInformation("Elastic Distribution for OpenTelemetry .NET, log file: <disabled>");
4646
}
4747

4848
logger.LogInformation("Process ID: {ProcessId}", process.Id);

src/Elastic.OpenTelemetry/Elastic.OpenTelemetry.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<PropertyGroup>
44
<OutputType>Library</OutputType>
55
<TargetFrameworks>netstandard2.0;netstandard2.1;net462;net6.0;net8.0</TargetFrameworks>
6-
<Title>Elastic OpenTelemetry .NET Distribution</Title>
6+
<Title>Elastic Distribution for OpenTelemetry .NET</Title>
77
<Description>OpenTelemetry extensions for Elastic Observability, fully native with zero code changes.</Description>
88
<PackageTags>elastic;opentelemetry;observabillity;apm;logs;metrics;traces;monitoring</PackageTags>
99
<ImplicitUsings>enable</ImplicitUsings>

0 commit comments

Comments
 (0)