Elastic.Serilog.Sinks 8.11.1

Elastic.Serilog.Sinks

A Serilog 接收器，将日志直接写入 Elasticsearch 或 Elastic Cloud

例子

有几种方式可以扩展一个 Serilog 的 LoggerConfiguration

Log.Logger = new LoggerConfiguration()
	.MinimumLevel.Debug()
	.Enrich.FromLogContext()

注意：不要忘了我们还发布了一个用于 Elastic APM Agent 的 Elastic.Apm.SerilogEnricher！

写入到 Elasticsearch

.WriteTo.Elasticsearch(new [] { new Uri("https://127.0.0.1:9200" )}, opts =>
{
	opts.DataStream = new DataStreamName("logs", "console-example", "demo");
	opts.BootstrapMethod = BootstrapMethod.Failure;
	opts.ConfigureChannel = channelOpts =>
	{
		channelOpts.BufferOptions = new BufferOptions 
		{ 
			ConcurrentConsumers = 10 
		};
	};
})

写入到 Elastic Cloud

.WriteTo.ElasticCloud("cloudId", "cloudUser", "cloudPass", opts =>

opts 是一个包含以下选项的 ElasticsearchSinkOptions 实例

请注意，您还可以直接传递ElasticsearchSinkOptions。

.WriteTo.Elasticsearch(new ElasticsearchSinkOptions(client.Transport)

这允许您复用Elasticsearch客户端使用的Transport。

ECS感知消息模板

通过其格式化器作为代理，这个数据流允许您使用符合https://messagetemplates.org/格式的属性直接从消息模板中设置ECS字段。

可用的ECS消息模板属性列在LogTemplateProperties.*下，例如LogTemplateProperties.TraceId。

Log.Information("The time is {TraceId}", "my-trace-id");

将覆盖结果ECS json文档上的trace.id。

与Serilog.Sinks.Elasticsearch比较

• Serilog.Sinks.Elasticsearch是由社区主导的一个令人惊叹的输出，具有大量的选项且适用于旧的Elasticsearch版本< 8.0。
• Serilog.Sinks.Elasticsearch由Elastic非正式支持，其中.NET团队也帮助维护。
• Elastic.Serilog.Sinks由Elastic官方支持，并特意构建以符合关于日志记录、数据流和ILM的最新最佳实践。
• Elastic.Serilog.Sinks特意构建为具有比Serilog.Sinks.Elasticsearch更少的配置选项，并更具体。
  • 这并不意味着Elastic.Serilog.Sinks中没有许多配置钩子

值得注意的是功能缺失

• Elastic.Serilog.Sinks仅与Elasticsearch 8.x和更高版本一起工作。
  • 这是因为引导进程（BootstrapMethod）试图加载为Elasticsearch 8.0和更高版本构建的模板。
• Elastic.Serilog.Sinks以符合ecs-logging规范的一种方式向Elasticsearch发射数据。
  • 这并不意味着你不能引入自己的额外属性。
• Elastic.Serilog.Sinks没有持久模式。
  • 如果您需要更高级别的日志投递保证，请使用与我们ECS日志格式化器兼容的Serilog.Sinks.File，并使用filebeat将这些日志发送出去。
  • 查看Elastic Agent & Fleet，以简化边缘上的日志和指标收集。

如果在Elastic.Serilog.Sinks中发现Serilog.Sinks.Elasticsearch中缺乏的特定功能，请打开功能请求！我们渴望在未来自然地扩展此数据输出。