diff --git a/Doxyfile b/Doxyfile index 636145c..bc19b28 100644 --- a/Doxyfile +++ b/Doxyfile @@ -48,7 +48,7 @@ PROJECT_NAME = Serilog.Sinks.SlackWebHook # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 1.4.2 +PROJECT_NUMBER = 2.0.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/LICENSE.txt b/LICENSE similarity index 100% rename from LICENSE.txt rename to LICENSE diff --git a/src/jjm.one.Serilog.Sinks.SlackWebHook.Example/jjm.one.MiscUtilFunctions.Tests.xml b/src/jjm.one.Serilog.Sinks.SlackWebHook.Example/jjm.one.MiscUtilFunctions.Tests.xml new file mode 100644 index 0000000..2e5c556 --- /dev/null +++ b/src/jjm.one.Serilog.Sinks.SlackWebHook.Example/jjm.one.MiscUtilFunctions.Tests.xml @@ -0,0 +1,8 @@ + + + + jjm.one.Serilog.Sinks.SlackWebHook.Example + + + + diff --git a/src/jjm.one.Serilog.Sinks.SlackWebHook.Example/jjm.one.Serilog.Sinks.SlackWebHook.Example.csproj b/src/jjm.one.Serilog.Sinks.SlackWebHook.Example/jjm.one.Serilog.Sinks.SlackWebHook.Example.csproj index d2a971f..ab8cf63 100644 --- a/src/jjm.one.Serilog.Sinks.SlackWebHook.Example/jjm.one.Serilog.Sinks.SlackWebHook.Example.csproj +++ b/src/jjm.one.Serilog.Sinks.SlackWebHook.Example/jjm.one.Serilog.Sinks.SlackWebHook.Example.csproj @@ -1,31 +1,34 @@ - net7 - false - LICENSE.txt - Jonas Merkle [JJM] - A example for the basic Slack Sink for the Serilog framwork. + net7.0 + disable + enable + 2.0.0 + Jonas Merkle [JJM] © by Jonas Merkle [JJM], 2023. - https://github.com/jjm-one/jjm.one.Serilog.Sinks.SlackWebHook - GitHub + jm.one.Serilog.Sinks.SlackWebHook.Example + jm.one.Serilog.Sinks.SlackWebHook.Example + A basic Slack Sink for the Serilog framwork. (Example) serilog, serilog-sink, slack, logging, csharp, example https://github.com/jjm-one/jjm.one.Serilog.Sinks.SlackWebHook - jjm.one.Serilog.Sinks.SlackWebHook.Example - jjm.one.Serilog.Sinks.SlackWebHook.Example - 1.4.2 - Exe + git + https://github.com/jjm-one/jjm.one.Serilog.Sinks.SlackWebHook + false + false - - - + + latestmajor + ./jjm.one.MiscUtilFunctions.Tests.xml + + + latestmajor + ./jjm.one.MiscUtilFunctions.Tests.xml + - - True - - + diff --git a/src/jjm.one.Serilog.Sinks.SlackWebHook.Tests/jjm.one.MiscUtilFunctions.Tests.xml b/src/jjm.one.Serilog.Sinks.SlackWebHook.Tests/jjm.one.MiscUtilFunctions.Tests.xml new file mode 100644 index 0000000..4e526d0 --- /dev/null +++ b/src/jjm.one.Serilog.Sinks.SlackWebHook.Tests/jjm.one.MiscUtilFunctions.Tests.xml @@ -0,0 +1,8 @@ + + + + jjm.one.Serilog.Sinks.SlackWebHook.Tests + + + + diff --git a/src/jjm.one.Serilog.Sinks.SlackWebHook.Tests/jjm.one.Serilog.Sinks.SlackWebHook.Tests.csproj b/src/jjm.one.Serilog.Sinks.SlackWebHook.Tests/jjm.one.Serilog.Sinks.SlackWebHook.Tests.csproj index 136f1c7..0303711 100644 --- a/src/jjm.one.Serilog.Sinks.SlackWebHook.Tests/jjm.one.Serilog.Sinks.SlackWebHook.Tests.csproj +++ b/src/jjm.one.Serilog.Sinks.SlackWebHook.Tests/jjm.one.Serilog.Sinks.SlackWebHook.Tests.csproj @@ -1,19 +1,30 @@ - net7 - false - LICENSE.txt - Jonas Merkle [JJM] - Unit Tests for a basic Slack Sink for the Serilog framwork. + net7.0 + disable + enable + 2.0.0 + Jonas Merkle [JJM] © by Jonas Merkle [JJM], 2023. - https://github.com/jjm-one/jjm.one.Serilog.Sinks.SlackWebHook - GitHub + jm.one.Serilog.Sinks.SlackWebHook.Tests + jm.one.Serilog.Sinks.SlackWebHook.Tests + A basic Slack Sink for the Serilog framwork. (Unit-Tests) serilog, serilog-sink, slack, logging, csharp, unit-tests https://github.com/jjm-one/jjm.one.Serilog.Sinks.SlackWebHook - jjm.one.Serilog.Sinks.SlackWebHook.Tests - jjm.one.Serilog.Sinks.SlackWebHook.Tests - 1.4.2 + git + https://github.com/jjm-one/jjm.one.Serilog.Sinks.SlackWebHook + false + true + + + + latestmajor + ./jjm.one.MiscUtilFunctions.Tests.xml + + + latestmajor + ./jjm.one.MiscUtilFunctions.Tests.xml @@ -27,13 +38,6 @@ - - - True - - - - diff --git a/src/jjm.one.Serilog.Sinks.SlackWebHook/jjm.one.Serilog.Extensions.Logging.Helpers.xml b/src/jjm.one.Serilog.Sinks.SlackWebHook/jjm.one.Serilog.Extensions.Logging.Helpers.xml new file mode 100644 index 0000000..53a1576 --- /dev/null +++ b/src/jjm.one.Serilog.Sinks.SlackWebHook/jjm.one.Serilog.Extensions.Logging.Helpers.xml @@ -0,0 +1,419 @@ + + + + jjm.one.Serilog.Sinks.SlackWebHook + + + + + extension that provides configuration chaining. + + Instance of object. + Slack WebHook URL (required). + Name of the Slack channel in which the log message should be posted (recommended). + Slack username (recommended). + Slack user-icon emoji string (recommended). + Slack user-icon image URI (optional). + Slack message option 'DeleteOriginal' (optional). + Slack message option 'LinkNames' (optional). + Slack message option 'Markdown' (optional). + Slack message option 'Parse' as + Slack message option 'ReplaceOriginal' (optional). + Slack message option 'ResponseType' (optional). + Slack message option 'ThreadID' (optional). + Slack message attachment color list as (optional). + Slack message attachment footer icon list as (optional). + Add the short info attachment to the log message (optional). + Display the short info attachment in short form (optional). + Add the extended info attachment to the log message (optional). + Display the extended info attachment in short form (optional). + Add the short exception to the log message (optional). + Display the exception attachment in short form (optional). + Timeout for the connection to the Slack servers (optional). + The instance which the uses. + A containing custom functions [Item1 for message text generation, Item2 for message attachment list generation, Item3 for message block list generation] for the Slack message generation (optional). + Size of the batch of messages that get send at once to Slack (recommended). + Time period between sending of batches of messages (recommended). + Maximum size of the queue that stores the messages before the messages were send in batches to Slack (optional). + The absolute minimum a log message must have to be send to Slack (optional). + The template for the output format of the log messages (optional). + A to change the minimum a log message must have to be send to Slack (optional). + A format provider (optional). + A Switch to change the activation status of the sink on the fly (optional). + Instance of object. + + + + extension that provides configuration chaining. + + Instance of object. + Slack WebHook URL. + Slack username (recommended). + Slack user-icon emoji string (optional). + Slack user-icon image URI (optional). + A containing the name of all Slack channels in which the log message should be posted (recommended). + Slack message option 'DeleteOriginal' (optional). + Slack message option 'LinkNames' (optional). + Slack message option 'Markdown' (optional). + Slack message option 'Parse' as + Slack message option 'ReplaceOriginal' (optional). + Slack message option 'ResponseType' (optional). + Slack message option 'ThreadID' (optional). + Slack message attachment color list as (optional). + Slack message attachment footer icon list as (optional). + Add the short info attachment to the log message (optional). + Display the short info attachment in short form (optional). + Add the extended info attachment to the log message (optional). + Display the extended info attachment in short form (optional). + Add the short exception to the log message (optional). + Display the exception attachment in short form (optional). + Timeout for the connection to the Slack servers (optional). + The instance which the uses. + A containing custom functions [Item1 for message text generation, Item2 for message attachment list generation, Item3 for message block list generation] for the Slack message generation (optional). + Size of the batch of messages that get send at once to Slack (recommended). + Time period between sending of batches of messages (recommended). + Maximum size of the queue that stores the messages before the messages were send in batches to Slack (optional). + The absolute minimum a log message must have to be send to Slack (optional). + The template for the output format of the log messages (optional). + A to change the minimum a log message must have to be send to Slack (optional). + A format provider (optional). + A Switch to change the activation status of the sink on the fly (optional). + Instance of object. + + + + extension that provides configuration chaining. + + Instance of object. + Slack WebHook URL. + Slack username (recommended). + Slack user-icon emoji string (optional). + Slack user-icon image URI (optional). + A containing the name of all Slack channels in which the log message should be posted (recommended). + Slack message option 'DeleteOriginal' (optional). + Slack message option 'LinkNames' (optional). + Slack message option 'Markdown' (optional). + Slack message option 'Parse' as + Slack message option 'ReplaceOriginal' (optional). + Slack message option 'ResponseType' (optional). + Slack message option 'ThreadID' (optional). + Slack message attachment color list as (optional). + Slack message attachment footer icon list as (optional). + Add the short info attachment to the log message (optional). + Display the short info attachment in short form (optional). + Add the extended info attachment to the log message (optional). + Display the extended info attachment in short form (optional). + Add the short exception to the log message (optional). + Display the exception attachment in short form (optional). + Timeout for the connection to the Slack servers (optional). + The instance which the uses. + A for message text generation (optional). + A message attachment list generation (optional). + A for message block list generation (optional). + Size of the batch of messages that get send at once to Slack (recommended). + Time period between sending of batches of messages (recommended). + Maximum size of the queue that stores the messages before the messages were send in batches to Slack (optional). + The absolute minimum a log message must have to be send to Slack (optional). + The template for the output format of the log messages (optional). + A to change the minimum a log message must have to be send to Slack (optional). + A format provider (optional). + A Switch to change the activation status of the sink on the fly (optional). + Instance of object. + + + + instance for the SlackClient. + + + + + instance. + + + + + object for this Sink. + + + + + to change the activation status of the sink on the fly. + + + + + object. + + + + + Function to generate the text of the slack message. + + + + + Function to generate the attachments of the slack message. + + + + + Function to generate the blocks of the slack message. + + + + + Initializes new instance of . + + Slack Sink Options object. + FormatProvider object. + HttpClient instance. + GenerateSlackMessageText function. + GenerateSlackMessageAttachments function. + GenerateSlackMessageBlocks function. + A Switch to change the activation status of the sink on the fly (optional). + + + + Implements a function to close the and the . + + + + + Implements and sends the with a to Slack. + + A collection of . + An Awaitable Task. + + + + Implements . + + An Awaitable Task. + + + + This class provides functions for sending log events (serilog) to slack an implements therefor . + + + + + Initializes new instance of . + + Slack Sink Options object. + FormatProvider object. + HttpClient instance. + GenerateSlackMessageText function. + GenerateSlackMessageAttachments function. + GenerateSlackMessageBlocks function. + A Switch to change the activation status of the sink on the fly (optional). + + + + Provides a switch to set a slack sink active or inactive on the fly. + + + + + Enum to represent an activation status. + + + + + The current status. + + + + + Initializes new instance of . + + The . + + + + Class with default tools for message generation. + + + + + DEFAULT GenerateSlackMessageText function. + + The log event. + A format provider + Sink Options as SlackSinkOptions. + The log message string. + + + + DEFAULT GenerateSlackMessageAttachments function. + + The log event. + A format provider + Sink Options as SlackSinkOptions. + The log message attachment list. + + + + DEFAULT GenerateSlackMessageBlocks function. + + The log event. + A format provider + Sink Options as SlackSinkOptions. + The log message block list. + + + + Class to contain all relevant options of this sink. + + + + + Default value for the OutputTemplate. + + + + + Default value for the BatchSizeLimit. + + + + + Default value for the Period. + + + + + Default value for the QueueLimit. + + + + + Default value for the Timeout. + + + + + REQUIRED: Slack WebHook URL. + + + + + OPTIONAL: Timeout for the connection to the Slack servers. + + + + + RECOMMENDED: Slack username. + + + + + RECOMMENDED: Slack user-icon emoji string. + + + + + OPTIONAL: Slack user-icon image URI. + + + + + RECOMMENDED: A containing the name of all Slack channels in which the log message should be posted. + + + + + OPTIONAL: Slack message option 'DeleteOriginal'. + + + + + OPTIONAL: Slack message option 'LinkNames'. + + + + + OPTIONAL: Slack message option 'Markdown'. + + + + + OPTIONAL: Slack message option 'Parse'. + + + + + OPTIONAL: Slack message option 'ReplaceOriginal'. + + + + + OPTIONAL: Slack message option 'ResponseType'. + + + + + OPTIONAL: Slack message option 'ThreadID'. + + + + + OPTIONAL: Slack message attachment color list as . + + + + + OPTIONAL: Slack message attachment footer icon list as . + + + + + OPTIONAL: Add the short info attachment to the log message. + + + + + OPTIONAL: Display the short info attachment in short form. + + + + + OPTIONAL: Add the extended info attachment to the log message. + + + + + OPTIONAL: Display the extended info attachment in short form. + + + + + OPTIONAL: Add the short exception to the log message. + + + + + OPTIONAL: Display the exception attachment in short form. + + + + + RECOMMENDED: Size of the batch of messages that get send at once to Slack. + + + + + RECOMMENDED: Time period between sending of batches of messages. + + + + + OPTIONAL: Maximum size of the queue that stores the messages before the messages were send in batches to Slack. + + + + + OPTIONAL: The template for the output format of the log messages. + + + + diff --git a/src/jjm.one.Serilog.Sinks.SlackWebHook/jjm.one.Serilog.Sinks.SlackWebHook.csproj b/src/jjm.one.Serilog.Sinks.SlackWebHook/jjm.one.Serilog.Sinks.SlackWebHook.csproj index 8d5edd7..c7b2c58 100644 --- a/src/jjm.one.Serilog.Sinks.SlackWebHook/jjm.one.Serilog.Sinks.SlackWebHook.csproj +++ b/src/jjm.one.Serilog.Sinks.SlackWebHook/jjm.one.Serilog.Sinks.SlackWebHook.csproj @@ -2,39 +2,35 @@ netstandard2.0;netstandard2.1;net6;net7 - true - LICENSE.txt - Jonas Merkle [JJM] - A basic Slack Sink for the Serilog framwork. + disable + enable + 2.0.0 + Jonas Merkle [JJM] © by Jonas Merkle [JJM], 2023. - https://github.com/jjm-one/jjm.one.Serilog.Sinks.SlackWebHook - GitHub + jjm.one.Serilog.Sinks.SlackWebHook + jjm.one.Serilog.Sinks.SlackWebHook + A basic Slack Sink for the Serilog framwork. serilog, serilog-sink, slack, logging, csharp https://github.com/jjm-one/jjm.one.Serilog.Sinks.SlackWebHook - jjm.one.Serilog.Sinks.SlackWebHook - jjm.one.Serilog.Sinks.SlackWebHook - 1.4.2 - true - true - - false - jjm.one.Serilog.Sinks.SlackWebHook + git + https://github.com/jjm-one/jjm.one.Serilog.Sinks.SlackWebHook + README.md + LICENSE + True - - 5 + + latestmajor + .\jjm.one.Serilog.Extensions.Logging.Helpers.xml + + + latestmajor + .\jjm.one.Serilog.Extensions.Logging.Helpers.xml - - - - - - - - + True - + \ True @@ -42,4 +38,10 @@ + + + + + +