Skip to content

docs(dotnet/logs): add Logs for the .NET SDK #14583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/platforms/dotnet/common/logs/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: Set Up Logs
sidebar_title: Logs
description: "Structured logs allow you to send, view and query logs sent from your applications within Sentry."
sidebar_order: 5600
Copy link
Member Author

@Flash0ver Flash0ver Aug 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: order

We're inconsistent with the order for SDKs that have both Crons and Logs

  • Logs before Crons: Go, PHP
  • Crons before Logs: Java, Python, Ruby

Where should we put it?
Does it matter?
@AbhiPrasad

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not worry about this for now, I'll just merge what we have here.

I raised a thread in slack to chat more about this: https://sentry.slack.com/archives/C081M1KEQ0L/p1754917568834039. Once we make a decision there, I'll leave another comment here about what we are going to change. I'll own fixing the order here.

notSupported:
- dotnet.google-cloud-functions
- dotnet.log4net
- dotnet.nlog
- dotnet.serilog
- dotnet.xamarin
---

<Include name="feature-stage-beta-logs.mdx" />

With Sentry Structured Logs, you can send text based log information from your applications to Sentry. Once in Sentry, these logs can be viewed alongside relevant errors, searched by text-string, or searched using their individual attributes.

## Requirements

<PlatformContent includePath="logs/requirements" />

## Setup

<PlatformContent includePath="logs/setup" />

## Usage

<PlatformContent includePath="logs/usage" />

## Integrations

<PlatformContent includePath="logs/integrations" />

## Options

<PlatformContent includePath="logs/options" />



13 changes: 8 additions & 5 deletions docs/product/explore/logs/getting-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,14 @@ To set up Sentry Logs, use the links below for supported SDKs. After it's been s

- <LinkWithPlatformIcon platform="rust" label="Rust" url="/platforms/rust/logs/" />

### .NET

- <LinkWithPlatformIcon
platform="dotnet"
label=".NET"
url="/platforms/dotnet/logs/"
/>

## Upcoming SDKs

We're actively working on adding Log functionality to additional SDKs. Check out these GitHub issues for the latest updates:
Expand All @@ -260,11 +268,6 @@ We're actively working on adding Log functionality to additional SDKs. Check out
label="Elixir"
url="https://github.com/getsentry/sentry-elixir/issues/886"
/>
- <LinkWithPlatformIcon
platform="dotnet"
label=".NET"
url="https://github.com/getsentry/sentry-dotnet/issues/4132"
/>
- <LinkWithPlatformIcon
platform="php.symfony"
label="Symfony"
Expand Down
6 changes: 6 additions & 0 deletions platform-includes/logs/integrations/dotnet.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Available integrations:
- [Microsoft.Extensions.Logging](/platforms/dotnet/guides/extensions-logging/logs/)
- [ASP.NET Core](/platforms/dotnet/guides/aspnetcore/logs/)
- [.NET Multi-platform App UI (.NET MAUI)](/platforms/dotnet/guides/maui/logs/)

If there's an integration you would like to see, open a [new issue on GitHub](https://github.com/getsentry/sentry-dotnet/issues/new/choose).
47 changes: 47 additions & 0 deletions platform-includes/logs/options/dotnet.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
#### Experimental.EnableLogs
Set to `true` in order to enable the `SentrySdk.Experimental.Logger` APIs, as well as logging integrations via the [ILogger<T>](https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger-1) API.

#### Experimental.SetBeforeSendLog(Func<SentryLog, SentryLog?>)

To filter logs, or update them before they are sent to Sentry, you can use the `Experimental.SetBeforeSendLog()` option.

```csharp
options =>
{
options.Dsn = "___PUBLIC_DSN___";
options.Experimental.EnableLogs = true;
// a callback that is invoked before sending a log to Sentry
options.Experimental.SetBeforeSendLog(static log =>
{
// filter out all info logs
if (log.Level is SentryLogLevel.Info)
{
return null;
}

// filter out logs based on some attribute they have
if (log.TryGetAttribute("suppress", out var attribute) && attribute is true)
{
return null;
}

// set a custom attribute for all other logs sent to Sentry
log.SetAttribute("my.attribute", "value");

return log;
});
});
```

The callback function set via `Experimental.SetBeforeSendLog()` receives a log object, and should return the log object if you want it to be sent to Sentry, or `null` if you want to discard it.

The log object of type `SentryLog` has the following members:
- `Timestamp` Property: (`DateTimeOffset`) The timestamp of the log.
- `TraceId` Property: (`SentryId`) The trace id of the log.
- `Level` Property: (`SentryLogLevel`) The severity level of the log. Either `Trace`, `Debug`, `Info`, `Warning`, `Error`, or `Fatal`.
- `Message` Property: (`string`) The formatted log message.
- `Template` Property: (`string?`) The parameterized template string.
- `Parameters` Property: (`ImmutableArray<KeyValuePair<string, object>>`) The parameters to the template string.
- `ParentSpanId` Property: (`SpanId?`) The span id of the span that was active when the log was collected.
- `TryGetAttribute(string key, out object value)` Method: Gets the attribute value associated with the specified key. Returns `true` if the log contains an attribute with the specified key and it's value is not `null`, otherwise `false`.
- `SetAttribute(string key, object value)` Method: Set a key-value pair of data attached to the log. Supported types are `string`, `bool`, integers up to a size of 64-bit signed, and floating-point numbers up to a size of 64-bit.
1 change: 1 addition & 0 deletions platform-includes/logs/requirements/dotnet.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Logs for .NET are supported in Sentry .NET SDK version `5.14.0` and above.
53 changes: 53 additions & 0 deletions platform-includes/logs/setup/dotnet.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
To enable logging, you need to initialize the SDK with the `Experimental.EnableLogs` option set to `true`.

