Jinget.Logger 6.2.19-preview004

Prefix Reserved
This is a prerelease version of Jinget.Logger.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Jinget.Logger --version 6.2.19-preview004
                    
NuGet\Install-Package Jinget.Logger -Version 6.2.19-preview004
                    
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="Jinget.Logger" Version="6.2.19-preview004" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Jinget.Logger" Version="6.2.19-preview004" />
                    
Directory.Packages.props
<PackageReference Include="Jinget.Logger" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Jinget.Logger --version 6.2.19-preview004
                    
#r "nuget: Jinget.Logger, 6.2.19-preview004"
                    
#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.
#:package Jinget.Logger@6.2.19-preview004
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Jinget.Logger&version=6.2.19-preview004&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Jinget.Logger&version=6.2.19-preview004&prerelease
                    
Install as a Cake Tool

Jinget Logger

Using this library, you can easily save your application logs in Elasticsearch database or files.

How to Use:

Download the package from NuGet using Package Manager: Install-Package Jinget.Logger You can also use other methods supported by NuGet. Check Here for more information.

Configuration

Config logging destination:

Elasticsearch:

LogToElasticSearch: By calling this method, you are going to save your logs in Elasticsearch

builder.Host.LogToElasticSearch<OperationLog, ErrorLog, CustomLog>(blacklist);

blacklist: Log messages contain the blacklist array items will not logged.

allowedLoglevels: Defines an array contains allowed log levels. If log's severity exists in this array, then it will be saved in elasticsearch otherwise it will be ignored. If this parameter not set, then all log levels will be allowed.

After setting the logging destination, you need to configure Elasticsearch:

builder.Services.ConfigureElasticSearchLogger<OperationLog, ErrorLog, CustomLog>(
    new ElasticSearchSettingModel
    {
        UserName = <authentication username>,
        Password = <authentication password>,
        Url = <ElasticSearch Url>,
        UseSsl = <true|false>,
        RegisterDefaultLogModels = <true|false>,
        DiscoveryTypes = new List<Type> { typeof(OperationLog) }
    });

Url: Elasticsearch service url. This address should not contains the PROTOCOL itself. Use 'abc.com:9200' instead of 'http://abc.com:9200'

UserName: Username, if basic authentication enabled on Elasticsearch search service

Password: Password, if basic authentication enabled on Elasticsearch search service

UseSsl: Set whether to use SSL while connecting to Elasticsearch or not

RegisterDefaultLogModels: You can configure logging using your own models instead of OperationLog, ErrorLog or CustomLog. In order to do so, you can simple create derived types and use them instead of these types. When you are working with your own custom types, if you want to create index for default log models, you can set the RegisterDefaultLogModels property to true, otherwise you can set it as false.

DiscoveryTypes: Foreach type specified in this list, an index in Elasticsearch will be created

CreateIndexPerPartition: Create index per partition using HttpContext.Items["jinget.log.partitionkey"] value. If this mode is selected, then RegisterDefaultLogModels and also DiscoveryTypes will not be used. If this mode is selected, then index creation will be deferred until the first document insertion. foreach partition key, a separated index will be created. all of the indexes will share the same data model. for request/response logs, Entities.Log.OperationLog will be used. for errors, Entities.Log.ErrorLog will be used. for custom logs, Entities.Log.CustomLog will be used.

If you want to use partition key, instead of predefined/custom models, then you do not need to pass the generic types. Just like below:

builder.Host.LogToElasticSearch(blacklist);
...

var elasticSearchSetting = new ElasticSearchSettingModel
{
    CreateIndexPerPartition = true,
    UserName = <authentication username>,
    Password = <authentication password>,
    Url = <ElasticSearch Url>,
    UseSsl = <true|false>
};
builder.Services.ConfigureElasticSearchLogger(elasticSearchSetting);

And finally you need to add the Jinget.Logger middleware to your pipeline:

app.UseJingetLogging();

If you are using partition key, then you need to set your partition key before calling app.UseJingetLogging(). Like below:

app.UseWhen(p => elasticSearchSetting.CreateIndexPerPartition, appBuilder =>
{
    appBuilder.Use(async (context, next) =>
    {
        //define the partitioning logic
        bool partitionKeyExists = context.Request.Headers.TryGetValue("jinget.client_id", out StringValues partitionKey);
        if (partitionKeyExists)
            context.Items.Add("jinget.log.partitionkey", $"test.{partitionKey}");

        await next.Invoke();
    });
});

