Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Changelog/Readme for Azure.Monitor.OpenTelemetry.AspNetCore #39077

Merged
merged 7 commits into from
Oct 3, 2023
Merged

Update Changelog/Readme for Azure.Monitor.OpenTelemetry.AspNetCore #39077

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9f35394
Update Changelog
rajkumar-rangaraj Oct 3, 2023
ef475f1
Remove forked.
rajkumar-rangaraj Oct 3, 2023
f4093d9
Merge branch 'main' of https://github.com/Azure/azure-sdk-for-net int…
rajkumar-rangaraj Oct 3, 2023
6e55c31
Update Readme
rajkumar-rangaraj Oct 3, 2023
347541e
pr feedback
rajkumar-rangaraj Oct 3, 2023
bf1001d
Update API Comment.
rajkumar-rangaraj Oct 3, 2023
687910c
Update changelog
rajkumar-rangaraj Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions sdk/monitor/Azure.Monitor.OpenTelemetry.AspNetCore/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,21 @@

### Breaking Changes

- Removed package references to the beta versions of `OpenTelemetry.Instrumentation.AspNetCore`, `OpenTelemetry.Instrumentation.Http`, and `OpenTelemetry.Instrumentation.SqlClient`.
rajkumar-rangaraj marked this conversation as resolved.
Show resolved Hide resolved
Due to this change, users will no longer be able to access the public APIs of these beta packages.
Manually adding package references to these instrumentation libraries in an application will cause the internal vendored instrumentation from the distro to be ignored.
If users choose to add these references, they must ensure to update their configuration subsequently. This includes incorporating the necessary instrumentation using either TracerProviderBuilder or MeterProviderBuilder.

rajkumar-rangaraj marked this conversation as resolved.
Show resolved Hide resolved
### Bugs Fixed

### Other Changes

- Vendored the code of instrumentation libraries `OpenTelemetry.Instrumentation.AspNetCore`, `OpenTelemetry.Instrumentation.Http`, and `OpenTelemetry.Instrumentation.SqlClient` from the OpenTelemetry .NET repository.
Integrated the forked code and converted all of its public API to internal.
This ensures that `Azure.Monitor.OpenTelemetry.AspNetCore` has native support for ASP.NET Core, HTTP Client, and SQL instrumentation without needing external beta package references.
- Vendored the code of the `OpenTelemetry.ResourceDetectors.Azure` resource detector from the OpenTelemetry .NET Contrib repository and made its public API internal.
- Removed reference to the `OpenTelemetry.ResourceDetectors.Azure` resource detector package.

## 1.0.0-beta.7 (2023-09-20)

### Other Changes
Expand Down
13 changes: 6 additions & 7 deletions sdk/monitor/Azure.Monitor.OpenTelemetry.AspNetCore/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,15 @@ The Azure Monitor Distro is a client library that sends telemetry data to Azure

### What is Included in the Distro

The Azure Monitor Distro is a distribution of the .NET OpenTelemetry SDK and related instrumentation libraries. It includes the following components:
The Azure Monitor Distro is a distribution of the .NET OpenTelemetry SDK with internally vendored instrumentation libraries, including:

