-
Notifications
You must be signed in to change notification settings - Fork 801
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Updated docs for logs * Remove extra space * Corrected the propertyname to TargetFrameworks * Updated TargetFrameworks property * Addressed PR comments Co-authored-by: Cijo Thomas <cithomas@microsoft.com>
- Loading branch information
1 parent
daa83ca
commit 0abe85d
Showing
4 changed files
with
80 additions
and
5 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,74 @@ | ||
# Getting Started with OpenTelemetry .NET in 5 Minutes | ||
# Getting Started with OpenTelemetry .NET Logs in 5 Minutes | ||
|
||
TBD | ||
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! | ||
``` | ||
|
||
Let's install the packages to get started with logging. If your ConsoleApp | ||
targets `netcoreapp2.1` install the version `2.1.1` of | ||
`Microsoft.Extensions.Logging` and `Microsoft.Extensions.DependencyInjection` | ||
packages: | ||
|
||
```sh | ||
dotnet add package Microsoft.Extensions.Logging -v 2.1.1 | ||
``` | ||
|
||
```sh | ||
dotnet add package Microsoft.Extensions.DependencyInjection -v 2.1.1 | ||
``` | ||
|
||
If your ConsoleApp targets a framework other than `netcoreapp2.1`, 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 (Use the latest version): | ||
|
||
```sh | ||
dotnet add package OpenTelemetry.Exporter.Console -v 1.0.0-rc1.1 | ||
``` | ||
|
||
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 log output | ||
on the console. | ||
|
||
```text | ||
LogRecord.TraceId: 00000000000000000000000000000000 | ||
LogRecord.SpanId: 0000000000000000 | ||
LogRecord.Timestamp: 2020-11-13T23:50:33.5764463Z | ||
LogRecord.EventId: 0 | ||
LogRecord.CategoryName: Program | ||
LogRecord.LogLevel: Information | ||
LogRecord.TraceFlags: None | ||
LogRecord.State: Hello from tomato 2.99. | ||
``` | ||
|
||
Congratulations! You are now collecting logs using OpenTelemetry. | ||
|
||
What does the above program do? | ||
|
||
The program uses the | ||
[`ILogger`](https://docs.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger) | ||
API to log a formatted string with a severity level of Information. Click | ||
[here](https://docs.microsoft.com/dotnet/api/microsoft.extensions.logging.loglevel) | ||
for more information on the different logs levels. Opentelemetry captures this | ||
and sends it to `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
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