For example in the above code, logs will be partitioned based on the jinget.client_id header's value. If this header does not exists in the request, the default index name will be used which are created using the following code:

$"{AppDomain.CurrentDomain.FriendlyName}.{typeof(TModelType).Name}".ToLower();

When using partition key, index names will be constructed as below:

//for operation log
$"op.{partitionKey}".ToLower();

//for error log
$"err.{partitionKey}".ToLower();

//for custom log
$"cus.{partitionKey}".ToLower();

Here is the complete configuration for a .NET Web API application:

Without Partitioning:

using Jinget.Core.Filters;
using Jinget.Logger.Configuration;
using Jinget.Logger.Entities.Log;

var builder = WebApplication.CreateBuilder(args);

var config = new ConfigurationBuilder().AddJsonFile("appsettings.json", false, true).Build();

var blacklist = config.GetSection("logging:BlackList").Get<string[]>();
builder.Host.LogToElasticSearch<OperationLog, ErrorLog, CustomLog>(blacklist);

var elasticSearchSetting = new ElasticSearchSettingModel
{
    UserName = "myuser",
    Password = "mypass",
    Url = "192.168.1.1:9200",
    UseSsl = false,
    RegisterDefaultLogModels = false,
    DiscoveryTypes = new List<Type> { typeof(OperationLog) }
};
builder.Services.ConfigureElasticSearchLogger<OperationLog, ErrorLog, CustomLog>(elasticSearchSetting);

builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();

var app = builder.Build();

app.UseJingetLogging();
app.MapControllers();
app.Run();

With Partitioning:

using Jinget.Core.Filters;
using Jinget.Logger.Configuration;
using Jinget.Logger.Configuration.Middlewares.ElasticSearch;
using Jinget.Logger.Entities.Log;
using Jinget.Logger.Handlers.CommandHandlers;
using Microsoft.Extensions.Primitives;

var builder = WebApplication.CreateBuilder(args);

var config = new ConfigurationBuilder().AddJsonFile("appsettings.json", false, true).Build();

var blacklist = config.GetSection("logging:BlackList").Get<string[]>();

builder.Host.LogToElasticSearch(blacklist);
var elasticSearchSetting = new ElasticSearchSettingModel
{
    CreateIndexPerPartition = true,
    UserName = "myuser",
    Password = "mypass",
    Url = "192.168.1.1:9200",
    UseSsl = false
};
builder.Services.ConfigureElasticSearchLogger(elasticSearchSetting);

builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();

var app = builder.Build();

app.UseWhen(p => elasticSearchSetting.CreateIndexPerPartition, appBuilder =>
{
    appBuilder.Use(async (context, next) =>
    {
        bool partitionKeyExists = context.Request.Headers.TryGetValue("jinget.client_id", out StringValues partitionKey);
        if (partitionKeyExists)
            context.Items.Add("jinget.log.partitionkey", $"test.{partitionKey}");

        await next.Invoke();
    });
});

app.UseJingetLogging();
app.MapControllers();
app.Run();

File:

LogToFile: By calling this method, you are going to save your logs in files

builder.Host.LogToFile(blacklist, fileNamePrefix: "Log-", logDirectory: "D:\\logs", 10, 15);

blacklist: Log messages contain the blacklist array items will not logged.

allowedLoglevels: Defines an array contains allowed log levels. If log's severity exists in this array, then it will be saved in file otherwise it will be ignored. If this parameter not set, then all log levels will be allowed.

fileNamePrefix: Gets or sets the filename prefix to use for log files. Defaults is logs-

logDirectory: The directory in which log files will be written, relative to the app process. Default is Logs directory.

retainedFileCountLimit: Gets or sets a strictly positive value representing the maximum retained file count or null for no limit. Defaults is 2 files.

fileSizeLimit: Gets or sets a strictly positive value representing the maximum log size in MB or null for no limit. Once the log is full, no more messages will be appended. Defaults is 10MB.

After setting the logging destination, you need to configure Elasticsearch:

builder.Services.ConfigureFileLogger();

