Skip to content

philjones/NLogToSlack

 
 

Repository files navigation

NLogToSlack

An NLog target for Slack - your logs in one place and instantly searchable, everywhere.

Use default Features NLogToSlack

Or create your own attachment

NLogToSlack NLogToSlack

Installation

Via NuGet: Install-Package NLogToSlack

... or just build it yourself!

Usage

  1. Create a new Incoming Webhook integration.
  2. Configure NLog to use NLogToSlack:

NLog.config

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <extensions>
    <add assembly="NLogToSlack" />
  </extensions>

  <targets async="true">
    <target xsi:type="Slack"
            name="slackTarget"
            layout="${message}"
            webHookUrl="https://xxx.slack.com/services/hooks/incoming-webhook?token=xxx"
            channel="#log"
            username="NLogToSlack"
            icon=":ghost:" />
  </targets>

  <rules>
    <logger name="*" minlevel="Debug" writeTo="slackTarget" />
  </rules>
</nlog>

Note: it's recommended to set async="true" on targets so if the HTTP call to Slack fails or times out it doesn't slow down your application.

Programmatically

var config = new LoggingConfiguration();
var slackTarget = new SlackTarget
{
      Layout = "${message}",
      WebHookUrl = "http://xxx.slack.com/services/hooks/incoming-webhook?token=xxx",
      Channel = "#log"
};

config.AddTarget("slack", slackTarget);

var slackTargetRules = new LoggingRule("*", LogLevel.Debug, slackTarget);
config.LoggingRules.Add(slackTargetRules);

LogManager.Configuration = config;

And you're good to go!

Configuration Options

Key Description
WebHookUrl Grab your Webhook URL (with the token) from your Incoming Webhooks integration in Slack
Channel The channel name (e.g #log) or user (e.g. @eth0) to send NLog messages to. Leave blank to use the integration default
Username Name of the user that NLog messages comes from. Leave blank to use the integration default
Icon Leave blank to use the integration default. Can either be a URL or Emoji

About

An NLog target for Slack

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 100.0%