Serilog.Sinks.AzureTableStorage 9.1.0

.NET 6.0 .NET Standard 2.0
dotnet add package Serilog.Sinks.AzureTableStorage --version 9.1.0
NuGet\Install-Package Serilog.Sinks.AzureTableStorage -Version 9.1.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.AzureTableStorage" Version="9.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Serilog.Sinks.AzureTableStorage --version 9.1.0
#r "nuget: Serilog.Sinks.AzureTableStorage, 9.1.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.AzureTableStorage as a Cake Addin
#addin nuget:?package=Serilog.Sinks.AzureTableStorage&version=9.1.0

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

Serilog.Sinks.AzureTableStorage Nuget

Writes to a table in Azure Table Storage.

Package - Serilog.Sinks.AzureTableStorage | Platforms - .NET Standard 2.0

var log = new LoggerConfiguration()
    .WriteTo.AzureTableStorage("<connectionString>")
    .CreateLogger();

Configuration

Configuration Description Default
connectionString The Cloud Storage Account connection string
sharedAccessSignature The storage account/table SAS key
accountName The storage account name
restrictedToMinimumLevel The minimum log event level required in order to write an event to the sink. Verbose
formatProvider Culture-specific formatting information
storageTableName Table name that log entries will be written to LogEvent
writeInBatches Use a periodic batching sink, as opposed to a synchronous one-at-a-time sink true
batchPostingLimit The maximum number of events to post in a single batch 100
period The time to wait between checking for event batches 0:0:2
keyGenerator The key generator used to create the PartitionKey and the RowKey for each log entry DefaultKeyGenerator
propertyColumns Specific log event properties to be written as table columns
bypassTableCreationValidation Bypass the exception in case the table creation fails false
documentFactory Provider to create table document from LogEvent DefaultDocumentFactory
tableClientFactory Provider to create table client DefaultTableClientFactory
partitionKeyRounding Partition key rounding time span 0:5:0

JSON configuration

It is possible to configure the sink using Serilog.Settings.Configuration by specifying the table name and connection string in appsettings.json:

"Serilog": {
  "WriteTo": [
    {"Name": "AzureTableStorage", "Args": {"storageTableName": "", "connectionString": ""}}
  ]
}

JSON configuration must be enabled using ReadFrom.Configuration(); see the documentation of the JSON configuration package for details.

XML <appSettings> configuration

To use the file sink with the Serilog.Settings.AppSettings package, first install that package if you haven't already done so:

Install-Package Serilog.Settings.AppSettings

Instead of configuring the logger in code, call ReadFrom.AppSettings():

var log = new LoggerConfiguration()
    .ReadFrom.AppSettings()
    .CreateLogger();

In your application's App.config or Web.config file, specify the file sink assembly and required path format under the <appSettings> node:

<configuration>
  <appSettings>
    <add key="serilog:using:AzureTableStorage" value="Serilog.Sinks.AzureTableStorage" />
    <add key="serilog:write-to:AzureTableStorage.connectionString" value="DefaultEndpointsProtocol=https;AccountName=ACCOUNT_NAME;AccountKey=KEY;EndpointSuffix=core.windows.net" />
    <add key="serilog:write-to:AzureTableStorage.formatter" value="Serilog.Formatting.Compact.CompactJsonFormatter, Serilog.Formatting.Compact" />
  </appSettings>
</configuration>

Example Configuration for ASP.NET

public static class Program
{
    private const string OutputTemplate = "{Timestamp:HH:mm:ss.fff} [{Level:u1}] {Message:lj}{NewLine}{Exception}";

    public static async Task<int> Main(string[] args)
    {
        // azure home directory
        var homeDirectory = Environment.GetEnvironmentVariable("HOME") ?? ".";
        var logDirectory = Path.Combine(homeDirectory, "LogFiles");

        Log.Logger = new LoggerConfiguration()
            .MinimumLevel.Verbose()
            .MinimumLevel.Override("Microsoft", LogEventLevel.Information)
            .Enrich.FromLogContext()
            .WriteTo.Console(outputTemplate: OutputTemplate)
            .WriteTo.File(
                path: $"{logDirectory}/boot.txt",
                rollingInterval: RollingInterval.Day,
                shared: true,
                flushToDiskInterval: TimeSpan.FromSeconds(1),
                outputTemplate: OutputTemplate,
                retainedFileCountLimit: 10
            )
            .CreateBootstrapLogger();

        try
        {
            Log.Information("Starting web host");

            var builder = Microsoft.AspNetCore.Builder.WebApplication.CreateBuilder(args);

            builder.Host
                .UseSerilog((context, services, configuration) => configuration
                    .ReadFrom.Configuration(context.Configuration)
                    .ReadFrom.Services(services)
                    .Enrich.FromLogContext()
                    .Enrich.WithProperty("ApplicationName", builder.Environment.ApplicationName)
                    .Enrich.WithProperty("EnvironmentName", builder.Environment.EnvironmentName)
                    .WriteTo.Console(outputTemplate: OutputTemplate)
                    .WriteTo.File(
                        path: $"{logDirectory}/log.txt",
                        rollingInterval: RollingInterval.Day,
                        shared: true,
                        flushToDiskInterval: TimeSpan.FromSeconds(1),
                        outputTemplate: OutputTemplate,
                        retainedFileCountLimit: 10
                    )
                    .WriteTo.AzureTableStorage(
                        connectionString: context.Configuration.GetConnectionString("StorageAccount"),
                        propertyColumns: new[] { "SourceContext", "RequestId", "RequestPath", "ConnectionId", "ApplicationName", "EnvironmentName" }
                    )
                );

            ConfigureServices(builder);

            var app = builder.Build();

            ConfigureMiddleware(app);

            await app.RunAsync();

            return 0;
        }
        catch (Exception ex)
        {
            Log.Fatal(ex, "Host terminated unexpectedly");
            return 1;
        }
        finally
        {
            await Log.CloseAndFlushAsync();
        }
    }

