Serilog.Sinks.InfluxDB.Syslog 2.3.5

Serilog.Sinks.InfluxDB.Syslog

Serilog 输出Sink，可以将事件写入到以日志消息格式（默认情况）描述在 Influx 博客 中的 InfluxDB。可以通过以下方式通过输出配置来自定义确切字段、标签甚至测量名称。支持与 .NET 平台标准 兼容的平台 netstandard2.0。

仅与 InfluxDB v2.0 及以上版本兼容

注意：针对 InfluxDB v1.X 的使用，请使用以下 nuget 包：

关于 V1，参见 V1.X 入门

入门

InfluxDB v2.X

要开始使用，请安装 Serilog.Sinks.InfluxDB.Syslog 包

PM> Install-Package Serilog.Sinks.InfluxDB.Syslog

或

$ dotnet add package Serilog.Sinks.InfluxDB.Syslog

如果要在本地进行开发，您可以在此存储库的根目录中使用 docker-compose-v2.yml，如需则调整卷。

$ docker-compose -f docker-compose-v2.yml up -d

将记录器指向 InfluxDb（使用默认的 _internal 数据库作为最快的方式）

Log.Logger = new LoggerConfiguration()
    .WriteTo.InfluxDB(applicationName: "Quick test",
                    uri: new Uri("http://127.0.0.1:8086"),
                    organizationId: "88e1f5a5ad074d9e",  // Organization Id - unique id can be found under Profile > About > Common Ids)
                    bucketName: "logs",
                    token: "bGfBKhSycNiUOia4k7peib2jHFewkz3o6Hv2uz1xAoUcdnEFRW7cHn03KICySLemA4VPZKvc0CwzSQT8GNl2DA==")
    .CreateLogger();

另一个示例，使用 InfluxDBSinkOptions 获得更多对周期性批处理选项和连接信息的控制

Log.Logger = new LoggerConfiguration()
    .WriteTo.InfluxDB(new InfluxDBSinkOptions()
    {
        ApplicationName = "fluentSample",
        InstanceName = "fluentSampleInstance",
        ConnectionInfo = new InfluxDBConnectionInfo()
        {
            Uri = new Uri("http://127.0.0.1:8086"),
            BucketName = "logs",
            OrganizationId = "88e1f5a5ad074d9e",  // Organization Id - unique id can be found under Profile > About > Common Ids
            // To be set if bucket already created and give write permission and set CreateBucketIfNotExists to false
            Token = null,
            CreateBucketIfNotExists = true,
            //To specify if Bucket needs to be created and if token not known or without all access permissions
            AllAccessToken = "bGfBKhSycNiUOia4k7peib2jHFewkz3o6Hv2uz1xAoUcdnEFRW7cHn03KICySLemA4VPZKvc0CwzSQT8GNl2DA==",
            BucketRetentionPeriod = TimeSpan.FromDays(1)
        },
        BatchOptions = new PeriodicBatching.PeriodicBatchingSinkOptions()
        {
            BatchSizeLimit = 50,
            Period = TimeSpan.FromSeconds(10),
            EagerlyEmitFirstEvent = true,
            QueueLimit = null
        }
    })
    .CreateLogger();

如果您使用 appsettings.json 进行配置，以下示例展示了使用 InfluxDb 和控制台输出。

{
    "Serilog": {
        "Using": ["Serilog.Sinks.Console", "Serilog.Sinks.InfluxDB.Syslog"],
        "MinimumLevel": {
          "Default": "Information",
          "Override": {
            "Microsoft": "Warning",
            "System": "Warning"
          }
        },
        "WriteTo:Influx": {
          "Name": "InfluxDB",
          "Args": {
            "sinkOptions": {
              "ApplicationName": "testApp",
              "InstanceName": "testInstance",
              "ConnectionInfo": {
                "Uri": "https://127.0.0.1:8086",
                "BucketName": "logs",
                "OrganizationId": "88e1f5a5ad074d9e",
                "Token": "edBlcWgLkoPOituD_6V1ftCznpDR8niFcF46MJCSYuSxc1FM_srm9cuoc84yX5kOjOH_11Zvxk_juqr44S-57A==",
                "CreateBucketIfNotExists": false 
                //"Username": "influxdbroot",
                //"Password": "TBD"
                "BucketRetentionPeriod": "7.00:00:00",
              },
              "BatchOptions": {
                "EagerlyEmitFirstEvent": true,
                "BatchSizeLimit": 100,
                "Period": "0.00:00:30",
                "QueueLimit": 1000000
              }
            }
          }
        },
        "Properties": {
            "Application": "Serilog Sink InfluxDb Console Sample"
        }
    }
}

所有示例都可以在这个存储库的 samples 子目录下找到。

可选参数

"sinkOptions": {
  "MeasurementName": "syslog",
  "ApplicationName": "testApp",
  "InstanceName": "testInstance",
  "IncludeFullException": true,
  "IncludeHostname": false,
  "IncludeLevel": true,
  "IncludeSeverity": true,
  "IncludeDefaultFields": true,
  "ExtendedFields": ["ReleaseNumber"],
  "ExtendedTags": [],
  ...
}

非 syslog 格式支持

自从创建此插件以来，InfluxDB 现在支持更灵活的日志方法，从而消除了对严格 syslog 格式的严格要求。这意味着可以通过以下配置创建更简单的日志有效负载，而不需要额外的与 syslog 相关的条目