<PlatformSection notSupported={["dotnet.aspnetcore"]}>

```csharp
SentrySdk.Init(options =>
{
options.Dsn = "___PUBLIC_DSN___";
// Enable logs to be sent to Sentry
options.Experimental.EnableLogs = true;
});
```

</PlatformSection>

<PlatformSection supported={["dotnet.aspnetcore, dotnet.aws-lambda, dotnet.azure-functions-worker, dotnet.blazor-webassembly, dotnet.maui"]}>

```csharp {tabTitle:Builder}
.UseSentry(options =>
{
options.Dsn = "___PUBLIC_DSN___";
// Enable logs to be sent to Sentry
options.Experimental.EnableLogs = true;
});
```

</PlatformSection>

<PlatformSection supported={["dotnet.extensions-logging"]}>

```csharp {tabTitle:Factory}
.AddSentry(options =>
{
options.Dsn = "___PUBLIC_DSN___";
// Enable logs to be sent to Sentry
options.Experimental.EnableLogs = true;
});
```

</PlatformSection>

<PlatformSection supported={["dotnet.aspnetcore, dotnet.extensions-logging"]}>

```json {tabTitle:Configuration} {filename:appsettings.json}
"Sentry": {
"Dsn": "___PUBLIC_DSN___",
"Experimental": {
"EnableLogs": true
}
},
```

</PlatformSection>
63 changes: 63 additions & 0 deletions platform-includes/logs/usage/dotnet.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
Once the feature is enabled on the SDK and the SDK is initialized, you can send logs using the `SentrySdk.Experimental.Logger` APIs.

The `SentrySdk.Experimental.Logger` instance exposes six methods that you can use to log messages at different log levels: `Trace`, `Debug`, `Info`, `Warning`, `Error`, and `Fatal`.

These properties will be sent to Sentry, and can be searched from within the Logs UI, and even added to the Logs views as a dedicated column.

```csharp
SentrySdk.Experimental.Logger.LogInfo("A simple log message");
SentrySdk.Experimental.Logger.LogError("A {0} log message", ["formatted"]);
```

<Alert title="Note">
During the experimental phase of the feature, we will provide more method overloads for convenient invocation in common scenarios.
Additionally, we may provide method overloads that are not based on _composite format strings_, but on _interpolated strings_.
</Alert>

<PlatformSection supported={["dotnet.aspnetcore, dotnet.azure-functions-worker, dotnet.blazor-webassembly, dotnet.extensions-logging, dotnet.maui"]}>

Additionally, when enabled and initialized, the SDK registers a [ILoggerProvider](https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.iloggerprovider)
that allows sending logs to Sentry via [ILogger<T>](https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger-1) instances resolved through _.NET dependency injection_.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: < and > are not supported within link text and will fail the include to parse/render


```csharp
public sealed class MyService(ILogger<MyService> logger)
{
public async Task InvokeAsync(HttpContext context)
{
logger.LogInformation("A simple log message");
await Task.Yield();
logger.LogError("A {Parameter} log message", "formatted");
await Task.Delay(TimeSpan.FromSeconds(1));
logger.LogWarning(new EventId(1, nameof(InvokeAsync)), "Message with EventId");
}
}
```

The `ILogger<T>`'s _CategoryName_, as well as the `EventId` (if provided), are attached as attributes to the logs.

For more information, see article on [Logging in C# and .NET](https://learn.microsoft.com//dotnet/core/extensions/logging).
Sentry Structured Logs also work with [High-performance logging in .NET](https://learn.microsoft.com/dotnet/core/extensions/high-performance-logging) and [Compile-time logging source generation](https://learn.microsoft.com/dotnet/core/extensions/logger-message-generator) alike.

</PlatformSection>

The SDK automatically provides a set of default attributes attached to your logs.
Additionally, you can attach custom attributes via a delegate.

```csharp
SentrySdk.Experimental.Logger.LogWarning("A log message with additional attributes.", [], static log =>
{
log.SetAttribute("my.attribute", "value");
});
```

<Alert title="Note">
Please note that we will revise the API shape to set custom attributes during the experimental phase of the feature.
</Alert>

Supported attribute types are:
- Textual: `string` and `char`
- Logical: `bool`
- Integral: `sbyte`, `byte`, `short`, `ushort`, `int`, `uint`, `long` and `nint`
- Floating-point: `float` and `double`

Unsupported numeric types such as `ulong`, `nuint`, `decimal`, as well as all other types including `object`, are treated as `string` via `ToString`.