Vestfold.Extensions.Logging 3.4.1

👁 NuGet Version
👁 NuGet Downloads

Vestfold.Extensions.Logging

Contains builder extensions for configuring logging in a dotnet core application.

Adding environment variables in an Azure App Service (Web App or Function App)

Usage in an Azure Function App

Add the following to your local.settings.json file to have a nested structure for the configuration:

All properties (except AzureWebJobsStorage (Azure App Service specific) and FUNCTIONS_WORKER_RUNTIME (Azure Function App specific)) are optional.

Semi optional properties:

• AppName: If not set, the assembly name will be used as AppName property in logs<br />
• AppVersion: If not set, the assembly version will be used as Version property in logs.<br />

{
 "IsEncrypted": false,
 "Values": {
 "AzureWebJobsStorage": "UseDevelopmentStorage=true",
 "FUNCTIONS_WORKER_RUNTIME": "dotnet-isolated",
 "AppName": "Name of your application, used as a property in the logs",
 "AppVersion": "1.0.0",
 "BetterStack__SourceToken": "Your BetterStack source token",
 "BetterStack__Endpoint": "https://foo.betterstackdata.com",
 "BetterStack__MinimumLevel": "Information",
 "MicrosoftTeams__WebhookUrl": "microsoft teams webhook url | microsoft power automate flow url if UseWorkflows is set to true",
 "MicrosoftTeams__UseWorkflows": "true if Microsoft Power Automate flow is used, false if Microsoft Teams webhook is used (default is true)",
 "MicrosoftTeams__TitleTemplate": "The title template of the card",
 "MicrosoftTeams__MinimumLevel": "Warning",
 "Serilog__AzureLogAnalytics__ClientId": "Your Azure Log Analytics client id",
 "Serilog__AzureLogAnalytics__ClientSecret": "Your Azure Log Analytics client secret",
 "Serilog__AzureLogAnalytics__Endpoint": "logs ingestion URL for data collection endpoint",
 "Serilog__AzureLogAnalytics__ImmutableId": "ImmutableId for Data Collection Rules (DCR)",
 "Serilog__AzureLogAnalytics__StreamName": "Output stream name of target (Log Analytics API, can be accessed from DCR)",
 "Serilog__AzureLogAnalytics__TenantId": "Directory (tenant) ID of the registered application (Microsoft Entra ID)",
 "Serilog__AzureLogAnalytics__MinimumLevel": "Information",
 "Serilog__AzureLogAnalytics__BatchSize": "The number of log events that are sent in a single request to Azure Log Analytics (default is 100). Typical range is between 1 and 1000",
 "Serilog__AzureLogAnalytics__BufferSize": "The maximum number of log events stored in memory waiting to be sent to Azure Log Analytics (default is 5000)",
 "Serilog__AzureLogAnalytics__PeriodSeconds": "The maximum delay in seconds between sending batches to Azure Log Analytics (default is 30)",
 "Serilog__Console__MinimumLevel": "Information",
 "Serilog__File__Path": "log.txt",
 "Serilog__File__MinimumLevel": "Warning",
 "Serilog__File__RollingInterval": "Day"
 }
}

Override minimum levels for certain namespaces

Example: Add an override for everything in the Microsoft.Hosting namespace to log from Warning and higher

{
 "Values": {
 "Serilog__MinimumLevel__Override__Microsoft_Hosting": "Warning"
 }
}

Usage outside Azure

Add the following to your appsettings.json file:

All properties are optional.

Semi optional properties:

• AppName: If not set, the assembly name will be used as AppName property in logs<br />
• AppVersion: If not set, the assembly version will be used as Version property in logs

{
 "AppName": "Name of your application, used as a property in the logs",
 "AppVersion": "1.0.0",
 "BetterStack": {
 "SourceToken": "Your BetterStack source token",
 "Endpoint": "https://foo.betterstackdata.com",
 "MinimumLevel": "Information"
 },
 "MicrosoftTeams": {
 "WebhookUrl": "microsoft teams webhook url | microsoft power automate flow url if UseWorkflows is set to true",
 "UseWorkflows": "true if Microsoft Power Automate flow is used, false if Microsoft Teams webhook is used (default is true)",
 "TitleTemplate": "The title template of the card",
 "MinimumLevel": "Warning"
 },
 "Serilog": {
 "AzureLogAnalytics": {
 "ClientId": "Your Azure Log Analytics client id",
 "ClientSecret": "Your Azure Log Analytics client secret",
 "Endpoint": "logs ingestion URL for data collection endpoint",
 "ImmutableId": "ImmutableId for Data Collection Rules (DCR)",
 "StreamName": "Output stream name of target (Log Analytics API, can be accessed from DCR)",
 "TenantId": "Directory (tenant) ID of the registered application (Microsoft Entra ID)",
 "MinimumLevel": "Information",
 "BatchSize": "The number of log events that are sent in a single request to Azure Log Analytics (default is 100). Typical range is between 1 and 1000",
 "BufferSize": "The maximum number of log events stored in memory waiting to be sent to Azure Log Analytics (default is 5000)",
 "PeriodSeconds": "The maximum delay in seconds before sending a batch to Azure Log Analytics (default is 30)"
 },
 "Console": {
 "MinimumLevel": "Information"
 },
 "File": {
 "Path": "log.txt",
 "MinimumLevel": "Warning",
 "RollingInterval": "Day"
 }
 }
}

Override minimum levels for certain namespaces

Example: Add an override for everything in the Microsoft.Hosting namespace to log from Warning and higher

{
 "Serilog": {
 "MinimumLevel": {
 "Override": {
 "Microsoft.Hosting": "Warning"
 }
 }
 }
}

Setting up logging for an Azure Function App / Azure Web App

var builder = FunctionsApplication.CreateBuilder(args);
builder.ConfigureFunctionsWebApplication();
builder.Logging.AddVestfoldLogging();
builder.Build().Run();

Setting up logging for a HostBuilder (Console app, ClassLibrary, etc.)

public static async Task Main(string[] args)
{
 await Host.CreateDefaultBuilder(args)
 .ConfigureLogging(builder => builder.AddVestfoldLogging())
 .Build()
 .RunAsync();

 await Serilog.Log.CloseAndFlushAsync();
}

Setting up logging for a WebApplicationBuilder (WebAPI, Blazor, etc.)

var builder = WebApplication.CreateBuilder(args);
builder.Logging.AddVestfoldLogging();

var app = builder.Build();

Sending logs

To send a SecurityAudit log, you need to make sure that SecurityAudit is set as a property in the log context:

using Serilog.Context;

Log.Information("This log will not be sent to the AzureLogAnalytics sink since SecurityAudit property is not set");

using (LogContext.PushProperty(Vestfold.Extensions.Logging.Constants.Properties.SecurityAudit, true))
{
 Log.Information("This is a security audit log and will be sent to the AzureLogAnalytics sink if the minimum level is set to Information or lower");
}

Log.Warning("This log will not be sent to the AzureLogAnalytics sink since SecurityAudit property is not set");