Serilog.Sinks.Zulip 1.0.6

Serilog.Sinks.Zulip

A high-performance, batched asynchronous Serilog sink for the Zulip messaging platform.

Overview

This library provides a production-grade integration for routing structured logs into Zulip channels. It is designed to be non-blocking and network-efficient, ensuring that logging telemetry does not impact application latency.

For more information on the underlying REST API, please refer to the official Zulip API Documentation.

Installation

dotnet add package Serilog.Sinks.Zulip

Configuration Options

The sink can be customized using the ZulipSinkOptions object (or mapped directly from appsettings.json).

💡 Tip: In Zulip, topics are a powerful way to thread and organize messages within a channel. To learn more about how they work, check out the official Introduction to Topics guide.

Advanced Batching & Formatting Options

When configuring via the extension methods, you also have access to standard Serilog batching and formatting controls:

Usage Examples

Approach 1: appsettings.json (Recommended)

This library fully supports Serilog.Settings.Configuration. Using appsettings.json prevents hardcoding API keys into your source code.

{
  "Serilog": {
    "Using": [ "Serilog.Sinks.Zulip" ],
    "MinimumLevel": "Information",
    "WriteTo": [
      {
        "Name": "Zulip",
        "Args": {
          "serverUrl": "[https://your-org.zulipchat.com](https://your-org.zulipchat.com)",
          "botEmail": "log-bot@your-org.zulipchat.com",
          "apiKey": "YOUR_ZULIP_API_KEY",
          "channel": "backend-alerts",
          "defaultTopic": "Production Errors",
          "restrictedToMinimumLevel": "Warning",
          "outputTemplate": "**[{Level}]** {Message:lj}{NewLine}{Exception}"
        }
      }
    ]
  }
}

Approach 2: C# Fluent Configuration

If you prefer to configure Serilog via code, you can pass options directly during startup.

using Serilog;
using Serilog.Sinks.Zulip;

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Information()
    .WriteTo.Zulip(
        serverUrl: "[https://your-org.zulipchat.com](https://your-org.zulipchat.com)",
        botEmail: "log-bot@your-org.zulipchat.com",
        apiKey: "YOUR_ZULIP_API_KEY",
        channel: "backend-alerts",
        defaultTopic: "Production Errors",
        restrictedToMinimumLevel: Serilog.Events.LogEventLevel.Warning
    )
    .CreateLogger();