public static IMotorHostBuilder ConfigureSerilog(this IMotorHostBuilder hostBuilder,
Action <HostBuilderContext, LoggerConfiguration>?configuration = null)
{
return((IMotorHostBuilder)hostBuilder
.ConfigureSentry()
.UseSerilog((hostingContext, loggerConfiguration) =>
{
var sentryOptions = new SentrySerilogOptions();
hostingContext.Configuration.GetSection("Sentry").Bind(sentryOptions);
loggerConfiguration
.ReadFrom.Configuration(hostingContext.Configuration)
.Enrich.FromLogContext()
.WriteTo.Console(new JsonFormatter(renderMessage: true))
.WriteTo.Sentry(opts =>
{
opts.Dsn = sentryOptions.Dsn;
opts.MinimumEventLevel = sentryOptions.MinimumEventLevel;
opts.MinimumBreadcrumbLevel = sentryOptions.MinimumBreadcrumbLevel;
opts.InitializeSdk = false;
});
configuration?.Invoke(hostingContext, loggerConfiguration);
})
.ConfigureServices((_, services) =>
{
services.AddLogging(loggingBuilder =>
{
loggingBuilder
.AddSerilog(dispose: true);
});
}));
}
public SentrySink(
SentrySerilogOptions options,
IDisposable?sdkDisposable)
: this(
options,
() => HubAdapter.Instance,
sdkDisposable,
SystemClock.Clock)
{
}
internal SentrySink(
SentrySerilogOptions options,
Func <IHub> hubAccessor,
IDisposable?sdkDisposable,
ISystemClock clock)
{
_options = options;
_hubAccessor = hubAccessor;
_clock = clock;
_sdkDisposable = sdkDisposable;
}
public static IMotorHostBuilder ConfigureSentry(this IMotorHostBuilder hostBuilder)
{
return(hostBuilder
.ConfigureServices((context, services) =>
{
var sentryOptions = new SentrySerilogOptions();
context.Configuration.GetSection("Sentry").Bind(sentryOptions);
SentrySdk.Init(sentryOptions);
services.AddTransient <IOptions <SentrySerilogOptions> >(_ => MSOptions.Create(sentryOptions));
}));
}
public static LoggerConfiguration Sentry(
this LoggerSinkConfiguration loggerConfiguration,
Action <SentrySerilogOptions> configureOptions)
{
var options = new SentrySerilogOptions();
configureOptions?.Invoke(options);
IDisposable sdkDisposable = null;
if (options.InitializeSdk)
{
sdkDisposable = SentrySdk.Init(options);
}
var minimumOverall = (LogEventLevel)Math.Min((int)options.MinimumBreadcrumbLevel, (int)options.MinimumEventLevel);
return(loggerConfiguration.Sink(new SentrySink(options, sdkDisposable), minimumOverall));
}
/// <summary>
/// Configure the Sentry Serilog Sink.
/// </summary>
/// <param name="sentrySerilogOptions">The logger configuration to configure with the given parameters.</param>
/// <param name="dsn">The Sentry DSN. <seealso cref="SentryOptions.Dsn"/></param>
/// <param name="minimumEventLevel">Minimum log level to send an event. <seealso cref="SentrySerilogOptions.MinimumEventLevel"/></param>
/// <param name="minimumBreadcrumbLevel">Minimum log level to record a breadcrumb. <seealso cref="SentrySerilogOptions.MinimumBreadcrumbLevel"/></param>
/// <param name="formatProvider">The Serilog format provider. <seealso cref="IFormatProvider"/></param>
/// <param name="sendDefaultPii">Whether to include default Personal Identifiable information. <seealso cref="SentryOptions.SendDefaultPii"/></param>
/// <param name="isEnvironmentUser">Whether to report the <see cref="System.Environment.UserName"/> as the User affected in the event. <seealso cref="SentryOptions.IsEnvironmentUser"/></param>
/// <param name="serverName">Gets or sets the name of the server running the application. <seealso cref="SentryOptions.ServerName"/></param>
/// <param name="attachStackTrace">Whether to send the stack trace of a event captured without an exception. <seealso cref="SentryOptions.AttachStacktrace"/></param>
/// <param name="maxBreadcrumbs">Gets or sets the maximum breadcrumbs. <seealso cref="SentryOptions.MaxBreadcrumbs"/></param>
/// <param name="sampleRate">The rate to sample events. <seealso cref="SentryOptions.SampleRate"/></param>
/// <param name="release">The release version of the application. <seealso cref="SentryOptions.Release"/></param>
/// <param name="environment">The environment the application is running. <seealso cref="SentryOptions.Environment"/></param>
/// <param name="maxQueueItems">The maximum number of events to keep while the worker attempts to send them. <seealso cref="SentryOptions.MaxQueueItems"/></param>
/// <param name="shutdownTimeout">How long to wait for events to be sent before shutdown. <seealso cref="SentryOptions.ShutdownTimeout"/></param>
/// <param name="decompressionMethods">Decompression methods accepted. <seealso cref="SentryOptions.DecompressionMethods"/></param>
/// <param name="requestBodyCompressionLevel">The level of which to compress the <see cref="SentryEvent"/> before sending to Sentry. <seealso cref="SentryOptions.RequestBodyCompressionLevel"/></param>
/// <param name="requestBodyCompressionBuffered">Whether the body compression is buffered and the request 'Content-Length' known in advance. <seealso cref="SentryOptions.RequestBodyCompressionBuffered"/></param>
/// <param name="debug">Whether to log diagnostics messages. <seealso cref="SentryOptions.Debug"/></param>
/// <param name="diagnosticsLevel">The diagnostics level to be used. <seealso cref="SentryOptions.DiagnosticsLevel"/></param>
/// <param name="reportAssemblies">Whether or not to include referenced assemblies in each event sent to sentry. Defaults to <see langword="true"/>. <seealso cref="SentryOptions.ReportAssemblies"/></param>
/// <param name="deduplicateMode">What modes to use for event automatic de-duplication. <seealso cref="SentryOptions.DeduplicateMode"/></param>
/// <param name="initializeSdk">Whether to initialize this SDK through this integration. <seealso cref="SentrySerilogOptions.InitializeSdk"/></param>
public static void ConfigureSentrySerilogOptions(
SentrySerilogOptions sentrySerilogOptions,
string?dsn = null,
LogEventLevel?minimumEventLevel = null,
LogEventLevel?minimumBreadcrumbLevel = null,
IFormatProvider?formatProvider = null,
bool?sendDefaultPii = null,
bool?isEnvironmentUser = null,
string?serverName = null,
bool?attachStackTrace = null,
int?maxBreadcrumbs = null,
float?sampleRate = null,
string?release = null,
string?environment = null,
int?maxQueueItems = null,
TimeSpan?shutdownTimeout = null,
DecompressionMethods?decompressionMethods = null,
CompressionLevel?requestBodyCompressionLevel = null,
bool?requestBodyCompressionBuffered = null,
bool?debug = null,
SentryLevel?diagnosticsLevel = null,
bool?reportAssemblies = null,
DeduplicateMode?deduplicateMode = null,
bool?initializeSdk = null)
{
if (!string.IsNullOrWhiteSpace(dsn))
{
sentrySerilogOptions.Dsn = dsn;
}
if (minimumEventLevel.HasValue)
{
sentrySerilogOptions.MinimumEventLevel = minimumEventLevel.Value;
}
if (minimumBreadcrumbLevel.HasValue)
{
sentrySerilogOptions.MinimumBreadcrumbLevel = minimumBreadcrumbLevel.Value;
}
if (formatProvider != null)
{
sentrySerilogOptions.FormatProvider = formatProvider;
}
if (sendDefaultPii.HasValue)
{
sentrySerilogOptions.SendDefaultPii = sendDefaultPii.Value;
}
if (isEnvironmentUser.HasValue)
{
sentrySerilogOptions.IsEnvironmentUser = isEnvironmentUser.Value;
}
if (!string.IsNullOrWhiteSpace(serverName))
{
sentrySerilogOptions.ServerName = serverName;
}
if (attachStackTrace.HasValue)
{
sentrySerilogOptions.AttachStacktrace = attachStackTrace.Value;
}
if (maxBreadcrumbs.HasValue)
{
sentrySerilogOptions.MaxBreadcrumbs = maxBreadcrumbs.Value;
}
if (sampleRate.HasValue)
{
sentrySerilogOptions.SampleRate = sampleRate;
}
if (!string.IsNullOrWhiteSpace(release))
{
sentrySerilogOptions.Release = release;
}
if (!string.IsNullOrWhiteSpace(environment))
{
sentrySerilogOptions.Environment = environment;
}
if (maxQueueItems.HasValue)
{
sentrySerilogOptions.MaxQueueItems = maxQueueItems.Value;
}
if (shutdownTimeout.HasValue)
{
sentrySerilogOptions.ShutdownTimeout = shutdownTimeout.Value;
}
if (decompressionMethods.HasValue)
{
sentrySerilogOptions.DecompressionMethods = decompressionMethods.Value;
}
if (requestBodyCompressionLevel.HasValue)
{
sentrySerilogOptions.RequestBodyCompressionLevel = requestBodyCompressionLevel.Value;
}
if (requestBodyCompressionBuffered.HasValue)
{
sentrySerilogOptions.RequestBodyCompressionBuffered = requestBodyCompressionBuffered.Value;
}
if (debug.HasValue)
{
sentrySerilogOptions.Debug = debug.Value;
}
if (diagnosticsLevel.HasValue)
{
sentrySerilogOptions.DiagnosticsLevel = diagnosticsLevel.Value;
}
if (reportAssemblies.HasValue)
{
sentrySerilogOptions.ReportAssemblies = reportAssemblies.Value;
}
if (deduplicateMode.HasValue)
{
sentrySerilogOptions.DeduplicateMode = deduplicateMode.Value;
}
// Serilog-specific items
if (initializeSdk.HasValue)
{
sentrySerilogOptions.InitializeSdk = initializeSdk.Value;
}
}
/// <summary>
/// Configure the Sentry Serilog Sink.
/// </summary>
/// <param name="sentrySerilogOptions">The logger configuration to configure with the given parameters.</param>
/// <param name="dsn">The Sentry DSN. <seealso cref="SentryOptions.Dsn"/></param>
/// <param name="minimumEventLevel">Minimum log level to send an event. <seealso cref="SentrySerilogOptions.MinimumEventLevel"/></param>
/// <param name="minimumBreadcrumbLevel">Minimum log level to record a breadcrumb. <seealso cref="SentrySerilogOptions.MinimumBreadcrumbLevel"/></param>
/// <param name="formatProvider">The Serilog format provider. <seealso cref="IFormatProvider"/></param>
/// <param name="textFormatter">The Serilog text formatter. <seealso cref="ITextFormatter"/></param>
/// <param name="sendDefaultPii">Whether to include default Personal Identifiable information. <seealso cref="SentryOptions.SendDefaultPii"/></param>
/// <param name="isEnvironmentUser">Whether to report the <see cref="System.Environment.UserName"/> as the User affected in the event. <seealso cref="SentryOptions.IsEnvironmentUser"/></param>
/// <param name="serverName">Gets or sets the name of the server running the application. <seealso cref="SentryOptions.ServerName"/></param>
/// <param name="attachStackTrace">Whether to send the stack trace of a event captured without an exception. <seealso cref="SentryOptions.AttachStacktrace"/></param>
/// <param name="maxBreadcrumbs">Gets or sets the maximum breadcrumbs. <seealso cref="SentryOptions.MaxBreadcrumbs"/></param>
/// <param name="sampleRate">The rate to sample events. <seealso cref="SentryOptions.SampleRate"/></param>
/// <param name="release">The release version of the application. <seealso cref="SentryOptions.Release"/></param>
/// <param name="environment">The environment the application is running. <seealso cref="SentryOptions.Environment"/></param>
/// <param name="maxQueueItems">The maximum number of events to keep while the worker attempts to send them. <seealso cref="SentryOptions.MaxQueueItems"/></param>
/// <param name="shutdownTimeout">How long to wait for events to be sent before shutdown. <seealso cref="SentryOptions.ShutdownTimeout"/></param>
/// <param name="decompressionMethods">Decompression methods accepted. <seealso cref="SentryOptions.DecompressionMethods"/></param>
/// <param name="requestBodyCompressionLevel">The level of which to compress the <see cref="SentryEvent"/> before sending to Sentry. <seealso cref="SentryOptions.RequestBodyCompressionLevel"/></param>
/// <param name="requestBodyCompressionBuffered">Whether the body compression is buffered and the request 'Content-Length' known in advance. <seealso cref="SentryOptions.RequestBodyCompressionBuffered"/></param>
/// <param name="debug">Whether to log diagnostics messages. <seealso cref="SentryOptions.Debug"/></param>
/// <param name="diagnosticLevel">The diagnostics level to be used. <seealso cref="SentryOptions.DiagnosticLevel"/></param>
/// <param name="reportAssemblies">Whether or not to include referenced assemblies in each event sent to sentry. Defaults to <see langword="true"/>. <seealso cref="SentryOptions.ReportAssemblies"/></param>
/// <param name="deduplicateMode">What modes to use for event automatic de-duplication. <seealso cref="SentryOptions.DeduplicateMode"/></param>
/// <param name="initializeSdk">Whether to initialize this SDK through this integration. <seealso cref="SentrySerilogOptions.InitializeSdk"/></param>
/// <param name="defaultTags">Defaults tags to add to all events. <seealso cref="SentryOptions.DefaultTags"/></param>
public static void ConfigureSentrySerilogOptions(
SentrySerilogOptions sentrySerilogOptions,
string?dsn = null,
LogEventLevel?minimumEventLevel = null,
LogEventLevel?minimumBreadcrumbLevel = null,
IFormatProvider?formatProvider = null,
ITextFormatter?textFormatter = null,
bool?sendDefaultPii = null,
bool?isEnvironmentUser = null,
string?serverName = null,
bool?attachStackTrace = null,
int?maxBreadcrumbs = null,
float?sampleRate = null,
string?release = null,
string?environment = null,
int?maxQueueItems = null,
TimeSpan?shutdownTimeout = null,
DecompressionMethods?decompressionMethods = null,
CompressionLevel?requestBodyCompressionLevel = null,
bool?requestBodyCompressionBuffered = null,
bool?debug = null,
SentryLevel?diagnosticLevel = null,
bool?reportAssemblies = null,
DeduplicateMode?deduplicateMode = null,
bool?initializeSdk = null,
Dictionary <string, string>?defaultTags = null)
{
if (!string.IsNullOrWhiteSpace(dsn))
{
sentrySerilogOptions.Dsn = dsn;
}
if (minimumEventLevel.HasValue)
{
sentrySerilogOptions.MinimumEventLevel = minimumEventLevel.Value;
}
if (minimumBreadcrumbLevel.HasValue)
{
sentrySerilogOptions.MinimumBreadcrumbLevel = minimumBreadcrumbLevel.Value;
}
if (formatProvider != null)
{
sentrySerilogOptions.FormatProvider = formatProvider;
}
if (textFormatter != null)
{
sentrySerilogOptions.TextFormatter = textFormatter;
}
if (sendDefaultPii.HasValue)
{
sentrySerilogOptions.SendDefaultPii = sendDefaultPii.Value;
}
if (isEnvironmentUser.HasValue)
{
sentrySerilogOptions.IsEnvironmentUser = isEnvironmentUser.Value;
}
if (!string.IsNullOrWhiteSpace(serverName))
{
sentrySerilogOptions.ServerName = serverName;
}
if (attachStackTrace.HasValue)
{
sentrySerilogOptions.AttachStacktrace = attachStackTrace.Value;
}
if (maxBreadcrumbs.HasValue)
{
sentrySerilogOptions.MaxBreadcrumbs = maxBreadcrumbs.Value;
}
if (sampleRate.HasValue)
{
sentrySerilogOptions.SampleRate = sampleRate;
}
if (!string.IsNullOrWhiteSpace(release))
{
sentrySerilogOptions.Release = release;
}
if (!string.IsNullOrWhiteSpace(environment))
{
sentrySerilogOptions.Environment = environment;
}
if (maxQueueItems.HasValue)
{
sentrySerilogOptions.MaxQueueItems = maxQueueItems.Value;
}
if (shutdownTimeout.HasValue)
{
sentrySerilogOptions.ShutdownTimeout = shutdownTimeout.Value;
}
if (decompressionMethods.HasValue)
{
sentrySerilogOptions.DecompressionMethods = decompressionMethods.Value;
}
if (requestBodyCompressionLevel.HasValue)
{
sentrySerilogOptions.RequestBodyCompressionLevel = requestBodyCompressionLevel.Value;
}
if (requestBodyCompressionBuffered.HasValue)
{
sentrySerilogOptions.RequestBodyCompressionBuffered = requestBodyCompressionBuffered.Value;
}
if (debug.HasValue)
{
sentrySerilogOptions.Debug = debug.Value;
}
if (diagnosticLevel.HasValue)
{
sentrySerilogOptions.DiagnosticLevel = diagnosticLevel.Value;
}
if (reportAssemblies.HasValue)
{
#pragma warning disable CS0618 // Type or member is obsolete
sentrySerilogOptions.ReportAssemblies = reportAssemblies.Value;
#pragma warning restore CS0618 // Type or member is obsolete
}
if (deduplicateMode.HasValue)
{
sentrySerilogOptions.DeduplicateMode = deduplicateMode.Value;
}
// Serilog-specific items
if (initializeSdk.HasValue)
{
sentrySerilogOptions.InitializeSdk = initializeSdk.Value;
}
if (defaultTags?.Any() == true)
{
foreach (var tag in defaultTags)
{
sentrySerilogOptions.DefaultTags.Add(tag.Key, tag.Value);
}
}
}
public void Ctor_MinimumBreadcrumbLevel_Information()
{
var sut = new SentrySerilogOptions();
Assert.Equal(LogEventLevel.Information, sut.MinimumBreadcrumbLevel);
}
public void Ctor_MinimumEventLevel_Error()
{
var sut = new SentrySerilogOptions();
Assert.Equal(LogEventLevel.Error, sut.MinimumEventLevel);
}
