Serilog.Sinks.MongoDB 7.0.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher. .NET Framework 4.7.2 This package targets .NET Framework 4.7.2. The package is compatible with this framework or higher. 
dotnet add package Serilog.Sinks.MongoDB --version 7.0.0                

                    
                

            
NuGet\Install-Package Serilog.Sinks.MongoDB -Version 7.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Serilog.Sinks.MongoDB" Version="7.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Serilog.Sinks.MongoDB --version 7.0.0                

                    
                

            
#r "nuget: Serilog.Sinks.MongoDB, 7.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Serilog.Sinks.MongoDB as a Cake Addin
#addin nuget:?package=Serilog.Sinks.MongoDB&version=7.0.0

// Install Serilog.Sinks.MongoDB as a Cake Tool
#tool nuget:?package=Serilog.Sinks.MongoDB&version=7.0.0

mongo icon Serilog.Sinks.MongoDB

NuGet version Downloads Build status

A Serilog sink that writes events as documents to MongoDB.

Package - Serilog.Sinks.MongoDB Platforms - .NET 4.7.2, .NET 6.0, .NET Standard 2.1

Whats New

New in v7.x
  • Upgrade MongoDB.Driver to v3.0 - .NET Standard 2.0 support has been removed.
New in v6.x
  • Upgrade MongoDB.Driver to v2.28.0 (Thanks to Memoyu)
  • Add trace context to LogEntry (Thanks to fernandovmp)
New in v5.x
  • Output structured MongoDB Bson logs by switching to .MongoDBBson() extensions. Existing .MongoDB() extensions will continue to work converting logs to Json and then to Bson.
  • Rolling Log Collection Naming (Thanks to Revazashvili for the PR!). MongoDBBson sink only.
  • Expire TTL support. MongoDBBson sink only.

Installation

Install the sink via NuGet Package Manager Console:

Install-Package Serilog.Sinks.MongoDB

or via the .NET CLI:

dotnet add package Serilog.Sinks.MongoDB

Usage Examples

In the examples below, the sink is writing to the database logs with structured Bson. The default collection name is log, but a custom collection can be supplied with the optional CollectionName parameter. The database and collection will be created if they do not exist.

Basic:

using Serilog;

// use BSON structured logs
var log = new LoggerConfiguration()
    .WriteTo.MongoDBBson("mongodb://mymongodb/logs")
    .CreateLogger();

log.Information("This is a test log message");

Capped Collection:

// capped collection using BSON structured logs
var log = new LoggerConfiguration()
    .WriteTo.MongoDBBson("mongodb://mymongodb/logs", cfg =>
    {
        // optional configuration options:
        cfg.SetCollectionName("log");
        cfg.SetBatchPeriod(TimeSpan.FromSeconds(1));

        // create capped collection that is max 100mb
        cfg.SetCreateCappedCollection(100);
    })
    .CreateLogger();

Custom Mongodb Settings:

// create sink instance with custom mongodb settings.
var log = new LoggerConfiguration()
	.WriteTo.MongoDBBson(cfg =>
    {
		// custom MongoDb configuration
		var mongoDbSettings = new MongoClientSettings
		{
			UseTls = true,			
			AllowInsecureTls = true,
			Credential = MongoCredential.CreateCredential("databaseName", "username", "password"),
			Server = new MongoServerAddress("127.0.0.1")
		};

		var mongoDbInstance = new MongoClient(mongoDbSettings).GetDatabase("serilog");
		
		// sink will use the IMongoDatabase instance provided
		cfg.SetMongoDatabase(mongoDbInstance);
		cfg.SetRollingInternal(RollingInterval.Month);
    })
	.CreateLogger();

JSON (Microsoft.Extensions.Configuration)

Keys and values are not case-sensitive. This is an example of configuring the MongoDB sink arguments from Appsettings.json:

{
  "Serilog": {
    "MinimumLevel": {
      "Default": "Information",
      "Override": {
        "Microsoft": "Error",
        "System": "Warning"
      }
    },
    "WriteTo": [
      { 
      	"Name": "MongoDBBson", 
        "Args": { 
            "databaseUrl": "mongodb://username:password@ip:port/dbName?authSource=admin",
            "collectionName": "logs",
            "cappedMaxSizeMb": "1024",
            "cappedMaxDocuments": "50000",
            "rollingInterval": "Month"
        }
      } 
    ]
  }
}

Icon

MongoDB icon by Icons8

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
.NET Framework net472 is compatible.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (48)

Showing the top 5 NuGet packages that depend on Serilog.Sinks.MongoDB:

