Skip to content

Azure/serilog-sinks-azuredataexplorer

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 

Serilog.Sinks.AzureDataExplorer

.NET Nuget

A Serilog sink that writes events to an Azure Data Explorer (Kusto) cluster.

Package - Serilog.Sinks.AzureDataExplorer | Platforms - .Net 6.0

Getting started

Install from NuGet:

Install-Package Serilog.Sinks.AzureDataExplorer

How to use

var log = new LoggerConfiguration()
    .WriteTo.AzureDataExplorer(new AzureDataExplorerSinkOptions
    {
        IngestionEndpointUri = "https://ingest-mycluster.northeurope.kusto.windows.net",
        DatabaseName = "MyDatabase",
        TableName = "Serilogs"
    })
    .CreateLogger();

Features

Options

Batching

  • BatchPostingLimit: The maximum number of events to post in a single batch. Defaults to 1000.
  • Period: The time to wait between checking for event batches. Defaults to 10 seconds.
  • QueueSizeLimit: The maximum number of events that will be held in-memory while waiting to ship them to AzureDataExplorer. Beyond this limit, events will be dropped. The default is 100,000.

Target ADX Cluster

  • IngestionEndpointUri: Azure Data Explorer endpoint (Ingestion endpoint for Queued Ingestion, Query endpoint for Streaming Ingestion)
  • DatabaseName: The name of the database to which data should be ingested to
  • TableName: The name of the table to which data should be ingested to
  • UseStreamingIngestion: Whether to use streaming ingestion (reduced latency, at the cost of reduced throughput) or queued ingestion (increased latency, but much higher throughput).

Mapping

Azure Data Explorer provides data mapping capabilities, allowing the ability to extract data rom the ingested JSONs as part of the ingestion. This allows paying a one-time cost of processing the JSON during ingestion, and reduced cost at query time.

By default, the sink uses the following data mapping:

Column Name Column Type JSON Path
Timestamp datetime $.Timestamp
Level string $.Level
Message string $.Message
Exception string $.Exception
Properties dynamic $.Properties

This mapping can be overridden using the following options:

  • MappingName: Use a data mapping configured in ADX.
  • ColumnsMapping: Use an ingestion-time data mapping.

Authentication

The sink supports authentication using various methods. Use one of the following methods to configure the desired authentication methods:

new AzureDataExplorerSinkOptions()
    .WithXXX(...)
Mode Method Notes
AadUserPrompt WithAadUserPrompt Recommended only development!
AadUserToken WithAadUserToken
AadApplicationCertificate WithAadApplicationCertificate
AadApplicationKey WithAadApplicationKey
AadApplicationSubjectName WithAadApplicationSubjectName
AadApplicationThumbprint WithAadApplicationThumbprint
AadApplicationToken WithAadApplicationToken
AadAzureTokenCredentials WithAadAzureTokenCredentials

About

A Serilog sink that writes events to Azure Data Explorer

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages