如何将Serilog接入Amazon OpenSearch？ElasticSearch Sink对接失效怎么处理

可用性说明 #

Amazon OpenSearch 1.x/2.x版本兼容Elasticsearch 7.10版本的API，使用Elasticsearch Sink或者专门适配的OpenSearch Sink都可以正常接入。

第一步：解决无错误返回的问题 #

FailureCallback返回异常为null，本质是Sink内部的报错没有暴露到业务回调层，先开启Serilog内置的SelfLog捕获内部错误：
在创建Logger配置前添加代码：

// 输出Serilog Sink内部的所有错误到控制台
Serilog.Debugging.SelfLog.Enable(msg => Console.WriteLine($"Serilog内部错误: {msg}"));

运行后即可拿到具体的报错原因，90%以上的情况是版本不兼容或者配置参数错误。

第二步：修正Elasticsearch Sink的兼容配置 #

如果使用Serilog.Sinks.Elasticsearch包对接，需要做以下适配修改：

• 版本选择：不要使用基于Elasticsearch 8.x客户端的高版本Sink，建议使用v8.4.1及以下版本，对应兼容Elasticsearch 7.x API
• 配置添加兼容参数：
  • 关闭API版本头，避免OpenSearch识别失败
  • 清空TypeName配置，Elasticsearch 7.x之后已经移除_type字段，OpenSearch也不识别该字段
  • 配置正确的身份验证（如果OpenSearch开启了访问控制）
  • 若使用HTTPS访问，按需配置证书校验逻辑

修正后的代码示例：

// 先开启SelfLog捕获内部错误
Serilog.Debugging.SelfLog.Enable(msg => Console.WriteLine($"Serilog内部错误: {msg}"));

var log = new LoggerConfiguration()
    .WriteTo.Console()
    .WriteTo.Elasticsearch(new ElasticsearchSinkOptions(new Uri("你的OpenSearch访问地址"))
    {
        AutoRegisterTemplate = true,
        // 适配OpenSearch的核心配置
        TypeName = null,
        EnableApiVersioningHeader = false,
        IndexFormat = "serilog-logs-{0:yyyy.MM.dd}", // 索引名必须全小写，符合OpenSearch命名规范
        // 若开启身份验证，配置账号密码
        ModifyConnectionSettings = conn => 
        {
            conn.BasicAuthentication("你的OpenSearch用户名", "你的OpenSearch密码");
            // 测试环境如果是自签证书可以临时关闭校验，生产环境不建议使用
            // conn.ServerCertificateValidationCallback((_, _, _, _) => true);
            return conn;
        },
        FailureCallback = FailureCallback,
        EmitEventFailure = EmitEventFailureHandling.RaiseCallback | EmitEventFailureHandling.ThrowException
    })
    .CreateLogger();

log.Information("Hello, Serilog!");

Log.CloseAndFlush();

更稳定的替代方案 #

如果不想处理版本兼容问题，可以直接使用适配OpenSearch的专用Sink包Serilog.Sinks.OpenSearch，配置逻辑和Elasticsearch Sink基本一致，不需要额外添加兼容参数，适配性更好。

内容的提问来源于stack exchange，提问作者CrazyTea