-
Notifications
You must be signed in to change notification settings - Fork 773
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a getting started doc for metric (#2132)
- Loading branch information
1 parent
1f2075a
commit be1d13f
Showing
9 changed files
with
130 additions
and
22 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 was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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,54 @@ | ||
| // <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; | ||
| using System.Collections.Generic; | ||
| using System.Diagnostics.Metrics; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using OpenTelemetry; | ||
| using OpenTelemetry.Metrics; | ||
|
|
||
| public class Program | ||
| { | ||
| private static readonly Meter MyMeter = new Meter("TestMeter", "0.0.1"); | ||
| private static readonly Counter<long> Counter = MyMeter.CreateCounter<long>("counter"); | ||
|
|
||
| public static async Task Main(string[] args) | ||
| { | ||
| using var meterProvider = Sdk.CreateMeterProviderBuilder() | ||
| .AddSource("TestMeter") | ||
| .AddExportProcessor(new MetricConsoleExporter()) | ||
| .Build(); | ||
|
|
||
| using var token = new CancellationTokenSource(); | ||
| Task writeMetricTask = new Task(() => | ||
| { | ||
| while (!token.IsCancellationRequested) | ||
| { | ||
| Counter.Add( | ||
| 10, | ||
| new KeyValuePair<string, object>("tag1", "value1"), | ||
| new KeyValuePair<string, object>("tag2", "value2")); | ||
| Task.Delay(10).Wait(); | ||
| } | ||
| }); | ||
| writeMetricTask.Start(); | ||
|
|
||
| token.CancelAfter(10000); | ||
| await writeMetricTask; | ||
| } | ||
| } |
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,59 @@ | ||
| # Getting Started with OpenTelemetry .NET in 5 Minutes | ||
|
|
||
| First, download and install the [.NET Core | ||
| SDK](https://dotnet.microsoft.com/download) on your computer. | ||
|
|
||
| Create a new console application and run it: | ||
|
|
||
| ```sh | ||
| dotnet new console --output getting-started | ||
| cd getting-started | ||
| dotnet run | ||
| ``` | ||
|
|
||
| You should see the following output: | ||
|
|
||
| ```text | ||
| Hello World! | ||
| ``` | ||
|
|
||
| Install the | ||
| [OpenTelemetry](../../../src/OpenTelemetry/README.md) | ||
| package: | ||
|
|
||
| ```sh | ||
| dotnet add package OpenTelemetry | ||
| ``` | ||
|
|
||
| Update the `Program.cs` file with the code from [Program.cs](./Program.cs): | ||
|
|
||
| Run the application again (using `dotnet run`) and you should see the metric | ||
| output from the console, similar to shown below: | ||
|
|
||
| <!-- markdownlint-disable MD013 --> | ||
| ```text | ||
| Export[] 16:38:36.241 16:38:37.233 TestMeter:counter [tag1=value1;tag2=value2] SumMetricAggregator Value: 590, Details: Delta=True,Mon=True,Count=59,Sum=590 | ||
| Export[] 16:38:37.233 16:38:38.258 TestMeter:counter [tag1=value1;tag2=value2] SumMetricAggregator Value: 640, Details: Delta=True,Mon=True,Count=64,Sum=640 | ||
| Export[] 16:38:38.258 16:38:39.261 TestMeter:counter [tag1=value1;tag2=value2] SumMetricAggregator Value: 640, Details: Delta=True,Mon=True,Count=64,Sum=640 | ||
| Export[] 16:38:39.261 16:38:40.266 TestMeter:counter [tag1=value1;tag2=value2] SumMetricAggregator Value: 630, Details: Delta=True,Mon=True,Count=63,Sum=630 | ||
| Export[] 16:38:40.266 16:38:41.271 TestMeter:counter [tag1=value1;tag2=value2] SumMetricAggregator Value: 640, Details: Delta=True,Mon=True,Count=64,Sum=640 | ||
| ``` | ||
| <!-- markdownlint-enable MD013 --> | ||
|
|
||
| Congratulations! You are now collecting metrics using OpenTelemetry. | ||
|
|
||
| What does the above program do? | ||
|
|
||
| The program creates a | ||
| [Meter](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/api.md#meter) | ||
| instance named "TestMeter" and then creates a | ||
| [Counter](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/api.md#counter) | ||
| instrument from it. This counter is used to repeatedly report metric | ||
| measurements until exited after 10 seconds. | ||
|
|
||
| An OpenTelemetry | ||
| [MeterProvider](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/api.md#meterprovider) | ||
| is configured to subscribe to instruments from the Meter `TestMeter`, and | ||
| aggregate the measurements in-memory. The pre-aggregated metrics are exported | ||
| every 1 second to a `ConsoleExporter`. `ConsoleExporter` simply displays it on | ||
| the console. |
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,5 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <ItemGroup> | ||
| <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry\OpenTelemetry.csproj" /> | ||
| </ItemGroup> | ||
| </Project> |
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