Skip to content
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.

Sign up for GitHub

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

Feature/clean up #38

Merged
merged 3 commits into from
Nov 2, 2023
Merged

Feature/clean up #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1caed84
CleanUp and Fix all
jonas-merkle Oct 19, 2023
6770799
more nullable added
jonas-merkle Oct 19, 2023
46462b4
fixes namespaces
jonas-merkle Nov 2, 2023
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
36 changes: 21 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,36 @@ A basic Slack Sink for the Serilog framework.

## Status

| | |
|----------------------:|-----------------------|
| Build & Test Status (main) | [![Build&Test](https://github.com/jjm-one/jjm.one.Serilog.Sinks.SlackWebHook/actions/workflows/dotnet.yml/badge.svg)](https://github.com/jjm-one/jjm.one.Serilog.Sinks.SlackWebHook/actions/workflows/dotnet.yml) |
| Nuget Package Version | [![Nuget Version](https://img.shields.io/nuget/v/jjm.one.Serilog.Sinks.SlackWebHook?style=flat-square)](https://www.nuget.org/packages/jjm.one.Serilog.Sinks.SlackWebHook/) |
| | |
|------------------------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Build & Test Status (main) | [![Build&Test](https://github.com/jjm-one/jjm.one.Serilog.Sinks.SlackWebHook/actions/workflows/dotnet.yml/badge.svg)](https://github.com/jjm-one/jjm.one.Serilog.Sinks.SlackWebHook/actions/workflows/dotnet.yml) |
| Nuget Package Version | [![Nuget Version](https://img.shields.io/nuget/v/jjm.one.Serilog.Sinks.SlackWebHook?style=flat-square)](https://www.nuget.org/packages/jjm.one.Serilog.Sinks.SlackWebHook/) |
| SonarCloudQuality Gate Status | [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=jjm-one_jjm.one.Serilog.Sinks.SlackWebHook&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=jjm-one_jjm.one.Serilog.Sinks.SlackWebHook) |

## 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](https://github.com/mrb0nj/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](https://slack.com/help/articles/115005265063-Incoming-Webhooks-for-Slack). The log messages will be send in batches to the slack servers. You can setup the batch size to fit your needs.
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](https://github.com/mrb0nj/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](https://slack.com/help/articles/115005265063-Incoming-Webhooks-for-Slack). 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](https://www.nuget.org/packages/jjm.one.Serilog.Sinks.SlackWebHook/)
You can get the latest version of this software as a nuget package
form [nuget.org](https://www.nuget.org/packages/jjm.one.Serilog.Sinks.SlackWebHook/)

### Installing the Nuget Package

| Tool | Command/Code |
|----------------------|--------------|
| Package Manager | ```PM> Install-Package jjm.one.Serilog.Sinks.SlackWebHook -Version X.Y.Z``` |
| .NET CLI | ```> dotnet add package jjm.one.Serilog.Sinks.SlackWebHook --version X.Y.Z``` |
| Tool | Command/Code |
|----------------------|-----------------------------------------------------------------------------------------|
| Package Manager | ```PM> Install-Package jjm.one.Serilog.Sinks.SlackWebHook -Version X.Y.Z``` |
| .NET CLI | ```> dotnet add package jjm.one.Serilog.Sinks.SlackWebHook --version X.Y.Z``` |
| PackageReference | ```<PackageReference Include="jjm.one.Serilog.Sinks.SlackWebHook" Version="X.Y.Z" />``` |
| Package CLI | ```> paket add jjm.one.Serilog.Sinks.SlackWebHook --version X.Y.Z``` |
| Script & Interactive | ```> #r "nuget: jjm.one.Serilog.Sinks.SlackWebHook, X.Y.Z"``` |
| Cake as Addin | ```#addin nuget:?package=jjm.one.Serilog.Sinks.SlackWebHook&version=X.Y.Z``` |
| Cake as Tool | ```#tool nuget:?package=jjm.one.Serilog.Sinks.SlackWebHook&version=X.Y.Z``` |
| Package CLI | ```> paket add jjm.one.Serilog.Sinks.SlackWebHook --version X.Y.Z``` |
| Script & Interactive | ```> #r "nuget: jjm.one.Serilog.Sinks.SlackWebHook, X.Y.Z"``` |
| Cake as Addin | ```#addin nuget:?package=jjm.one.Serilog.Sinks.SlackWebHook&version=X.Y.Z``` |
| Cake as Tool | ```#tool nuget:?package=jjm.one.Serilog.Sinks.SlackWebHook&version=X.Y.Z``` |

## Dependencies

Expand Down Expand Up @@ -120,7 +125,8 @@ Log.Logger = new LoggerConfiguration()

## Full Documentation

The full documentation for this package can be found [here](https://jjm-one.github.io/jjm.one.Serilog.Sinks.SlackWebHook/main/doc/html/index.html).
The full documentation for this package can be
found [here](https://jjm-one.github.io/jjm.one.Serilog.Sinks.SlackWebHook/main/doc/html/index.html).

## Repo

Expand Down
169 changes: 89 additions & 80 deletions src/jjm.one.Serilog.Sinks.SlackWebHook.Example/SlackSinkExample.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,88 +1,97 @@
using Serilog;
using System;
using System.Threading;
using Serilog;
using Serilog.Core;
using Serilog.Events;
using System;

namespace jjm.one.Serilog.Sinks.SlackWebHook.Example
namespace jjm.one.Serilog.Sinks.SlackWebHook.Example;

/// <summary>
/// This class contains examples on how to use the library.
/// </summary>
public static class SlackSinkExample
{
public static class SlackSinkExample
/// <summary>
/// The main function of the <see cref="SlackSinkExample"/> class.
/// </summary>
/// <exception cref="ArgumentException"></exception>
/// <exception cref="Exception"></exception>
public static void Main()
{
public static void Main()
string? slackChannel = null;

Console.WriteLine(
"####################################################################################################");
Console.WriteLine("Serilog Slack Sink Example (ver. " + typeof(SlackSinkExample).Assembly.GetName().Version +
")");
Console.WriteLine(
"####################################################################################################");
Console.WriteLine();

Console.Write("Slack WebHook Url: ");
var input = Console.ReadLine();
if (string.IsNullOrEmpty(input)) throw new ArgumentException("No valid WebHook Url!");
var slackWebHookUrl = input;
Console.WriteLine();

Console.Write("Slack Channel (optional): ");
input = Console.ReadLine();
if (!string.IsNullOrEmpty(input)) slackChannel = input;
Console.WriteLine();

Console.Write("Slack Username (optional): ");
input = Console.ReadLine();
var slackUsername = string.IsNullOrEmpty(input) ? input : "Serilog Slack Sink Example";
Console.WriteLine();

Console.Write("Slack User Icon (optional): ");
input = Console.ReadLine();
var slackUserIcon = string.IsNullOrEmpty(input) ? input : ":monkey_face:";
Console.WriteLine();

var levelSwitch = new LoggingLevelSwitch(LogEventLevel.Verbose);

Log.Logger = new LoggerConfiguration()
.MinimumLevel.Verbose()
.WriteTo.Slack(
slackWebHookUrl,
slackChannel,
slackUsername,
slackUserIcon,
periodicBatchingSinkOptionsBatchSizeLimit: 1,
periodicBatchingSinkOptionsPeriod: TimeSpan.FromMilliseconds(10),
periodicBatchingSinkOptionsQueueLimit: 100,
sinkRestrictedToMinimumLevel: LogEventLevel.Verbose,
sinkOutputTemplate: "{Message}",
sinkLevelSwitch: levelSwitch
)
.CreateLogger();

Log.Write(LogEventLevel.Verbose, "Verbose Logging Message");
Log.Write(LogEventLevel.Debug, "Debug Logging Message");
Log.Write(LogEventLevel.Information, "Information Logging Message");
Log.Write(LogEventLevel.Warning, "Warning Logging Message");
Log.Write(LogEventLevel.Error, "Error Logging Message");
Log.Write(LogEventLevel.Fatal, "Fatal Logging Message");

try
{
throw new Exception("TEST EXCEPTION!");
}
catch (Exception e)
{
string slackChannel = null;

Console.WriteLine("####################################################################################################");
Console.WriteLine("Serilog Slack Sink Example (ver. " + typeof(SlackSinkExample).Assembly.GetName().Version + ")");
Console.WriteLine("####################################################################################################");
Console.WriteLine();

Console.Write("Slack WebHook Url: ");
var input = Console.ReadLine();
if (string.IsNullOrEmpty(input)) throw new ArgumentException("No valid WebHook Url!");
var slackWebHookUrl = input;
Console.WriteLine();

Console.Write("Slack Channel (optional): ");
input = Console.ReadLine();
if (!string.IsNullOrEmpty(input)) slackChannel = input;
Console.WriteLine();

Console.Write("Slack Username (optional): ");
input = Console.ReadLine();
var slackUsername = string.IsNullOrEmpty(input) ? input : "Serilog Slack Sink Example";
Console.WriteLine();

Console.Write("Slack User Icon (optional): ");
input = Console.ReadLine();
var slackUserIcon = string.IsNullOrEmpty(input) ? input : ":monkey_face:";
Console.WriteLine();

var levelSwitch = new LoggingLevelSwitch(initialMinimumLevel: LogEventLevel.Verbose);

Log.Logger = new LoggerConfiguration()
.MinimumLevel.Verbose()
.WriteTo.Slack(
slackWebHookUrl: slackWebHookUrl,
slackChannel: slackChannel,
slackUsername: slackUsername,
slackEmojiIcon: slackUserIcon,

periodicBatchingSinkOptionsBatchSizeLimit: 1,
periodicBatchingSinkOptionsPeriod: TimeSpan.FromMilliseconds(10),
periodicBatchingSinkOptionsQueueLimit: 100,

sinkRestrictedToMinimumLevel: LogEventLevel.Verbose,
sinkOutputTemplate: "{Message}",
sinkLevelSwitch: levelSwitch
)
.CreateLogger();

Log.Write(LogEventLevel.Verbose, "Verbose Logging Message");
Log.Write(LogEventLevel.Debug, "Debug Logging Message");
Log.Write(LogEventLevel.Information, "Information Logging Message");
Log.Write(LogEventLevel.Warning, "Warning Logging Message");
Log.Write(LogEventLevel.Error, "Error Logging Message");
Log.Write(LogEventLevel.Fatal, "Fatal Logging Message");

try
{
throw new Exception("TEST EXCEPTION!");
}
catch (Exception e)
{
Log.Write(LogEventLevel.Fatal, e, "Fatal Logging Message with exception");
}

levelSwitch.MinimumLevel = LogEventLevel.Fatal;

Log.Write(LogEventLevel.Error, "This Message shouldn't be send to Slack!");

System.Threading.Thread.Sleep(10000);

Console.WriteLine("Press any key to finish...");
Console.ReadKey();

Environment.Exit(0);
Log.Write(LogEventLevel.Fatal, e, "Fatal Logging Message with exception");
}

levelSwitch.MinimumLevel = LogEventLevel.Fatal;

Log.Write(LogEventLevel.Error, "This Message shouldn't be send to Slack!");

Thread.Sleep(10000);

Console.WriteLine("Press any key to finish...");
Console.ReadKey();

Environment.Exit(0);
}
}
}
12 changes: 12 additions & 0 deletions src/jjm.one.Serilog.Sinks.SlackWebHook.Example/jjm.one.MiscUtilFunctions.Tests.xml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

61 changes: 30 additions & 31 deletions ....one.Serilog.Sinks.SlackWebHook.Example/jjm.one.Serilog.Sinks.SlackWebHook.Example.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +1,37 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net7.0</TargetFramework>
<ImplicitUsings>disable</ImplicitUsings>
<Nullable>enable</Nullable>
<Version>2.0.2</Version>
<Authors>Jonas Merkle [JJM] </Authors>
<Copyright>© by Jonas Merkle [JJM], 2023.</Copyright>
<RootNamespace>jm.one.Serilog.Sinks.SlackWebHook.Example</RootNamespace>
<Title>jm.one.Serilog.Sinks.SlackWebHook.Example</Title>
<Description>A basic Slack Sink for the Serilog framwork. (Example)</Description>
<PackageTags>serilog, serilog-sink, slack, logging, csharp, example</PackageTags>
<PackageProjectUrl>https://github.com/jjm-one/jjm.one.Serilog.Sinks.SlackWebHook</PackageProjectUrl>
<RepositoryType>git</RepositoryType>
<RepositoryUrl>https://github.com/jjm-one/jjm.one.Serilog.Sinks.SlackWebHook</RepositoryUrl>
<IsPackable>false</IsPackable>
<IsTestProject>false</IsTestProject>
</PropertyGroup>
<PropertyGroup>
<TargetFramework>net7.0</TargetFramework>
<ImplicitUsings>disable</ImplicitUsings>
<Nullable>enable</Nullable>
<Version>2.1.0</Version>
<Authors>Jonas Merkle [JJM]</Authors>
<Copyright>© by Jonas Merkle [JJM], 2023.</Copyright>
<Title>jjm.one.Serilog.Sinks.SlackWebHook.Example</Title>
<Description>A basic Slack Sink for the Serilog framwork. (Example)</Description>
<PackageTags>serilog, serilog-sink, slack, logging, csharp, example</PackageTags>
<PackageProjectUrl>https://github.com/jjm-one/jjm.one.Serilog.Sinks.SlackWebHook</PackageProjectUrl>
<RepositoryType>git</RepositoryType>
<RepositoryUrl>https://github.com/jjm-one/jjm.one.Serilog.Sinks.SlackWebHook</RepositoryUrl>
<IsPackable>false</IsPackable>
<IsTestProject>false</IsTestProject>
</PropertyGroup>

<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
<LangVersion>latestmajor</LangVersion>
<DocumentationFile>./jjm.one.MiscUtilFunctions.Tests.xml</DocumentationFile>
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
<LangVersion>latestmajor</LangVersion>
<DocumentationFile>./jjm.one.MiscUtilFunctions.Tests.xml</DocumentationFile>
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
<LangVersion>latestmajor</LangVersion>
<DocumentationFile>./jjm.one.MiscUtilFunctions.Tests.xml</DocumentationFile>
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
<LangVersion>latestmajor</LangVersion>
<DocumentationFile>./jjm.one.MiscUtilFunctions.Tests.xml</DocumentationFile>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Serilog" Version="3.0.1" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="Serilog" Version="3.0.1"/>
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\jjm.one.Serilog.Sinks.SlackWebHook\jjm.one.Serilog.Sinks.SlackWebHook.csproj" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\jjm.one.Serilog.Sinks.SlackWebHook\jjm.one.Serilog.Sinks.SlackWebHook.csproj"/>
</ItemGroup>

</Project>
Loading
Loading