/serilog-sinks-clickhouse

Write serilog events to clickhouse database.

Primary LanguageC#Apache License 2.0Apache-2.0

Install:

dotnet add package Serilog.Sinks.ClickHouse --version 1.0.0

Default fields:

  1. timestamp (DateTime)
  2. level (Int)
  3. message (String)

Usage:

var log = new LoggerConfiguration()
  .Enrich.WithProperty("source", "network")
  .Enrich.WithProperty("user", "admin")
  .WriteTo.ClickHouse(
      "Compress=False;CheckCompressedHash=False;Compressor=lz4;Host=localhost;Port=9000;Database=test_db;User=default;Password=",
      "test_db.logs",
      50,
      TimeSpan.FromSeconds(30),
      new List<AdditionalColumn>
      {
          new AdditionalColumn { Name = "source", Type = "String" },
          new AdditionalColumn { Name = "user", Type = "String" }
      },
      restrictedToMinimumLevel: LogEventLevel.Information
  ).CreateLogger();

Using appsettings.json:

{
 "Serilog": {
   "MinimumLevel": {
     "Default": "Debug"
   },
   "WriteTo": [
     {
       "Name": "ClickHouse",
       "Args": {
         "connectionString": "Compress=False;CheckCompressedHash=False;Compressor=lz4;Host=localhost;Port=9000;Database=test_db;User=default;Password=",
         "tableName": "test_db.logs",
         "batchPostingLimit": 50,
         "period": "00:00:30",
         "additionalColumns": [{
             "Name": "source",
             "Type": "String"
           },
           {
             "Name": "user",
             "Type": "String"
           }]
       }
     }
   ]
 }
}
var configuration = new ConfigurationBuilder()
 .AddJsonFile($"appsettings.json", true)
 .Build();

var logFromAppsettings = new LoggerConfiguration()
 .ReadFrom.Configuration(configuration)
 .Enrich.WithProperty("source", "network")
 .Enrich.WithProperty("user", "admin")
 .CreateLogger();