Serilog.Sinks.Raygun 8.0.0

dotnet add package Serilog.Sinks.Raygun --version 8.0.0                
NuGet\Install-Package Serilog.Sinks.Raygun -Version 8.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Serilog.Sinks.Raygun" Version="8.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Serilog.Sinks.Raygun --version 8.0.0                
#r "nuget: Serilog.Sinks.Raygun, 8.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Serilog.Sinks.Raygun as a Cake Addin
#addin nuget:?package=Serilog.Sinks.Raygun&version=8.0.0

// Install Serilog.Sinks.Raygun as a Cake Tool
#tool nuget:?package=Serilog.Sinks.Raygun&version=8.0.0                

serilog-sinks-raygun

Serilog Sinks error and performance monitoring with Raygun is available using the serilog-sinks-raygun provider.

serilog-sinks-raygun is a library that you can easily add to your website or web application, which will then monitor your application and display all Serilog errors and issues affecting your users within your Raygun account. Installation is painless.

The provider is a single package (Serilog.Sinks.Raygun) which includes the sole dependency (Serilog), allowing you to drop it straight in.

Getting started

Step 1 - Add packages

Install the Serilog (if not included already) and Serilog.Sinks.Raygun package into your project. You can either use the below dotnet CLI command, or the NuGet management GUI in the IDE you use.

 dotnet add package Serilog
 dotnet add package Serilog.Sinks.Raygun

Step 2 - Initialization

The following examples are for .NET 6.0+ applications. For other frameworks, please refer to the .NET Framework Readme.

Example of setup for ASP.NET Applications:

using Mindscape.Raygun4Net.AspNetCore;
using Serilog;

var builder = WebApplication.CreateBuilder(args);

// Add Raygun
builder.Services.AddRaygun(builder.Configuration);
builder.Services.AddRaygunUserProvider();

builder.Host.UseSerilog((context, provider, config) =>
{
    // Add the Raygun sink
    config.WriteTo.Raygun(raygunClient: provider.GetRequiredService<RaygunClient>());
});

Example of setup for Console/Service:

using Mindscape.Raygun4Net;
using Serilog;
using Serilog.Sinks.Raygun.Extensions;

var host = Host.CreateDefaultBuilder(args)
    .ConfigureServices((context, services) =>
    {
        // Add Raygun
        services.AddRaygun(context.Configuration);
        services.AddHostedService<Worker>();
    })
    .UseSerilog((_, serviceProvider, config) =>
    {
        // Add the Raygun sink
        config.WriteTo.Raygun(raygunClient: serviceProvider.GetRequiredService<RaygunClient>());
    })
    .Build();

await host.RunAsync();

Example of setup for MAUI:

using Serilog;

var builder = MauiApp.CreateBuilder();

builder
    .UseMauiApp<App>()

    // Add Raygun
    .AddRaygun();

var app = builder.Build();

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Debug()

    // Add the Raygun sink
    .WriteTo.Raygun(raygunClient: app.Services.GetRequiredService<RaygunMauiClient>())
    .CreateLogger();

return app;

Configuration Properties

raygunClient

type: RaygunClientBase

required

This property is required for the Raygun Sink to function. The client can be any implementation that inherits from RaygunClientBase, this could be the Raygun4Maui client, Raygun4Net.AspNetCore client, or Raygun4Net.NetCore client. Ideally, this is resolved from the ServiceCollection in .NET Core applications.

formatProvider

type: IFormatProvider

default: null

This property supplies culture-specific formatting information. By default, it is null.

restrictedToMinimumLevel

type: LogEventLevel

default: LogEventLevel.Error

You can set the minimum log event level required in order to write an event to the sink. By default, this is set to Error as Raygun is mostly used for error reporting.


Enrich with HTTP request and response data

Properties included from other Serilog Enrichers should automatically be included into the Raygun errors.

To use the old Raygun Enricher you can follow the Enricher Readme to add the enricher to your project.

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Serilog.Sinks.Raygun:

Package Downloads
UniLogger

