Jinget.Logger
6.1.0-preview003
Prefix Reserved
See the version list below for details.
dotnet add package Jinget.Logger --version 6.1.0-preview003
NuGet\Install-Package Jinget.Logger -Version 6.1.0-preview003
<PackageReference Include="Jinget.Logger" Version="6.1.0-preview003" />
paket add Jinget.Logger --version 6.1.0-preview003
#r "nuget: Jinget.Logger, 6.1.0-preview003"
// Install Jinget.Logger as a Cake Addin #addin nuget:?package=Jinget.Logger&version=6.1.0-preview003&prerelease // Install Jinget.Logger as a Cake Tool #tool nuget:?package=Jinget.Logger&version=6.1.0-preview003&prerelease
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.
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. If authentication is enabled, this address should not contains the PROTOCOL itself. Use 'abc.com' instead of 'http://abc.com'
UserName
: Username, if authentication enabled on Elasticsearch service
Password
: Password, if authentication enabled on Elasticsearch service
UseSsl
: Use HTTP or HTTPS, if authentication enabled on Elasticsearch service.
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. foeach 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);
...
builder.Services.ConfigureElasticSearchLogger(
new ElasticSearchSettingModel
{
CreateIndexPerPartition = true,
UserName = <authentication username>,
Password = <authentication password>,
Url = <ElasticSearch Url>,
UseSsl = <true|false>,
RegisterDefaultLogModels = <true|false>,
DiscoveryTypes = new List<Type> { typeof(OperationLog) }
});
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) =>
{
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();
Here is the complete configuration for a .NET 7.0 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);
builder.Services.ConfigureElasticSearchLogger<OperationLog, ErrorLog, CustomLog>(
new ElasticSearchSettingModel
{
UserName = "myuser",
Password = "mypass",
Url = "192.168.1.1:9200",
UseSsl = false,
RegisterDefaultLogModels = false,
DiscoveryTypes = new List<Type> { typeof(OperationLog) }
});
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);
builder.Services.ConfigureElasticSearchLogger(
new ElasticSearchSettingModel
{
CreateIndexPerPartition = true,
UserName = "myuser",
Password = "mypass",
Url = "192.168.1.1:9200",
UseSsl = false
});
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.
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 7.0 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 | Versions 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. |
-
net6.0
- Jinget.Core (>= 6.1.0-preview003)
- Microsoft.Extensions.Logging (>= 8.0.0)
- NEST (>= 7.17.5)
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.0-preview008 | 62 | 11/25/2024 |
8.0.0-preview007 | 109 | 11/11/2024 |
8.0.0-preview006 | 88 | 11/2/2024 |
8.0.0-preview005 | 64 | 11/2/2024 |
8.0.0-preview004 | 68 | 11/1/2024 |
8.0.0-preview003 | 71 | 11/1/2024 |
8.0.0-preview002 | 61 | 11/1/2024 |
8.0.0-preview001 | 58 | 11/1/2024 |
6.2.23-preview003 | 67 | 10/31/2024 |
6.2.23-preview002 | 66 | 10/31/2024 |
6.2.22 | 91 | 10/26/2024 |
6.2.21 | 75 | 10/26/2024 |
6.2.20 | 79 | 10/26/2024 |
6.2.19-preview037 | 71 | 10/14/2024 |
6.2.19-preview036 | 69 | 9/30/2024 |
6.2.19-preview035 | 93 | 9/10/2024 |
6.2.19-preview034 | 85 | 9/9/2024 |
6.2.19-preview033 | 92 | 9/1/2024 |
6.2.19-preview032 | 92 | 9/1/2024 |
6.2.19-preview031 | 90 | 8/31/2024 |
6.2.19-preview029 | 90 | 8/26/2024 |
6.2.19-preview028 | 102 | 8/26/2024 |
6.2.19-preview027 | 105 | 8/26/2024 |
6.2.19-preview026 | 115 | 8/21/2024 |
6.2.19-preview025 | 107 | 8/21/2024 |
6.2.19-preview024 | 103 | 8/19/2024 |
6.2.19-preview023 | 89 | 8/8/2024 |
6.2.19-preview022 | 98 | 8/8/2024 |
6.2.19-preview021 | 69 | 8/5/2024 |
6.2.19-preview020 | 63 | 8/5/2024 |
6.2.19-preview019 | 72 | 8/5/2024 |
6.2.19-preview018 | 51 | 8/3/2024 |
6.2.19-preview017 | 66 | 7/30/2024 |
6.2.19-preview016 | 77 | 7/29/2024 |
6.2.19-preview015 | 77 | 7/29/2024 |
6.2.19-preview014 | 85 | 7/26/2024 |
6.2.19-preview013 | 84 | 7/20/2024 |
6.2.19-preview012 | 77 | 7/20/2024 |
6.2.19-preview011 | 95 | 6/15/2024 |
6.2.19-preview010 | 86 | 6/14/2024 |
6.2.19-preview009 | 84 | 6/14/2024 |
6.2.19-preview008 | 84 | 6/13/2024 |
6.2.19-preview007 | 81 | 6/13/2024 |
6.2.19-preview006 | 79 | 6/13/2024 |
6.2.19-preview005 | 78 | 6/13/2024 |
6.2.19-preview004 | 82 | 6/13/2024 |
6.2.19-preview003 | 89 | 6/11/2024 |
6.2.19-preview002 | 86 | 6/8/2024 |
6.2.19-preview001 | 89 | 6/8/2024 |
6.2.18 | 125 | 6/6/2024 |
6.2.18-preview020 | 93 | 6/6/2024 |
6.2.18-preview019 | 98 | 6/6/2024 |
6.2.18-preview018 | 98 | 6/6/2024 |
6.2.18-preview017 | 96 | 6/2/2024 |
6.2.18-preview016 | 90 | 6/1/2024 |
6.2.18-preview015 | 96 | 5/28/2024 |
6.2.18-preview014 | 91 | 5/28/2024 |
6.2.18-preview013 | 92 | 5/28/2024 |
6.2.18-preview012 | 92 | 5/28/2024 |
6.2.18-preview011 | 98 | 5/26/2024 |
6.2.18-preview010 | 94 | 5/26/2024 |
6.2.18-preview009 | 99 | 5/26/2024 |
6.2.18-preview008 | 95 | 5/26/2024 |
6.2.18-preview007 | 116 | 5/22/2024 |
6.2.18-preview006 | 95 | 5/22/2024 |
6.2.18-preview005 | 107 | 5/19/2024 |
6.2.18-preview004 | 99 | 5/19/2024 |
6.2.18-preview003 | 98 | 5/19/2024 |
6.2.18-preview002 | 102 | 5/19/2024 |
6.2.17 | 117 | 5/19/2024 |
6.2.16 | 109 | 5/18/2024 |
6.2.15 | 113 | 5/18/2024 |
6.2.14 | 115 | 5/18/2024 |
6.2.13 | 115 | 5/17/2024 |
6.2.12 | 117 | 5/17/2024 |
6.2.11 | 115 | 5/17/2024 |
6.2.10 | 114 | 5/17/2024 |
6.2.9 | 93 | 5/12/2024 |
6.2.8 | 109 | 5/9/2024 |
6.2.7 | 102 | 5/9/2024 |
6.2.6 | 116 | 5/7/2024 |
6.2.5 | 119 | 4/24/2024 |
6.2.4 | 194 | 2/1/2024 |
6.2.1 | 125 | 1/23/2024 |
6.2.0 | 113 | 1/23/2024 |
6.2.0-preview013 | 94 | 1/19/2024 |
6.2.0-preview012 | 86 | 1/19/2024 |
6.2.0-preview011 | 91 | 1/18/2024 |
6.2.0-preview010 | 97 | 1/14/2024 |
6.2.0-preview009 | 102 | 1/11/2024 |
6.2.0-preview008 | 108 | 1/1/2024 |
6.2.0-preview007 | 84 | 1/1/2024 |
6.2.0-preview006 | 95 | 1/1/2024 |
6.2.0-preview005 | 106 | 1/1/2024 |
6.2.0-preview001 | 120 | 12/30/2023 |
6.1.0 | 218 | 12/2/2023 |
6.1.0-preview003 | 129 | 12/2/2023 |
6.1.0-preview002 | 106 | 12/2/2023 |
6.1.0-preview001 | 125 | 12/2/2023 |
6.0.2 | 148 | 11/27/2023 |
6.0.1 | 150 | 11/22/2023 |
6.0.0 | 145 | 11/22/2023 |
3.5.0 | 174 | 10/28/2023 |
3.4.0 | 147 | 10/1/2023 |
3.3.1 | 161 | 9/30/2023 |
3.3.0 | 157 | 9/28/2023 |
3.2.5 | 154 | 9/28/2023 |
3.2.4 | 137 | 9/28/2023 |
3.2.3 | 146 | 9/28/2023 |
3.2.2 | 138 | 9/28/2023 |
3.2.1 | 138 | 9/28/2023 |
3.2.0 | 166 | 9/28/2023 |
3.1.0 | 151 | 9/27/2023 |
3.0.1 | 155 | 9/27/2023 |
3.0.0 | 156 | 9/14/2023 |
3.0.0-preview001 | 140 | 9/14/2023 |