    private static void ConfigureServices(WebApplicationBuilder builder)
    {
    }

    private static void ConfigureMiddleware(Microsoft.AspNetCore.Builder.WebApplication app)
    {
    }
}

Change Log

9.1.0

  • Add: Built-in trace and span id support

9.0.0

  • Breaking: Due to issue with creating provides from configuration
    • IDocumentFactory.Create add AzureTableStorageSinkOptions and IKeyGenerator arguments
    • IKeyGenerator.GeneratePartitionKey add AzureTableStorageSinkOptions argument
    • IKeyGenerator.GenerateRowKey add AzureTableStorageSinkOptions argument
  • Fix: DefaultDocumentFactory and DefaultKeyGenerator needed paramaterless contructor for use in configuration files
  • Add: ITableClientFactory to control TableClient creation

8.5.0

  • Add option for partition key rounding
  • Move IKeyGenertor from options
  • Add DateTime extension methods for partition key and row key
  • Add sample web project

8.0.0

  • Breaking: major refactor to simplify code base
    • Removed: AzureTableStorageWithProperties extension removed, use equivalent AzureTableStorage
    • Removed: ICloudTableProvider provider removed
    • Added: IDocumentFactory to allow control over table document
    • Change: PartitionKey and RowKey changed to new implementation

7.0.0

  • Update dependencies: repace Microsoft.Azure.Cosmos.Table with Azure.Data.Tables

6.0.0

  • Updated dependencies: replace deprecated package WindowsAzure.Storage with Microsoft.Azure.Cosmos.Table 1.0.8
  • Updated dependencies: Serilog 2.10.0

5.0.0

  • Migrated to new CSPROJ project system
  • Updated dependencies: WindowsAzure.Storage 8.6.0, Serilog 2.6.0, Serilog.Sinks.PeriodicBatching 2.1.1
  • Fix #36 - Allow using SAS URI for logging.

1.5

  • Moved from serilog/serilog
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-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 netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  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)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (10)

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

Package Downloads
TouchConvert.Tenant.Api.V1.Dtos

Data transfer objects for TouchConvert version one APIs.

TouchConvert.Tenant.Api.V2.Dtos

Data transfer objects for TouchConvert version two APIs.

BumperLane.Hosted.Api.V2.Application

BumperLane Core API functionality

AzureWebFarm.OctopusDeploy

Scalable, OctopusDeploy-powered webfarm using Windows Azure Web Roles.

CorpOS.Diagnostics

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
9.1.0 2,508 11/9/2023
9.0.0 24,857 8/6/2023
9.0.0-beta.2 93 8/1/2023
9.0.0-beta.1.1 97 8/1/2023
8.5.42-alpha.0.7 88 8/1/2023
8.5.41 21,930 6/24/2023
8.5.39-beta 257 6/24/2023
8.5.38 35,522 5/8/2023
8.5.36-beta 282 5/2/2023
8.0.35 3,537 4/16/2023
8.0.33-beta 242 4/16/2023
8.0.31-beta 271 4/16/2023
8.0.30-beta 248 4/11/2023
8.0.28-beta 280 4/10/2023
8.0.27-beta 301 3/27/2023
7.0.25 17,702 3/25/2023
7.0.22-beta 285 3/25/2023
6.0.0-dev-00146 14,278 4/29/2021
5.0.0 1,129,318 7/28/2020
5.0.0-dev-00116 89,322 9/8/2018
5.0.0-dev-00111 2,069 9/4/2018
5.0.0-dev-00109 809 9/4/2018
5.0.0-dev-00105 7,679 5/9/2018
5.0.0-dev-00101 1,053 4/24/2018
5.0.0-dev-00093 6,273 3/20/2018
4.0.0 1,409,263 6/13/2017
4.0.0-dev-00089 1,180 5/22/2017
4.0.0-dev-00082 4,309 3/14/2017
4.0.0-dev-00079 1,222 3/4/2017
4.0.0-dev-00077 1,043 3/1/2017
4.0.0-dev-00074 995 2/28/2017
4.0.0-dev-00069 2,445 2/13/2017
3.0.1-dev-00067 2,379 2/3/2017
3.0.0 144,825 11/22/2016
3.0.0-dev-00055 1,093 10/14/2016
3.0.0-dev-00052 1,008 10/7/2016
3.0.0-dev-00045 1,961 10/6/2016
3.0.0-dev-00044 2,190 10/3/2016
3.0.0-dev-00039 1,198 10/3/2016
2.0.1-dev-00030 2,073 7/19/2016
2.0.0 55,597 6/29/2016
2.0.0-beta-20 2,086 4/26/2016
1.5.14 34,533 4/17/2016
1.5.11 12,321 12/26/2015
1.5.5 32,009 4/2/2015
1.5.4 2,664 4/2/2015
1.5.3 1,381 4/1/2015
1.5.2 2,130 3/30/2015
1.5.1 1,333 3/27/2015
1.4.196 2,052 2/22/2015
1.4.182 1,590 2/15/2015
1.4.168 1,531 2/8/2015
1.4.155 1,477 2/1/2015
1.4.139 1,286 1/23/2015
1.4.118 1,455 1/13/2015
1.4.113 1,611 1/6/2015
1.4.102 1,893 12/21/2014
1.4.99 1,736 12/18/2014
1.4.97 1,639 12/18/2014
1.4.76 1,636 12/8/2014
1.4.75 1,587 12/7/2014
1.4.39 1,510 11/26/2014
1.4.34 1,449 11/24/2014
1.4.28 1,472 11/24/2014
1.4.27 1,574 11/23/2014
1.4.23 1,598 11/21/2014
1.4.22 1,527 11/21/2014
1.4.21 1,493 11/21/2014
1.4.18 1,676 11/18/2014
1.4.15 1,879 11/4/2014
1.4.14 1,454 10/23/2014
1.4.13 1,379 10/23/2014
1.4.12 1,493 10/12/2014
1.4.11 1,330 10/8/2014
1.4.10 2,161 9/26/2014
1.4.9 1,493 9/17/2014
1.4.8 1,454 9/11/2014
1.4.7 2,023 9/1/2014
1.4.6 1,438 8/31/2014
1.4.5 1,305 8/27/2014
1.4.4 1,410 8/27/2014
1.4.3 2,292 8/25/2014
1.4.2 1,274 8/23/2014
1.4.1 1,292 8/23/2014
1.3.43 1,486 8/4/2014
1.3.42 1,343 7/30/2014
1.3.41 1,354 7/28/2014
1.3.40 1,336 7/26/2014
1.3.39 1,371 7/25/2014
1.3.37 1,340 7/25/2014
1.3.36 1,373 7/20/2014
1.3.35 1,339 7/17/2014
1.3.34 1,342 7/6/2014
1.3.33 1,341 6/30/2014
1.3.30 1,341 6/19/2014
1.3.29 1,336 6/19/2014
1.3.28 1,376 6/19/2014
1.3.27 1,356 6/18/2014
1.3.26 1,344 6/18/2014
1.3.25 1,368 6/9/2014
1.3.24 1,389 5/21/2014
1.3.23 1,333 5/20/2014
1.3.20 1,387 5/18/2014
1.3.19 1,375 5/17/2014
1.3.18 1,352 5/17/2014
1.3.17 1,345 5/17/2014
1.3.16 1,343 5/17/2014
1.3.15 1,339 5/16/2014
1.3.14 1,364 5/16/2014
1.3.13 1,325 5/16/2014
1.3.12 1,303 5/14/2014
1.3.7 1,348 5/11/2014
1.3.6 1,376 5/9/2014
1.3.5 1,386 5/6/2014
1.3.4 1,351 5/4/2014
1.3.3 1,459 4/28/2014
1.3.1 1,614 4/26/2014
1.2.53 1,462 4/26/2014
1.2.52 1,448 4/24/2014
1.2.51 1,551 4/18/2014
1.2.50 1,550 4/18/2014
1.2.49 1,460 4/17/2014
1.2.48 1,552 4/14/2014
1.2.47 1,549 4/14/2014
1.2.45 1,553 4/13/2014
1.2.44 1,543 4/9/2014
1.2.41 1,820 4/7/2014
1.2.40 1,449 4/7/2014
1.2.39 1,850 3/29/2014
1.2.38 1,436 3/29/2014
1.2.37 1,492 3/29/2014
1.2.29 1,699 3/16/2014
1.2.27 1,464 3/14/2014
1.2.26 1,377 3/12/2014
1.2.25 2,943 2/20/2014
0.9.9 2,101 11/23/2013
0.9.1 2,226 8/24/2013
0.8.6 1,528 7/29/2013
0.8.5 1,652 7/22/2013
0.8.1 1,696 7/9/2013
0.7.2 1,658 7/6/2013
0.6.1 1,563 6/13/2013
0.5.2 1,644 5/27/2013
0.5.1 1,494 5/26/2013
0.4.3 1,718 5/25/2013