-
Notifications
You must be signed in to change notification settings - Fork 725
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve logging getting-started example for console applications (#4740)
- Loading branch information
Showing
13 changed files
with
128 additions
and
157 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| # Getting Started with OpenTelemetry .NET Logs in 5 Minutes - Console Application | ||
|
|
||
| First, download and install the [.NET | ||
| 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 latest `Microsoft.Extensions.Logging` package: | ||
|
|
||
| ```sh | ||
| dotnet add package Microsoft.Extensions.Logging | ||
| ``` | ||
|
|
||
| Install the | ||
| [OpenTelemetry.Exporter.Console](../../../src/OpenTelemetry.Exporter.Console/README.md) | ||
| package: | ||
|
|
||
| ```sh | ||
| dotnet add package OpenTelemetry.Exporter.Console | ||
| ``` | ||
|
|
||
| Copy the [FoodSupplyLogs.cs](./FoodSupplyLogs.cs) and [Program.cs](./Program.cs) | ||
| files to the project folder. | ||
|
|
||
| Run the application again (using `dotnet run`) and you should see the log output | ||
| on the console. | ||
|
|
||
| ```text | ||
| LogRecord.Timestamp: 2023-08-03T22:53:51.0194130Z | ||
| LogRecord.CategoryName: SourceGeneration.Program | ||
| LogRecord.Severity: Info | ||
| LogRecord.SeverityText: Information | ||
| LogRecord.FormattedMessage: Food `artichoke` price changed to `9.99`. | ||
| LogRecord.Body: Food `{name}` price changed to `{price}`. | ||
| LogRecord.Attributes (Key:Value): | ||
| name: artichoke | ||
| price: 9.99 | ||
| OriginalFormat (a.k.a Body): Food `{name}` price changed to `{price}`. | ||
| LogRecord.EventId: 1 | ||
| LogRecord.EventName: FoodPriceChanged | ||
| Resource associated with LogRecord: | ||
| telemetry.sdk.name: opentelemetry | ||
| telemetry.sdk.language: dotnet | ||
| telemetry.sdk.version: 1.6.0-alpha.1.55 | ||
| service.name: unknown_service:getting-started | ||
| LogRecord.Timestamp: 2023-08-03T22:53:51.0403466Z | ||
| LogRecord.CategoryName: SourceGeneration.Program | ||
| LogRecord.Severity: Fatal | ||
| LogRecord.SeverityText: Critical | ||
| LogRecord.FormattedMessage: A `Food & Beverages` recall notice was published for `Contoso Salads` produced by `Contoso Fresh Vegetables, Inc.` (due to a possible health risk from Listeria monocytogenes). | ||
| LogRecord.Body: A `{productType}` recall notice was published for `{brandName} {productDescription}` produced by `{companyName}` ({recallReasonDescription}). | ||
| LogRecord.Attributes (Key:Value): | ||
| brandName: Contoso | ||
| productDescription: Salads | ||
| productType: Food & Beverages | ||
| recallReasonDescription: due to a possible health risk from Listeria monocytogenes | ||
| companyName: Contoso Fresh Vegetables, Inc. | ||
| OriginalFormat (a.k.a Body): A `{productType}` recall notice was published for `{brandName} {productDescription}` produced by `{companyName}` ({recallReasonDescription}). | ||
| LogRecord.EventId: 2 | ||
| LogRecord.EventName: FoodRecallNotice | ||
| Resource associated with LogRecord: | ||
| telemetry.sdk.name: opentelemetry | ||
| telemetry.sdk.language: dotnet | ||
| telemetry.sdk.version: 1.6.0-alpha.1.55 | ||
| service.name: unknown_service:getting-started | ||
| ``` | ||
|
|
||
| Congratulations! You are now collecting logs using OpenTelemetry. | ||
|
|
||
| What does the above program do? | ||
|
|
||
| The program has a | ||
| [`LoggerFactory`](https://docs.microsoft.com/dotnet/api/microsoft.extensions.logging.iloggerfactory) | ||
| with OpenTelemetry added as a | ||
| [LoggerProvider](https://docs.microsoft.com/dotnet/core/extensions/logging-providers). | ||
| This `LoggerFactory` is used to create an | ||
| [`ILogger`](https://docs.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger) | ||
| instance, which is then used to do the logging. [Compile-time logging source | ||
| generation](https://docs.microsoft.com/dotnet/core/extensions/logger-message-generator) | ||
| is used to achieve structured logging and better performance. The logs are sent to | ||
| the `OpenTelemetryLoggerProvider`, which is configured to export logs to | ||
| `ConsoleExporter`. `ConsoleExporter` simply displays it on the console. | ||
|
|
||
| > **Note** | ||
| > Certain types of applications (e.g. [ASP.NET | ||
| Core](https://learn.microsoft.com/aspnet/core) and [.NET | ||
| Worker](https://learn.microsoft.com/dotnet/core/extensions/workers)) have an | ||
| `ILogger` based logging pipeline set up by default. In such apps, enabling | ||
| OpenTelemetry should be done by adding OpenTelemetry as a provider to the | ||
| *existing* logging pipeline, and users should not create a new `LoggerFactory` | ||
| (which sets up a totally new logging pipeline). Also, obtaining `ILogger` | ||
| instance could be done differently as well. See [Example ASP.NET Core | ||
| application](../../../examples/AspNetCore/Program.cs) for an example which shows | ||
| how to add OpenTelemetry to the logging pipeline already setup by the | ||
| application. | ||
|
|
||
| ## Learn more | ||
|
|
||
| * [Compile-time logging source | ||
| generation](https://docs.microsoft.com/dotnet/core/extensions/logger-message-generator) | ||
| * [Customizing the OpenTelemetry .NET SDK](../customizing-the-sdk/README.md) | ||
| * [Extending the OpenTelemetry .NET SDK](../extending-the-sdk/README.md) |
File renamed without changes.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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
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