open-telemetry
/
opentelemetry-dotnet
mirror of https://github.com/open-telemetry/opentelemetry-dotnet.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve the logging tutorial by clarifying DI vs. exlicit logging pipeline (#4897)

This commit is contained in:
Reiley Yang 2023-09-28 16:53:33 -07:00 committed by GitHub
parent 0b2d0367b2
commit aeca53949a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 29 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/logs/getting-started-aspnetcore/README.md
View File

@ -125,6 +125,18 @@ generic `ILogger<T>` is not an option, `app.Logger` is used instead:
app.Logger.StartingApp();
```
> **Note**
> There are cases where logging is needed before the [dependency injection
(DI)](https://learn.microsoft.com/dotnet/core/extensions/dependency-injection)
logging pipeline is available (e.g. before `builder.Build()`) or after the DI
logging pipeline is disposed (e.g. after `app.Run()`). The common practice is to
use a separate logging pipeline by creating a `LoggerFactory` instance.
>
> Refer to the [Getting Started with OpenTelemetry .NET Logs in 5 Minutes -
Console Application](../getting-started-console/README.md) tutorial to learn
more about how to create a `LoggerFactory` instance and configure OpenTelemetry
to work with it.
## Learn more
* [Compile-time logging source

26
docs/logs/getting-started-console/README.md
View File

@ -85,19 +85,19 @@ is used to achieve structured logging and better performance. The logs are sent
the `OpenTelemetryLoggerProvider`, which is configured to export logs to
`ConsoleExporter`. `ConsoleExporter` simply displays it on the console.
## Note for different application types
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.
> **Note**
> For applications which use `ILogger` with [dependency injection
(DI)](https://learn.microsoft.com/dotnet/core/extensions/dependency-injection)
(e.g. [ASP.NET Core](https://learn.microsoft.com/aspnet/core) and [.NET
Worker](https://learn.microsoft.com/dotnet/core/extensions/workers)), the common
practice is to add OpenTelemetry as a [logging
provider](https://docs.microsoft.com/dotnet/core/extensions/logging-providers)
to the DI logging pipeline, rather than set up a completely new logging pipeline
by creating a new `LoggerFactory` instance.
>
> Refer to the [Getting Started with OpenTelemetry .NET Logs in 5 Minutes -
ASP.NET Core Application](../getting-started-aspnetcore/README.md) tutorial to
learn more.
## Learn more

10
src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md
View File

@ -75,12 +75,10 @@ customize the `LogRecordExportProcessorOptions` or see the [Environment
Variables](#environment-variables) section below on how to customize using
environment variables.
> **Note** For details on how to configure logging with OpenTelemetry check this
> [console](../../docs/logs/getting-started-console/Program.cs) or [ASP.NET
Core](../../examples/AspNetCore/Program.cs) example app. Check this
**[section](../../docs/logs/getting-started-console/readme.md#note-for-different-application-types)**
for configuring OpenTelemetry with `ILogger` for certain application types such
as ASP.NET Core and .NET Worker.
> **Note**
> For details on how to configure logging with OpenTelemetry check the
[Console](../../docs/logs/getting-started-console/README.md) or [ASP.NET
Core](../../docs/logs/getting-started-aspnetcore/README.md) tutorial.
**ILogger Scopes**: OTLP Log Exporter supports exporting `ILogger` scopes as
Attributes. Scopes must be enabled at the SDK level using