Serilog.Sinks.SlackWebHook 1.2.0

Suggested Alternatives

jjm.one.Serilog.Sinks.SlackWebHook

Additional Details

The "Serilog.Sinks.SlackWebHook" package was renamed and moved to a new namespace: jjm.one.Serilog.Sinks.SlackWebHook

There is a newer version of this package available.
See the version list below for details.
dotnet add package Serilog.Sinks.SlackWebHook --version 1.2.0
NuGet\Install-Package Serilog.Sinks.SlackWebHook -Version 1.2.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.SlackWebHook" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Serilog.Sinks.SlackWebHook --version 1.2.0
#r "nuget: Serilog.Sinks.SlackWebHook, 1.2.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.SlackWebHook as a Cake Addin
#addin nuget:?package=Serilog.Sinks.SlackWebHook&version=1.2.0

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

Serilog.Sinks.SlackWebHook

A basic Slack Sink for the Serilog framework.

Status

Nuget Package Version Nuget Version
nuget.org Deployment nuget.org Deployment
Build Status Master Build Status Master
Build Status Develop Build status Develop
Test Status Master Test Status Master
Test Status Develop Test Status Master
Sonar Code Quality Sonar Code Quality
Maintenance Status Sonar Code Quality

Description

This tool provides a Serilog Sink which sends log messages to one or more channels in a Slack workspace. To send this messages this tool is using the Slack.Webhooks project to handle the communication with Slack. Therefor you need a valid WebHook URL to use this Sink. To get such a WebHook URL please read this article. The log messages will be send in batches to the slack servers. You can setup the batch size to fit your needs.

Nuget Package

You can get the latest version of this software as a nuget package form nuget.org

Installing the Nuget Package

Tool Command/Code
Package Manager PM> Install-Package Serilog.Sinks.SlackWebHook -Version X.Y.Z
.NET CLI > dotnet add package Serilog.Sinks.SlackWebHook --version X.Y.Z
PackageReference <PackageReference Include="Serilog.Sinks.SlackWebHook" Version="X.Y.Z" />
Package CLI > paket add Serilog.Sinks.SlackWebHook --version X.Y.Z

Dependencies

Usage

  1. Absolute basic usage:
Log.Logger = new LoggerConfiguration()
            .MinimumLevel.Verbose()
            .WriteTo.Slack(
                slackWebHookUrl: "https://...",
                slackChannel: null
            )
            .CreateLogger();
  1. Recommended usage:
var logLevelSwitch = new LoggingLevelSwitch(initialMinimumLevel: LogEventLevel.Verbose);
Log.Logger = new LoggerConfiguration()
                .MinimumLevel.Verbose()
                .WriteTo.Slack(
                    slackWebHookUrl: "https://...",
                    slackChannel: "log-output-channel",
                    slackUsername: "Serilog Slack Sink Bot",
                    slackEmojiIcon: ":monkey_face:",

                    periodicBatchingSinkOptionsBatchSizeLimit: 1,
                    periodicBatchingSinkOptionsPeriod: TimeSpan.FromMilliseconds(1000),
                    periodicBatchingSinkOptionsQueueLimit: 10000,

                    sinkRestrictedToMinimumLevel: LogEventLevel.Verbose,
                    sinkLevelSwitch:logLevelSwitch
                )
                .CreateLogger();
  1. Advanced usage (all available option exposed):
Log.Logger = new LoggerConfiguration()
                .MinimumLevel.Verbose()
                .WriteTo.Slack(
                    slackWebHookUrl: "https://...",
                    slackUsername: null,
                    slackEmojiIcon: null,
                    slackUriIcon: null,
                    slackChannels: null,
                    slackDeleteOriginal: null,
                    slackLinkNames: null,
                    slackMarkdown: null,
                    slackParseObj: null,
                    slackReplaceOriginal: null,
                    slackResponseType: null,
                    slackThreadId: null,
                    slackAttachmentColorsObj: null,
                    slackAttachmentFooterIconObj: null,
                    slackAddShortInfoAttachment: null,
                    slackDisplayShortInfoAttachmentShort: null,
                    slackAddExtendedInfoAttachment: null,
                    slackDisplayExtendedInfoAttachmentShort: null,
                    slackAddExceptionAttachment: null,
                    slackDisplayExceptionAttachmentShort: null,
                    slackConnectionTimeout: null,
                    slackHttpClientObj: null,
                    generateSlackFunctions: null,
                    periodicBatchingSinkOptionsBatchSizeLimit: null,
                    periodicBatchingSinkOptionsPeriod: null,
                    periodicBatchingSinkOptionsQueueLimit: null,
                    sinkRestrictedToMinimumLevel: null,
                    sinkOutputTemplate: null,
                    sinkLevelSwitch: null,
                    sinkFormatProvider: null,
                    sinkActivationSwitch: null
                )
                .CreateLogger();
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 was computed.  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 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  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

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.4.1 2,761 6/5/2023
1.4.0 634 12/21/2022
1.3.0 1,520 11/16/2021
1.2.0 17,916 11/16/2020
1.1.0 475 11/10/2020
1.0.4 3,386 4/28/2020
1.0.3 519 4/24/2020
1.0.2 506 4/22/2020
1.0.1 510 4/22/2020
1.0.0 522 4/20/2020