Logger for MVC and Core applications

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
8.0.0 5,616 8/25/2024
7.6.0-pre-1 224 8/13/2024
7.5.0 29,540 2/12/2024
7.5.0-pre-1 105 2/1/2024
7.4.0 17,820 1/22/2024
7.4.0-pre-1 107 1/17/2024
7.3.0 9,260 11/14/2023
7.3.0-pre-2 142 11/10/2023
7.3.0-pre-1 143 11/10/2023
7.2.0-pre-1 146 10/25/2023
7.1.0 7,266 10/9/2023
7.0.0 625 9/21/2023
7.0.0-pre-2 157 9/20/2023
7.0.0-pre-1 125 9/15/2023
5.3.3 32,127 6/15/2023
5.3.1 19,457 5/18/2023
5.3.0 1,648 4/28/2023
5.2.0 1,997 3/29/2023
5.1.1 135,442 3/3/2022
5.1.1-dev-00108 197 3/3/2022
5.1.1-dev-00107 184 3/3/2022
5.1.0 1,955 2/4/2022
5.1.0-dev-00102 180 2/4/2022
5.0.3-dev-00101 189 2/4/2022
5.0.3-dev-00097 188 1/16/2022
5.0.3-dev-00089 355 6/22/2021
5.0.2 406,698 6/21/2021
5.0.2-dev-00086 265 6/21/2021
5.0.2-dev-00083 310 6/21/2021
5.0.1 442,978 10/26/2020
5.0.1-dev-00074 416 10/26/2020
5.0.0 642 10/26/2020
4.0.1-dev-00070 386 10/26/2020
4.0.1-dev-00056 415 10/1/2020
4.0.1-dev-00048 401 9/1/2020
4.0.1-dev-00045 412 8/16/2020
4.0.1-dev-00040 361 8/10/2020
4.0.1-dev-00039 379 8/10/2020
4.0.1-dev-00038 367 8/10/2020
4.0.0 292,074 2/18/2020
4.0.0-dev-00029 5,333 7/16/2019
3.0.1-dev-00026 28,720 9/5/2018
3.0.1-dev-00024 1,202 7/13/2018
3.0.1-dev-00022 827 5/9/2018
3.0.1-dev-00021 3,953 4/30/2018
3.0.0 723,711 12/6/2017
2.0.15 37,628 5/22/2017
2.0.13 15,003 1/12/2017
1.5.10 10,730 9/30/2016
1.5.8 17,657 12/16/2015
1.5.6 4,121 5/14/2015
1.5.3 1,708 4/1/2015
1.5.2 1,201 3/30/2015
1.5.1 1,165 3/27/2015
1.4.196 1,672 2/22/2015
1.4.182 1,440 2/15/2015
1.4.168 1,295 2/8/2015
1.4.155 1,148 2/1/2015
1.4.139 1,206 1/23/2015
1.4.118 1,207 1/13/2015
1.4.113 1,135 1/6/2015
1.4.102 1,476 12/21/2014
1.4.99 2,001 12/18/2014
1.4.97 1,474 12/18/2014
1.4.76 1,402 12/8/2014
1.4.39 1,737 11/26/2014
1.4.34 1,331 11/24/2014
1.4.28 1,296 11/24/2014
1.4.27 1,323 11/23/2014
1.4.23 1,382 11/21/2014
1.4.21 1,313 11/21/2014
1.4.18 1,539 11/18/2014
1.4.15 2,230 11/4/2014
1.4.14 1,229 10/23/2014
1.4.13 1,153 10/23/2014
1.4.12 1,223 10/12/2014
1.4.11 1,198 10/8/2014
1.4.10 1,168 9/26/2014
1.4.9 1,185 9/17/2014
1.4.8 1,152 9/11/2014
1.4.7 1,177 9/1/2014
1.4.6 1,127 8/31/2014
1.4.5 1,167 8/27/2014
1.4.4 1,208 8/27/2014
1.4.3 1,253 8/25/2014
1.4.2 1,211 8/23/2014
1.4.1 1,189 8/23/2014
1.3.43 1,269 8/4/2014
1.3.42 1,159 7/30/2014
1.3.41 1,155 7/28/2014
1.3.40 1,144 7/26/2014
1.3.39 1,188 7/25/2014
1.3.36 1,173 7/20/2014
1.3.35 1,169 7/17/2014
1.3.34 1,187 7/6/2014
1.3.33 1,194 6/30/2014
1.3.30 1,216 6/19/2014
1.3.29 1,247 6/19/2014
1.3.28 1,188 6/19/2014
1.3.27 1,153 6/18/2014
1.3.25 1,222 6/9/2014
1.3.24 1,213 5/21/2014
1.3.23 1,172 5/20/2014
1.3.20 1,216 5/18/2014
1.3.19 1,256 5/17/2014
1.3.18 1,204 5/17/2014
1.3.17 1,331 5/17/2014
1.3.16 1,164 5/17/2014
1.3.15 1,196 5/16/2014
1.3.14 1,201 5/16/2014
1.3.13 1,236 5/16/2014
1.3.12 1,202 5/14/2014