serilog sinks datadog logs

serilog.sinks.datadog.logs

一个Serilog接收器，将事件直接发送到DataDog。默认情况下，水槽通过https发送日志

软件包-Serilog.sinks.datadog.logs |平台- .NET 4.5，.NET 4.6.1，.NET 4.7.2，NetStandard1.3，NetStandard2.0

注意：对于其他.NET版本，请确保使用的默认TLS版本为1.2

 using ( var log = new LoggerConfiguration ( )
    . WriteTo . DatadogLogs ( " <API_KEY> " )
    . CreateLogger ( ) )
{
    // Some code
}

默认情况下，日志将通过端口443上的HTTP转发到DATADOG到美国站点。您可以使用url属性将网站更改为欧盟，并将其设置为https://http-intake.logs.datadoghq.eu 。

您可以通过手动指定以下属性（URL，端口，USESSL，USETCP）来覆盖默认行为并使用TCP转发。

您还可以将以下属性（源，服务，主机，标签）添加到Serilog接收器中。

• 具有TCP转发器的示例，该示例将源，服务，主机和标签列表添加到日志中：

 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
} 

例子

发送以下日志：

 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 ) ;
}

或者

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 ( ) ;

在平台中，日志看起来像以下JSON对象：

{
    "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的配置

由于0.2.0，您可以使用serilog.settings.configuration软件包使用appsettings.json文件来配置DataDog接收器。

在"Serilog.WriteTo"阵列中，添加了DatadogLogs的条目。一个示例如下所示：

 "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 "
  }
}

注意： configuration部分是可选的，因此您可以覆盖默认值。

使用自定义日志格式

您可以实现自定义ITextFormatter ，并将其传递到接收器以更改日志的格式。如果要从最终的JSON有效载荷中添加/删除/修改字段，或将非JSON日志发射到Datadog，这将很有用。

实施自定义格式器有几种选择。最简单的方法是使用Serilog表达。下面是删除MessageTemplate字段的Serilog表达ITextFormatter的示例：

 public class DatadogJsonNoTemplateFormatter : ExpressionTemplate
{
    public DatadogJsonNoTemplateFormatter ( ) : base ( @"{ {
        Timestamp: @t,
        level: @l,
        message: @m, 
        Properties: {..@p},
        Renderings: @r}
    }" ) { }
}

如果由于框架兼容性而无法使用Serilog表达式 - 您可以使用JsonValueFormatter或默认实现实现自己的实现：

支持配置选项

DatadogLogs支持以下参数：

争论	类型	描述
apiKey	string	您的Datadog API密钥。
source	string	集成名称。
service	string	服务名称。
host	string	主机名。
tags	string[]	自定义标签。
configuration	DatadogConfiguration	Datadog日志客户端配置。
restrictedToMinimumLevel	LogEventLevel	水槽的最小日志水平。
batchSizeLimit	int	一批发射的最大事件数量。
batchPeriod	TimeSpan	散发新事件之前等待的时间。
queueLimit	int	在水槽内部队列中保存的最大事件数量，或无限队列的null 。默认值为10000
exceptionHandler	Action<Exception>	当使用DatadogConfiguration.UseTCP=false （默认配置）时，当发生异常时，将调用此功能。
detectTCPDisconnection	bool	检测何时丢失TCP连接并重新创建新连接。
formatter	ITextFormatter	自定义格式化器实现以更改日志的格式
maxMessageSize	int	消息将消息的最大大小分为块之前

注意：如果maxMessageSize超过了1MB的已记录的API限制 - 任何大于1MB的有效载荷都将被摄入量删除。

如何构建Nuget软件包

在src/Serilog.Sinks.Datadog.Logs.csproj中碰到版本

在项目根文件夹中运行这些命令

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

您可以在src/Serilog.Sinks.Datadog.Logs/bin/Release/Serilog.Sinks.Datadog.Logs.<version>.nupkg上找到.nupkg文件。

serilog.sinks.ashync

当Serilog.Sinks.Datadog.Logs实现serilog.sinks.sinks.periodicbatching时，不建议使用serilog.sinks.async。

来自serilog.sinks.s.ashync文档：

注意：许多基于网络的水槽（Couchdb，Elasticsearch，MongoDB，Seq，Splunk ...）已经进行了异步批次，并且无法从该包装器中受益。