Package Downloads
TianCheng.Model

实体对象基类，及其常用操作。 常用操作包括：对象转换、序列化、日志、常用异常处理、依赖注入。
RG3.PF.Web.StartUsed

1、【核心业务使用包RG3.PF.Web.StartUsed】(可配置化，标准化，灵活配置，集成百度、腾讯、阿里、短信通等巨头接口，可脱离开发环境，集成nodejs中间件、统一认证中心) 2、以Rg3.开头且类继承 IService 或 IRepository的在Starup里面不用注入，案例如下 3、public class ListRepository : IRepository 4、public class ListService : IService 5、使用请到github获取 RG3.PF.WebApp.Host 6、Quartz集成redis订阅、Quartz 7、修复多引用CLDC 8、接入微信公众号wxconfig 9、Prometheus+Grafana https://doc.rg1008.com/docs/rg_pass_log/rg_pass_log-1dpcuns9s6r8c 10、Headers添加VerifyApiValue 用于验证 11、添加时间戳 Convert.ToInt64(DateTimePFUtil.ToTimestampSecond(this.Expires)); 12、版本记录：https://doc.rg1008.com/docs/rg_pass_log/rg_pass_log-1dpubsabl25v4 13、 20240815 升级到.netcore sdk 8.0
Basic.Logging.Serilog

Package Description
Atlas.Framework.Web

Package Description
uBeac.Logging.MongoDB

Easily implement logging with MongoDB in your .NET projects!

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
7.0.0 3,742 11/5/2024
6.0.0 24,089 9/20/2024
5.4.1 190,178 2/18/2024
5.3.1 851,724 9/28/2022
5.2.2 6,308 9/26/2022
5.2.1 29,881 9/3/2022
5.2.1-tags-v5-2-0-0000 287 9/3/2022
5.2.0 750 9/3/2022
5.1.5 278,565 4/24/2022
5.1.2 159,414 1/19/2022
5.1.2-dev-00124 304 3/12/2022
5.1.2-dev-00123 537 1/19/2022
5.1.2-dev-00121 512 1/19/2022
5.1.1 242,845 9/25/2021
5.1.1-dev-00120 554 1/19/2022
5.1.1-dev-00119 500 1/19/2022
5.1.1-dev-00118 535 1/19/2022
5.1.1-dev-00116 361 9/25/2021
5.1.0-dev-00114 382 9/25/2021
5.0.0 77,262 9/2/2021
5.0.0-dev-00112 431 9/24/2021
5.0.0-dev-00111 457 9/12/2021
5.0.0-dev-00110 427 9/12/2021
5.0.0-dev-00109 392 9/2/2021
5.0.0-dev-00107 375 9/2/2021
5.0.0-dev-00105 669 8/1/2021
5.0.0-dev-00104 1,873 5/8/2021
5.0.0-dev-00103 445 5/7/2021
5.0.0-dev-00100 20,201 5/6/2021
5.0.0-dev-00099 440 5/6/2021
5.0.0-dev-00098 422 5/6/2021
5.0.0-dev-00097 802 5/6/2021
4.1.0 380,926 5/6/2021
4.1.0-dev-00096 440 5/6/2021
4.1.0-dev-00094 415 5/6/2021
4.1.0-dev-00084 10,414 10/21/2020
4.1.0-dev-00069 16,574 1/29/2019
4.0.0 1,572,848 11/9/2018
4.0.0-dev-00068 533 1/29/2019
4.0.0-dev-00064 617 11/9/2018
4.0.0-dev-00062 7,183 2/15/2018
4.0.0-dev-00060 998 11/30/2017
3.1.1-dev-00059 784 11/30/2017
3.1.0 496,587 11/1/2016
3.1.0-dev-00049 962 10/30/2016
3.1.0-dev-00046 1,407 10/7/2016
3.1.0-dev-00044 844 10/7/2016
3.1.0-dev-00042 843 10/5/2016
3.1.0-dev-00037 892 10/5/2016
3.1.0-dev-00035 875 9/9/2016
3.1.0-dev-00033 833 9/8/2016
3.0.0 2,750 8/9/2016
3.0.0-dev-00030 852 8/9/2016
3.0.0-dev-00029 824 8/9/2016
3.0.0-beta-24 1,248 4/26/2016
2.0.19 12,724 2/16/2016
2.0.18 1,147 2/16/2016
2.0.14 22,657 1/26/2016
2.0.13 4,171 7/26/2015
2.0.11 2,066 4/18/2015
2.0.8-pre 958 4/2/2015
2.0.7-pre 912 3/26/2015
2.0.6-pre 904 3/16/2015
2.0.3-pre 914 3/10/2015
2.0.1-pre 920 2/1/2015
2.0.0-beta-27 816 5/6/2016
1.4.139 1,871 1/23/2015
1.4.118 1,158 1/13/2015
1.4.113 1,280 1/6/2015
1.4.102 1,642 12/21/2014
1.4.99 1,551 12/18/2014
1.4.97 1,404 12/18/2014
1.4.76 1,488 12/8/2014
1.4.39 1,367 11/26/2014
1.4.34 1,322 11/24/2014
1.4.28 1,378 11/24/2014
1.4.27 1,395 11/23/2014
1.4.23 1,501 11/21/2014
1.4.21 1,390 11/21/2014
1.4.18 1,468 11/18/2014
1.4.15 2,428 11/4/2014
1.4.14 1,323 10/23/2014
1.4.13 1,197 10/23/2014
1.4.12 1,289 10/12/2014
1.4.11 1,234 10/8/2014
1.4.10 1,250 9/26/2014
1.4.9 1,330 9/17/2014
1.4.8 1,254 9/11/2014
1.4.7 1,289 9/1/2014
1.4.6 1,201 8/31/2014
1.4.5 1,364 8/27/2014
1.4.4 1,239 8/27/2014
1.4.3 1,340 8/25/2014
1.4.2 1,259 8/23/2014
1.4.1 1,235 8/23/2014
1.3.43 1,499 8/4/2014
1.3.42 1,266 7/30/2014
1.3.41 1,246 7/28/2014
1.3.40 1,181 7/26/2014
1.3.39 1,206 7/25/2014
1.3.36 1,214 7/20/2014
1.3.35 1,204 7/17/2014
1.3.34 1,882 7/6/2014
1.3.33 1,209 6/30/2014
1.3.30 1,265 6/19/2014
1.3.29 1,259 6/19/2014
1.3.28 1,201 6/19/2014
1.3.27 1,241 6/18/2014
1.3.25 1,272 6/9/2014
1.3.24 1,316 5/21/2014
1.3.23 1,220 5/20/2014
1.3.20 1,265 5/18/2014
1.3.19 1,206 5/17/2014
1.3.18 1,183 5/17/2014
1.3.17 1,189 5/17/2014
1.3.16 1,215 5/17/2014
1.3.15 1,209 5/16/2014
1.3.14 1,312 5/16/2014
1.3.13 1,208 5/16/2014
1.3.12 1,215 5/14/2014
1.3.7 1,237 5/11/2014
1.3.6 1,239 5/9/2014
1.3.5 1,228 5/6/2014
1.3.4 1,341 5/4/2014
1.3.3 1,423 4/28/2014
1.3.1 1,250 4/26/2014
1.2.53 1,268 4/26/2014
1.2.52 1,502 4/24/2014
1.2.51 1,433 4/18/2014
1.2.50 1,376 4/18/2014
1.2.49 1,367 4/17/2014
1.2.48 1,348 4/14/2014
1.2.47 1,456 4/14/2014
1.2.45 1,498 4/13/2014
1.2.44 1,402 4/9/2014
1.2.41 1,338 4/7/2014
1.2.40 1,324 4/7/2014
1.2.39 1,293 3/29/2014
1.2.37 1,321 3/29/2014
1.2.29 1,335 3/16/2014
1.2.26 1,249 3/12/2014
1.2.25 1,294 2/20/2014
0.9.9 1,410 11/23/2013
0.9.1 1,388 8/24/2013
0.8.5 1,411 7/22/2013
0.8.1 1,453 7/9/2013
0.7.2 1,461 7/6/2013
0.6.1 1,407 6/13/2013
0.5.2 1,359 5/27/2013
0.5.1 1,358 5/26/2013
0.4.3 1,366 5/25/2013
0.3.2 1,325 5/19/2013
0.3.1 1,304 5/19/2013
0.2.10 1,353 5/13/2013
0.2.9 1,287 5/10/2013
0.2.7 1,267 5/8/2013
0.2.6 1,346 5/8/2013
0.2.5 1,323 5/7/2013
0.2.1 1,361 4/8/2013
0.1.18 1,371 4/6/2013
0.1.17 1,312 4/4/2013
0.1.16 1,338 4/3/2013
0.1.12 1,365 4/1/2013
0.1.11 2,344 3/30/2013

v7.0 - Upgraded to MongoDB.Driver to version 3.0 fixing incompatibilities.