* Traces
* [ASP.NET Core Instrumentation Library](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.AspNetCore/) provides automatic tracing for incoming HTTP requests to ASP.NET Core applications.
* [HTTP Client Instrumentation Library](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Http/) provides automatic tracing for outgoing HTTP requests made using [System.Net.Http.HttpClient](https://docs.microsoft.com/dotnet/api/system.net.http.httpclient).
* [SQL Client Instrumentation Library](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.SqlClient) provides automatic tracing for SQL queries executed using the [Microsoft.Data.SqlClient](https://www.nuget.org/packages/Microsoft.Data.SqlClient) and [System.Data.SqlClient](https://www.nuget.org/packages/System.Data.SqlClient) packages.
* **ASP.NET Core Instrumentation**: Provides automatic tracing for incoming HTTP requests to ASP.NET Core applications.
* **HTTP Client Instrumentation**: Provides automatic tracing for outgoing HTTP requests made using [System.Net.Http.HttpClient](https://docs.microsoft.com/dotnet/api/system.net.http.httpclient).
* **SQL Client Instrumentation** Provides automatic tracing for SQL queries executed using the [Microsoft.Data.SqlClient](https://www.nuget.org/packages/Microsoft.Data.SqlClient) and [System.Data.SqlClient](https://www.nuget.org/packages/System.Data.SqlClient) packages.

* Metrics
* [ASP.NET Core Instrumentation Library](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.AspNetCore/) provides automatic collection of common ASP.NET Core metrics.
* [HTTP Client Instrumentation Library](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Http/) provides automatic collection of HTTP client metrics.
* Provides automatic collection of Application Insights Standard metrics.

rajkumar-rangaraj marked this conversation as resolved.
Show resolved Hide resolved
* [Logs](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/logs/getting-started-console)

Expand Down Expand Up @@ -184,7 +183,7 @@ environmental variables:

## Key concepts

The Azure Monitor Distro is a distribution package which enables users to send telemetry data to Azure Monitor. It includes the .NET OpenTelemetry SDK and instrumentation libraries for [ASP.NET Core](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.AspNetCore/), [HttpClient](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Http/), and [SQLClient](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.SqlClient).
The Azure Monitor Distro is a distribution package that facilitates users in sending telemetry data to Azure Monitor. It encompasses the .NET OpenTelemetry SDK and internally vendored instrumentation libraries for ASP.NET Core, HttpClient, and SQLClient, ensuring seamless integration and data collection.

## Examples

Expand Down
28 changes: 8 additions & 20 deletions sdk/monitor/Azure.Monitor.OpenTelemetry.AspNetCore/src/OpenTelemetryBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,11 @@ public static class OpenTelemetryBuilderExtensions
/// parsed state values.
/// </para>
///
/// <para>The following instrumentations are added for distributed tracing:</para>
/// <para>The following vendored instrumentations are added for distributed tracing:</para>
/// <list type="bullet">
/// <item>ASP.NET Core: <see href="https://www.nuget.org/packages/OpenTelemetry.Instrumentation.AspNetCore/"/>.</item>
/// <item>HTTP Client: <see href="https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Http"/>.</item>
/// <item>SQL Client: <see href="https://www.nuget.org/packages/OpenTelemetry.Instrumentation.sqlclient"/>.</item>
/// </list>
///
/// <para>The following instrumentations are added for metrics:</para>
/// <list type="bullet">
/// <item>ASP.NET Core: <see href="https://www.nuget.org/packages/OpenTelemetry.Instrumentation.AspNetCore/"/>.</item>
/// <item>HTTP Client: <see href="https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Http"/>.</item>
/// <item>ASP.NET Core.</item>
/// <item>HTTP Client.</item>
/// <item>SQL Client.</item>
/// </list>
/// </remarks>
public static OpenTelemetryBuilder UseAzureMonitor(this OpenTelemetryBuilder builder)
Expand All @@ -75,17 +69,11 @@ public static OpenTelemetryBuilder UseAzureMonitor(this OpenTelemetryBuilder bui
/// parsed state values.
/// </para>
///
/// <para>The following instrumentations are added for distributed tracing:</para>
/// <list type="bullet">
/// <item>ASP.NET Core: <see href="https://www.nuget.org/packages/OpenTelemetry.Instrumentation.AspNetCore/"/>.</item>
/// <item>HTTP Client: <see href="https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Http"/>.</item>
/// <item>SQL Client: <see href="https://www.nuget.org/packages/OpenTelemetry.Instrumentation.sqlclient"/>.</item>
/// </list>
///
/// <para>The following instrumentations are added for metrics:</para>
/// <para>The following vendored instrumentations are added for distributed tracing:</para>
/// <list type="bullet">
/// <item>ASP.NET Core: <see href="https://www.nuget.org/packages/OpenTelemetry.Instrumentation.AspNetCore/"/>.</item>
/// <item>HTTP Client: <see href="https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Http"/>.</item>
/// <item>ASP.NET Core.</item>
/// <item>HTTP Client.</item>
/// <item>SQL Client.</item>
/// </list>
/// </remarks>
public static OpenTelemetryBuilder UseAzureMonitor(this OpenTelemetryBuilder builder, Action<AzureMonitorOptions> configureAzureMonitor)
Expand Down