"sinkOptions": {
  "MeasurementName": "mymeasurement",
  "IncludeHostname": false,
  "IncludeLevel": false,
  "IncludeSeverity": false,
  "IncludeDefaultFields": false,
  ...
}

此配置将生成只包含消息和时间的日志条目

[
  {
    Time: DateTime_1,
    Field: message,
    Value: Some warning "Some parameter",
    Tags: {}
  }
]

InfluxDB v1.X

**对于 InfluxDB v1.X，请使用以下 NuGet 包 😗*

PM> Install-Package Serilog.Sinks.InfluxDBV1.Syslog -Version 1.3.1

或

$ dotnet add package Serilog.Sinks.InfluxDBV1.Syslog --version 1.3.1

如果在本地进行开发，您可以在该存储库的根目录下使用 docker-compose.yml，并根据需要调整卷

$ docker-compose -f docker-compose.yml up -d

将记录器指向 InfluxDb（使用默认的 _internal 数据库作为最快的方式）

Log.Logger = new LoggerConfiguration()    
    .WriteTo.InfluxDB(
        applicationName: "Quick Test", 
        uri : new Uri("http://127.0.0.1:8086"));

另一个示例，使用 InfluxDBSinkOptions 获得更多对周期性批处理选项和连接信息的控制

Log.Logger = new LoggerConfiguration()
    .WriteTo.InfluxDB(new InfluxDBSinkOptions()
    {
        ApplicationName = "fluentSample",               // Application Name
        InstanceName = "fluentSampleInstance",          // Instance or Environment Name
        ConnectionInfo = new InfluxDBConnectionInfo()   // Connection Details
        {
            Uri = new Uri("http://127.0.0.1:8086"),
            DbName = "_internal",
        },
        BatchOptions = new PeriodicBatching.PeriodicBatchingSinkOptions()
        {
            BatchSizeLimit = 50,
            Period = TimeSpan.FromSeconds(10),
            EagerlyEmitFirstEvent = true,
            QueueLimit = null
        }
    })
    .CreateLogger();

如果您使用 appsettings.json 进行配置，以下示例展示了使用 InfluxDb 和控制台输出。

{
    "Serilog": {
        "Using": ["Serilog.Sinks.Console", "Serilog.Sinks.InfluxDBV1.Syslog"],
        "MinimumLevel": {
          "Default": "Information",
          "Override": {
            "Microsoft": "Warning",
            "System": "Warning"
          }
        },
        "WriteTo": [
          { "Name": "Console" },
          {
            "Name": "InfluxDB",
            "Args": {
              "sinkOptions": {
                "applicationName": "testApp",
                "instanceName": "testInstance",
                "ConnectionInfo": {
                  "Uri": "https://127.0.0.1:8086",
                  "DbName": "_internal",
                  "Username": "",
                  "Password": ""
                },
                "BatchOptions": {
                  "EagerlyEmitFirstEvent": true,
                  "BatchSizeLimit": 200,
                  "Period": "0.00:00:30",
                  "QueueLimit":  null
                }
              }
            }
          }
        ],
        "Properties": {
            "Application": "Serilog Sink InfluxDb Console Sample"
        }
    }
}

构建状态

分支	状态
主分支

基准测试

BenchmarkDotNet=v0.12.1,操作系统=Windows 10.0.19042

Intel Core i7-2640M CPU 2.80GHz (Sandy Bridge), 1 个 CPU，4 个逻辑和 2 个物理核心

.NET Core SDK=5.0.101 [宿主] : .NET Core 3.1.9 (CoreCLR 4.700.20.47201, CoreFX 4.700.20.47203), X64 RyuJIT [附加调试器]
默认作业 : .NET Core 3.1.9 (CoreCLR 4.700.20.47201, CoreFX 4.700.20.47203), X64 RyuJIT

故障排除

没有显示，我可以做什么？

如果在 Chronograf、Grafana 等工具中检查相关的数据库后，事件没有出现在 InfluxDb 中。这可能是因为您的应用程序无法联系 InfluxDb 服务器，或者 InfluxDb 服务器由于某些原因拒绝了日志事件。

服务器端问题

InfluxDb 服务器可能会拒绝不包含所需凭证的事件，请查看influxdb 故障排除文章（如果有效负载在某些方式下已损坏，或者日志事件过大以至于无法接受）。

客户端问题

如果没有在摄取日志中看到信息，那么可能是因为网络配置或连接问题而无法到达服务器。这些问题通过 Serilog 的 SelfLog 报告给应用程序。

在配置日志器后，请添加以下行以将任何错误信息打印到控制台

Serilog.Debugging.SelfLog.Enable(Console.Error);

如果控制台不可用，您可以将一个代表传入每个错误消息的委托传递给 SelfLog.Enable()

Serilog.Debugging.SelfLog.Enable(message => {
    // Do something with `message`
});

故障排除清单

• 检查 InfluxDb 连接性，如果出现 服务器端问题，请参阅上文
• 如上所述，打开 Serilog SelfLog 以检查客户端的连接性和其他问题。
• 确保在应用程序退出之前调用 Log.CloseAndFlush() 或销毁根 Logger - 否则，可能会丢失缓冲的事件。
• 如果您的应用程序是 Windows 控制台应用程序，还很重要在退出应用程序时关闭控制台窗口；如果使用标题栏上的关闭按钮，Windows 控制台应用程序会被“硬终止”，因此如果您使用它，发送到 InfluxDb 的缓冲事件可能会丢失。