CB.Serilog.Sinks.AzureLogAnalytics 1.1.7

Serilog Sink for Azure Log Analytics

A bare bones custom Serilog sink for Azure Log Analytics. Supports batching of logs. Utilizes the Azure.Monitor.Ingestion library for ingestion to Log Analytics.

Prerequisites

1. Azure Subscription
2. Log Analytics workspace provisioned
3. A configured data collection endpoint and data collection rule in Azure with appropriate permissions.

Get Started

Install package

dotnet add package CB.Serilog.Sinks.AzureLogAnalytics

Authenticate with Azure

By default, a DefaultAzureCredential is used to authenticate with Azure and no additional code is needed. Optionally, a TokenCredential can be passed in for use.

Configure

The sink can be configured programatticaly or through Serilog Serilog.Settings.Configuration NuGet package. An instance of AzureLogAnalyticsSinkConfiguration is required.

App Config Example program.cs

Host.CreateDefaultBuilder()
    .UseSerilog((hostingContext, services, loggerConfiguration) =>
    {
        var assemblies = new[] { typeof(AzureLogAnalyticsSink).Assembly };
        var options = new ConfigurationReaderOptions(assemblies);
        loggerConfiguration
        .Enrich.FromLogContext()
        .ReadFrom.Configuration(hostingContext.Configuration, options);
    });

app.config.json

 "Serilog": {
    "Using": [ "Serilog.Sinks.AzureLogAnalytics" ],
    "MinimumLevel": "Verbose",
    "WriteTo": [
      {
        "Name": "AzureLogAnalytics",
        "Args": {
          "DataCollectionEndpointUri": "<data-collection-endpoint>",
          "RuleId": "<rule-id>",
          "StreamName": "<stream-name>",
          "OutputToConsole": true,
          "MaxLogEntries": 5
        }
      }
    ]
  }

IHostBuilder Example

program.cs

Host.CreateDefaultBuilder()
    .UseSerilog((hostingContext, services, loggerConfiguration) =>
    {
        loggerConfiguration
        .Enrich.FromLogContext()
        .WriteTo.AzureLogAnalytics(new AzureLogAnalyticsSinkConfiguration
        {
            DataCollectionEndpointUri = new Uri("<data-collection-endpoint>"),
            MaxLogEntries = 10,
            RuleId = "<rule-id>",
            StreamName = "<stream-name>",
            OutputToConsole = true,
            TokenCredential = "optional token credential"
        })
    });

The AzureLogAnalyticsSinkConfiguration type is used to configure the sink.