Set Up Logs

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

Setup

To enable logging, you need to initialize the SDK with the Experimental.EnableLogs option set to true.

.WriteTo.Sentry(options =>
{
    options.Dsn = "https://examplePublicKey@o0.ingest.sentry.io/0";
    // Enable logs to be sent to Sentry
    options.Experimental.EnableLogs = true;
});

Usage

using (LogContext.PushProperty("Version", 5150))
{
    Log.Information("A simple log message");
    Log.Error("A {Parameter} log message", "formatted");
    Log.ForContext("Property", "Value").Warning("Message with Property");
}

Integrations

Available integrations:

• ASP.NET Core
• .NET Multi-platform App UI (.NET MAUI)
• Microsoft.Extensions.Logging
• Serilog

If there's an integration you would like to see, open a new issue on GitHub.

Options

Experimental.EnableLogs

Experimental.SetBeforeSendLog

To filter logs, or update them before they are sent to Sentry, you can use the Experimental.SetBeforeSendLog(Func<SentryLog, SentryLog?>) option.

options =>
{
    options.Dsn = "https://examplePublicKey@o0.ingest.sentry.io/0";
    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(Func<SentryLog, SentryLog?>) 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: Sets 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.

Default Attributes

The .NET SDK automatically sets several default attributes on all log entries to provide context and improve debugging:

Core Attributes

• environment: The environment set in the SDK if defined. This is sent from the SDK as sentry.environment.
• release: The release set in the SDK if defined. This is sent from the SDK as sentry.release.
• sdk.name: The name of the SDK that sent the log. This is sent from the SDK as sentry.sdk.name.
• sdk.version: The version of the SDK that sent the log. This is sent from the SDK as sentry.sdk.version.

Message Template Attributes

If the log was parameterized, Sentry adds the message template and parameters as log attributes.

• message.template: The parameterized template string. This is sent from the SDK as sentry.message.template.
• message.parameter.X: The parameters to fill the template string. X can either be the number that represent the parameter's position in the template string (sentry.message.parameter.0, sentry.message.parameter.1, etc) or the parameter's name (sentry.message.parameter.item_id, sentry.message.parameter.user_id, etc). This is sent from the SDK as sentry.message.parameter.X.

Server Attributes

• server.address: The address of the server that sent the log. Equivalent to server_name that gets attached to Sentry errors.

User Attributes

If user information is available in the current scope, the following attributes are added to the log:

• user.id: The user ID.
• user.name: The username.
• user.email: The email address.

Integration Attributes

If a log is generated by an SDK integration, the SDK will set additional attributes to help you identify the source of the log.

• origin: The origin of the log. This is sent from the SDK as sentry.origin.