Possibility to add Custom Messages

[anime-shed]

In a Web App project, I use a Slack logger using serilog.

There are many APIs in my project, I want to log the Body of a POST API that fails so that I have the data to recreate the same situation. If it is possible to have this in jjm.one.Serilog.Sinks.SlackWebHook that I will gladly make a switch.

TIA.

[jonas-merkle]

Hi 👋🏼

Maybe I don't understand your problem correctly, but I think you are looking for the solution to your problem in the wrong place. My project and the serilog-sinks-slack project are both so-called Sinks. These allow the Serilog logger to send log messages to (in this case) Slack.
But I think you should rather consider one of the following things as a solution:

1. An Enricher for Serilog, which automatically adds additional information to a log message (in your case the request body).
2. A middelware for your request API to extract this information and add it to a log message. For this purpose there is for example this code example: RequestResponseLoggingMiddleware.cs

The difference between my project and the serilog-sinks-slack is, in my opinion, that you have more options for formatting the messages in Slack because you have more access to the underlaying Slack Webhooks.

I hope that helps for now in solving the problem! 😉

[anime-shed]

Sorry if my question felt out of place.

I wanted to have something like:

Where the link present to:

• RequestBody if it was present in the API
• StackTrace since there are multiple lines

Currently:

Which has very limited data and that I have to print out:

And if I remove the values from the text input, then it looks more bare like:

[anime-shed]

Ideally, I wanted to utilize Slack to the greatest extent, by uploading the text file in the link as an attachment in Slack itself but I don't think there is a possibility for that. If this can be done by an Enricher then I will be glad to be pointed to such an example or a resource to help me achieve it.

Else, if it is possible for me to replace long text

with hyperlinks that I can upload to other websites,

without having to append it to the log.😭

TIA 😅

[jonas-merkle]

I'm still not sure if I've fully understood your problem, but maybe I can help you with the following.

In general you can append custom properties like the request body to a log event without it appearing in the log message. To do this, instead of using Log.Error("Some Message: {RequestBody}", body) use the command Log.ForContext("RequestBody", body).Error("Some Messsage").
In the case of my Slack-Sink implementation, the flags slackAddExtendedInfoAttachment must be set to true and slackDisplayExtendedInfoAttachmentShort must be set to false when initializing the sink, so that this information also appears in Slack.

Furthermore, it is theoretically possible to override the functions of my Slack-Sink implementation, which are responsible for "rendering" the message and attachments in Slack.

[anime-shed]

Furthermore, it is theoretically possible to override the functions of my Slack-Sink implementation, which are responsible for "rendering" the message and attachments in Slack.

Great, I will try to look into it and thanks for bearing up with me.

[jonas-merkle]

To use a custom implementation of these functions you need to define and implement the following function within your code:

public static string MyGenerateSlackMessageText(LogEvent logEvent, IFormatProvider? formatProvider, object options)
{
// ...
}

public static List<SlackAttachment>? MyGenerateSlackMessageAttachments(LogEvent logEvent,IFormatProvider? formatProvider, object options)
{
// ...
}

public static List<Block>? MyGenerateSlackMessageBlocks(LogEvent logEvent, IFormatProvider? formatProvider, object options)
{
    // ...
}

The second function is the one which generates the Slack message attachment. You can get more information about the usage of these attachments in this github repo.

My default implementation of these functions can be found here

To register your custom function you must initialize the Slack sink as follows:

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

          // this line registers the functions
          generateSlackFunctions: new Tuple<object, object, object>(MyGenerateSlackMessageText, MyGenerateSlackMessageAttachments, MyGenerateSlackMessageBlocks),

          periodicBatchingSinkOptionsBatchSizeLimit: 1,
          periodicBatchingSinkOptionsPeriod: TimeSpan.FromMilliseconds(10),
          periodicBatchingSinkOptionsQueueLimit: 100,
          sinkRestrictedToMinimumLevel: LogEventLevel.Verbose,
          sinkOutputTemplate: "{Message}",
          sinkLevelSwitch: levelSwitch
            )
            .CreateLogger();

[anime-shed]

Thanks will try it.