-
Notifications
You must be signed in to change notification settings - Fork 785
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add ASP.NET example for metrics (#4381)
- Loading branch information
Showing
14 changed files
with
197 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| // <copyright file="Program.cs" company="OpenTelemetry Authors"> | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // </copyright> | ||
|
|
||
| using System.Diagnostics; | ||
| using OpenTelemetry.Metrics; | ||
| using OpenTelemetry.Resources; | ||
|
|
||
| var appBuilder = WebApplication.CreateBuilder(args); | ||
|
|
||
| // Configure OpenTelemetry with metrics and auto-start. | ||
| appBuilder.Services.AddOpenTelemetry() | ||
| .ConfigureResource(builder => builder | ||
| .AddService(serviceName: "OTel.NET Getting Started")) | ||
| .WithMetrics(builder => builder | ||
| .AddAspNetCoreInstrumentation() | ||
| .AddConsoleExporter((exporterOptions, metricReaderOptions) => | ||
| { | ||
| metricReaderOptions.PeriodicExportingMetricReaderOptions.ExportIntervalMilliseconds = 1000; | ||
| })); | ||
|
|
||
| var app = appBuilder.Build(); | ||
|
|
||
| app.MapGet("/", () => $"Hello from OpenTelemetry Metrics!"); | ||
|
|
||
| app.Run(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| # Getting Started with OpenTelemetry .NET in 5 Minutes - ASP.NET Core Application | ||
|
|
||
| First, download and install the [.NET | ||
| SDK](https://dotnet.microsoft.com/download) on your computer. | ||
|
|
||
| Create a new web application: | ||
|
|
||
| ```sh | ||
| dotnet new web -o aspnetcoreapp | ||
| cd aspnetcoreapp | ||
| ``` | ||
|
|
||
| Install the | ||
| [OpenTelemetry.Exporter.Console](../../../src/OpenTelemetry.Exporter.Console/README.md), | ||
| [OpenTelemetry.Extensions.Hosting](../../../src/OpenTelemetry.Extensions.Hosting/README.md), | ||
| and | ||
| [OpenTelemetry.Instrumentation.AspNetCore](../../../src/OpenTelemetry.Exporter.Console/README.md) | ||
| packages: | ||
|
|
||
| ```sh | ||
| dotnet add package OpenTelemetry.Exporter.Console --prerelease | ||
| dotnet add package OpenTelemetry.Extensions.Hosting --prerelease | ||
| dotnet add package OpenTelemetry.Instrumentation.AspNetCore --prerelease | ||
| ``` | ||
|
|
||
| > **Note** This quickstart guide uses prerelease packages. For a quickstart | ||
| > which only relies on stable packages see: [Getting Started - Console | ||
| > Application](../getting-started-console/README.md). For more information about | ||
| > when instrumentation will be marked as stable see: [Instrumentation-1.0.0 | ||
| > milestone](https://github.com/open-telemetry/opentelemetry-dotnet/milestone/23). | ||
| Update the `Program.cs` file with the code from [Program.cs](./Program.cs). | ||
|
|
||
| Run the application again (using `dotnet run`) and then browse to the url shown | ||
| in the console for your application (ex `http://localhost:5154`). You should see | ||
| the trace output from the console. | ||
|
|
||
| ```text | ||
| Export http.server.duration, Measures the duration of inbound HTTP requests., Unit: ms, Meter: OpenTelemetry.Instrumentation.AspNetCore/1.0.0.0 | ||
| (2023-04-11T21:49:43.6915232Z, 2023-04-11T21:50:50.6564690Z] http.flavor: 1.1 http.method: GET http.route: / http.scheme: http http.status_code: 200 net.host.name: localhost net.host.port: 5000 Histogram | ||
| Value: Sum: 3.5967 Count: 11 Min: 0.073 Max: 2.5539 | ||
| (-Infinity,0]:0 | ||
| (0,5]:11 | ||
| (5,10]:0 | ||
| (10,25]:0 | ||
| (25,50]:0 | ||
| (50,75]:0 | ||
| (75,100]:0 | ||
| (100,250]:0 | ||
| (250,500]:0 | ||
| (500,750]:0 | ||
| (750,1000]:0 | ||
| (1000,2500]:0 | ||
| (2500,5000]:0 | ||
| (5000,7500]:0 | ||
| (7500,10000]:0 | ||
| (10000,+Infinity]:0 | ||
| ``` | ||
|
|
||
| Congratulations! You are now collecting metrics using OpenTelemetry. | ||
|
|
||
| What does the above program do? | ||
|
|
||
| The program uses the | ||
| [OpenTelemetry.Instrumentation.AspNetCore](../../../src/OpenTelemetry.Instrumentation.AspNetCore/README.md) | ||
| package to automatically create metrics for incoming ASP.NET Core requests, uses | ||
| the | ||
| [OpenTelemetry.Exporter.Console](../../../src/OpenTelemetry.Exporter.Console/README.md) | ||
| package to write metrics to the console every 1000 milliseconds. This is done by | ||
| configuring an OpenTelemetry | ||
| [MeterProvider](../customizing-the-sdk/README.MD#meterprovider) using extension | ||
| methods and setting it to auto-start when the host is started: | ||
|
|
||
| ```csharp | ||
| appBuilder.Services.AddOpenTelemetry() | ||
| .ConfigureResource(builder => builder | ||
| .AddService(serviceName: "OTel.NET Getting Started")) | ||
| .WithMetrics(builder => builder | ||
| .AddAspNetCoreInstrumentation() | ||
| .AddConsoleExporter((exporterOptions, metricReaderOptions) => | ||
| { | ||
| metricReaderOptions.PeriodicExportingMetricReaderOptions.ExportIntervalMilliseconds = 1000; | ||
| }) | ||
| ); | ||
| ``` | ||
|
|
||
| > **Note** | ||
| > The `AddOpenTelemetry` extension is part of the | ||
| [OpenTelemetry.Extensions.Hosting](../../../src/OpenTelemetry.Extensions.Hosting/README.md) | ||
| package. | ||
|
|
||
| The index route ("/") is set up to write out a greeting message on the response: | ||
|
|
||
| ```csharp | ||
| app.MapGet("/", () => $"Hello from OpenTelemetry Metrics!"); | ||
| ``` | ||
|
|
||
| ## Learn more | ||
|
|
||
| * [Getting Started with Prometheus and Grafana](../getting-started-prometheus-grafana/README.md) | ||
| * [Customizing OpenTelemetry .NET SDK](../customizing-the-sdk/README.md) | ||
| * [Extending the OpenTelemetry .NET SDK](../extending-the-sdk/README.md) |
9 changes: 9 additions & 0 deletions
9
docs/metrics/getting-started-aspnetcore/appsettings.Development.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| { | ||
| "DetailedErrors": true, | ||
| "Logging": { | ||
| "LogLevel": { | ||
| "Default": "Information", | ||
| "Microsoft.AspNetCore": "Warning" | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| { | ||
| "Logging": { | ||
| "LogLevel": { | ||
| "Default": "Information", | ||
| "Microsoft.AspNetCore": "Warning" | ||
| } | ||
| }, | ||
| "AllowedHosts": "*" | ||
| } |
15 changes: 15 additions & 0 deletions
15
docs/metrics/getting-started-aspnetcore/getting-started-aspnetcore.csproj
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk.Web"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFrameworks>net6.0;net7.0</TargetFrameworks> | ||
| <Nullable>enable</Nullable> | ||
| <ImplicitUsings>enable</ImplicitUsings> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Exporter.Console\OpenTelemetry.Exporter.Console.csproj" /> | ||
| <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Extensions.Hosting\OpenTelemetry.Extensions.Hosting.csproj" /> | ||
| <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Instrumentation.AspNetCore\OpenTelemetry.Instrumentation.AspNetCore.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters