A Serilog sink that send events and logs straight away to Datadog. By default the sink sends logs over HTTPS
Package - Serilog.Sinks.Datadog.Logs | Platforms - .NET 4.5, .NET 4.6.1, .NET 4.7.2, netstandard1.3, netstandard2.0
Note: For other .NET versions, ensure that the default TLS version used is 1.2
using (var log = new LoggerConfiguration()
.WriteTo.DatadogLogs("<API_KEY>")
.CreateLogger())
{
// Some code
}
By default the logs are forwarded to Datadog via HTTPS on port 443 to the US site.
You can change the site to EU by using the url
property and set it to https://http-intake.logs.datadoghq.eu
.
You can override the default behavior and use TCP forwarding by manually specifing the following properties (url, port, useSSL, useTCP).
You can also add the following properties (source, service, host, tags) to the Serilog sink.
var config = new DatadogConfiguration(url: "intake.logs.datadoghq.com", port: 10516, useSSL: true, useTCP: true);
using (var log = new LoggerConfiguration()
.WriteTo.DatadogLogs(
"<API_KEY>",
source: "<SOURCE_NAME>",
service: "<SERVICE_NAME>",
host: "<HOST_NAME>",
tags: new string[] {"<TAG_1>:<VALUE_1>", "<TAG_2>:<VALUE_2>"},
configuration: config
)
.CreateLogger())
{
// Some code
}
Sending the following log:
using (var log = new LoggerConfiguration()
.WriteTo.DatadogLogs("<API_KEY>")
.CreateLogger())
{
// An example
var position = new { Latitude = 25, Longitude = 134 };
var elapsedMs = 34;
log.Information("Processed {@Position} in {Elapsed:000} ms.", position, elapsedMs);
}
or
Log.Logger = new LoggerConfiguration()
.WriteTo.DatadogLogs("<API_KEY>")
.CreateLogger();
// An example
var position = new { Latitude = 25, Longitude = 134 };
var elapsedMs = 34;
Log.Information("Processed {@Position} in {Elapsed:000} ms.", position, elapsedMs);
Log.CloseAndFlush();
In the platform, the log looks like as the following JSON Object:
{
"message": "Processed { Latitude: 25, Longitude: 134 } in 034 ms.",
"MessageTemplate": "Processed {@Position} in {Elapsed:000} ms.",
"timestamp": "2022-11-23T09:48:56.0262350-05:00",
"level": "Information",
"Properties": {
"Position": {
"Latitude": 25,
"Longitude": 134
},
"Elapsed": 34
},
"Renderings": [
"034"
]
}
appsettings.json
Since 0.2.0, you can configure the Datadog sink by using an appsettings.json
file with
the Serilog.Settings.Configuration package.
In the "Serilog.WriteTo"
array, add an entry for DatadogLogs
. An example is shown below:
"Serilog": {
"Using": [ "Serilog.Sinks.Console", "Serilog.Sinks.Datadog.Logs" ],
"MinimumLevel": "Debug",
"WriteTo": [
{ "Name": "Console" },
{
"Name": "DatadogLogs",
"Args": {
"apiKey": "<API_KEY>",
"source": "<SOURCE_NAME>",
"host": "<HOST_NAME>",
"tags": ["<TAG_1>:<VALUE_1>", "<TAG_2>:<VALUE_2>"],
"configuration" : {
"url": "intake.logs.datadoghq.com",
"port": 10516,
"useSSL": true,
"useTCP": true
}
}
}
],
"Enrich": [ "FromLogContext", "WithMachineName", "WithThreadId" ],
"Properties": {
"Application": "Sample"
}
}
NOTE: the configuration
section is optional so that you may override the defaults.
You can implement a custom ITextFormatter
and pass it to the sink to change the format of your logs. This is useful if you want to add/remove/modify fields from the final JSON payload, or emit non-json logs to Datadog.
There are several options for implementing custom formatters. The easiest way is to use Serilog-expressions. Below is an example of a Serilog-expression ITextFormatter
that drops the MessageTemplate
field:
public class DatadogJsonNoTemplateFormatter: ExpressionTemplate
{
public DatadogJsonNoTemplateFormatter() : base(@"{ {
Timestamp: @t,
level: @l,
message: @m,
Properties: {..@p},
Renderings: @r}
}") {}
}
If you cannot use Serilog-expressions due to framework compatibility - you can implement your own with JsonValueFormatter
or a default implementation ex: serilog-formatting-compact
DatadogLogs
supports the following arguments:
argument | Type | Description |
---|---|---|
apiKey |
string |
Your Datadog API key. |
source |
string |
The integration name. |
service |
string |
The service name. |
host |
string |
The host name. |
tags |
string[] |
Custom tags. |
configuration |
DatadogConfiguration |
The Datadog logs client configuration. |
logLevel |
LogEventLevel |
The minimum log level for the sink. |
batchSizeLimit |
int |
The maximum number of events to emit in a single batch. |
batchPeriod |
TimeSpan |
The time to wait before emitting a new event batch. |
queueLimit |
int |
Maximum number of events to hold in the sink's internal queue, or null for an unbounded queue. The default is 10000 |
exceptionHandler |
Action<Exception> |
This function is called when an exception occurs when using DatadogConfiguration.UseTCP=false (the default configuration). |
detectTCPDisconnection |
bool |
Detect when the TCP connection is lost and recreate a new connection. |
formatter |
ITextFormatter |
A custom formatter implementation to change the format of the logs |
maxMessageSize |
int |
The maximum size in bytes of a message before it is split into chunks |
NOTE: if maxMessageSize
exceeds the documented API limit of 1MB - any payloads larger than 1MB will be dropped by the intake.
Bump the version in src/Serilog.Sinks.Datadog.Logs.csproj
and merge your branch
Run these commands in the project root folder
git checkout master && git pull
msbuild Serilog.Sinks.Datadog.Logs.sln /t:restore /p:Configuration=Release
msbuild Serilog.Sinks.Datadog.Logs.sln /t:pack /p:Configuration=Release
You can find the .nupkg
file at src/Serilog.Sinks.Datadog.Logs/bin/Release/Serilog.Sinks.Datadog.Logs.<version>.nupkg
As Serilog.Sinks.Datadog.Logs
implements Serilog.Sinks.PeriodicBatching, using Serilog.Sinks.Async is not recommended.
From Serilog.Sinks.Async documentation:
Note: many of the network-based sinks (CouchDB, Elasticsearch, MongoDB, Seq, Splunk...) already perform asynchronous batching natively and do not benefit from this wrapper.