Here is the complete configuration for a .NET Web API application:

using Jinget.Core.Filters;
using Jinget.Logger.Configuration;

var builder = WebApplication.CreateBuilder(args);

var config = new ConfigurationBuilder().AddJsonFile("appsettings.json", false, true).Build();

var blacklist = config.GetSection("logging:BlackList").Get<string[]>();
builder.Host.LogToFile(blacklist, "Log-", "D:\\logs", 10, 15);
builder.Services.ConfigureFileLogger();

builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();

var app = builder.Build();

app.UseJingetLogging();

app.UseAuthorization();
app.MapControllers();
app.Run();

How to install

In order to install Jinget Logger please refer to nuget.org

Contact Me

👨‍💻 Twitter: https://twitter.com/_jinget

📧 Email: farahmandian2011@gmail.com

📣 Instagram: https://www.instagram.com/vahidfarahmandian

Product Compatible and additional computed target framework versions.
.NET 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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
8.0.51 108 9/24/2025
8.0.50 171 9/11/2025
8.0.49 168 9/8/2025
8.0.48 158 9/8/2025
8.0.47 159 9/7/2025
8.0.46 110 8/22/2025
8.0.45 150 7/31/2025
8.0.44 132 7/31/2025
8.0.43 130 7/30/2025
8.0.42 134 7/30/2025
8.0.41 133 7/30/2025
8.0.40 127 7/30/2025
8.0.39 122 7/29/2025
8.0.38 110 7/28/2025
8.0.37 113 7/28/2025
8.0.36 137 7/28/2025
8.0.36-preview005 144 7/27/2025
8.0.35 96 7/19/2025
8.0.34 90 7/18/2025
8.0.33 171 6/29/2025
8.0.32 157 6/29/2025
8.0.31 113 6/28/2025
8.0.30 76 6/27/2025
8.0.29 88 6/27/2025
8.0.28 92 6/27/2025
8.0.27 128 6/27/2025
8.0.26 120 6/21/2025
8.0.25 172 6/15/2025
8.0.25-preview001 147 6/15/2025
8.0.24 168 5/31/2025
8.0.23 172 5/28/2025
8.0.23-preview001 160 5/28/2025
8.0.22 182 5/25/2025
8.0.21 191 5/11/2025
8.0.20 167 5/11/2025
8.0.19 167 5/11/2025
8.0.18 202 4/21/2025
8.0.17 196 4/21/2025
8.0.16 131 4/19/2025
8.0.15 235 4/13/2025
8.0.14 200 4/7/2025
8.0.13 187 4/7/2025
8.0.12 124 4/5/2025
8.0.11 237 3/9/2025
8.0.10 214 3/9/2025
8.0.9 219 3/9/2025
8.0.8 185 2/27/2025
8.0.7 144 2/27/2025
8.0.6 145 2/27/2025
8.0.5 146 2/26/2025
8.0.4 157 2/25/2025
8.0.3 143 2/24/2025
8.0.2 135 2/24/2025
8.0.1 171 2/20/2025
8.0.0 197 1/22/2025
8.0.0-preview013 227 12/19/2024
8.0.0-preview012 124 12/19/2024
8.0.0-preview011 121 12/17/2024
8.0.0-preview010 134 12/16/2024
8.0.0-preview009 117 12/15/2024
8.0.0-preview008 130 11/25/2024
8.0.0-preview007 168 11/11/2024
8.0.0-preview006 150 11/2/2024
8.0.0-preview005 117 11/2/2024
8.0.0-preview004 122 11/1/2024
8.0.0-preview003 131 11/1/2024
8.0.0-preview002 113 11/1/2024
8.0.0-preview001 113 11/1/2024
6.2.23-preview003 121 10/31/2024
6.2.23-preview002 116 10/31/2024
6.2.22 165 10/26/2024
6.2.21 137 10/26/2024
6.2.20 144 10/26/2024
6.2.19-preview037 119 10/14/2024
6.2.19-preview036 115 9/30/2024
6.2.19-preview035 138 9/10/2024
6.2.19-preview034 131 9/9/2024
6.2.19-preview033 135 9/1/2024
6.2.19-preview032 140 9/1/2024
6.2.19-preview031 134 8/31/2024
6.2.19-preview029 125 8/26/2024
6.2.19-preview028 147 8/26/2024
6.2.19-preview027 163 8/26/2024
6.2.19-preview026 161 8/21/2024
6.2.19-preview025 153 8/21/2024
6.2.19-preview024 149 8/19/2024
6.2.19-preview023 132 8/8/2024
6.2.19-preview022 144 8/8/2024
6.2.19-preview021 123 8/5/2024
6.2.19-preview020 110 8/5/2024
6.2.19-preview019 126 8/5/2024
6.2.19-preview018 97 8/3/2024
6.2.19-preview017 117 7/30/2024
6.2.19-preview016 117 7/29/2024
6.2.19-preview015 119 7/29/2024
6.2.19-preview014 129 7/26/2024
6.2.19-preview013 136 7/20/2024
6.2.19-preview012 123 7/20/2024
6.2.19-preview011 134 6/15/2024
6.2.19-preview010 125 6/14/2024
6.2.19-preview009 130 6/14/2024
6.2.19-preview008 133 6/13/2024
6.2.19-preview007 131 6/13/2024
6.2.19-preview006 132 6/13/2024
6.2.19-preview005 126 6/13/2024
6.2.19-preview004 131 6/13/2024
6.2.19-preview003 136 6/11/2024
6.2.19-preview002 135 6/8/2024
6.2.19-preview001 137 6/8/2024
6.2.18 191 6/6/2024
6.2.18-preview020 130 6/6/2024
6.2.18-preview019 133 6/6/2024
6.2.18-preview018 150 6/6/2024
6.2.18-preview017 143 6/2/2024
6.2.18-preview016 142 6/1/2024
6.2.18-preview015 149 5/28/2024
6.2.18-preview014 144 5/28/2024
6.2.18-preview013 143 5/28/2024
6.2.18-preview012 141 5/28/2024
6.2.18-preview011 149 5/26/2024
6.2.18-preview010 139 5/26/2024
6.2.18-preview009 147 5/26/2024
6.2.18-preview008 150 5/26/2024
6.2.18-preview007 164 5/22/2024
6.2.18-preview006 138 5/22/2024
6.2.18-preview005 157 5/19/2024
6.2.18-preview004 144 5/19/2024
6.2.18-preview003 143 5/19/2024
6.2.18-preview002 145 5/19/2024
6.2.17 182 5/19/2024
6.2.16 179 5/18/2024
6.2.15 181 5/18/2024
6.2.14 179 5/18/2024
6.2.13 178 5/17/2024
6.2.12 180 5/17/2024
6.2.11 183 5/17/2024
6.2.10 180 5/17/2024
6.2.9 155 5/12/2024
6.2.8 175 5/9/2024
6.2.7 166 5/9/2024
6.2.6 173 5/7/2024
6.2.5 179 4/24/2024
6.2.4 263 2/1/2024
6.2.1 186 1/23/2024
6.2.0 177 1/23/2024
6.2.0-preview013 139 1/19/2024
6.2.0-preview012 135 1/19/2024
6.2.0-preview011 135 1/18/2024
6.2.0-preview010 144 1/14/2024
6.2.0-preview009 143 1/11/2024
6.2.0-preview008 151 1/1/2024
6.2.0-preview007 129 1/1/2024
6.2.0-preview006 141 1/1/2024
6.2.0-preview005 149 1/1/2024
6.2.0-preview001 165 12/30/2023
6.1.0 267 12/2/2023
6.1.0-preview003 174 12/2/2023
6.1.0-preview002 147 12/2/2023
6.1.0-preview001 166 12/2/2023
6.0.2 195 11/27/2023
6.0.1 195 11/22/2023
6.0.0 192 11/22/2023
3.5.0 230 10/28/2023
3.4.0 201 10/1/2023
3.3.1 218 9/30/2023
3.3.0 209 9/28/2023
3.2.5 211 9/28/2023
3.2.4 191 9/28/2023
3.2.3 199 9/28/2023
3.2.2 196 9/28/2023
3.2.1 190 9/28/2023
3.2.0 223 9/28/2023
3.1.0 205 9/27/2023
3.0.1 210 9/27/2023
3.0.0 215 9/14/2023
3.0.0-preview001 191 9/14/2023