如何在Rails应用中获取DataDog trace_id并写入日志？

嘿，这个需求我在好几个Rails项目里都落地过，其实操作起来挺清晰的，咱们一步步来搞定：

首先，正确获取DataDog的Trace ID #

你提到的DataDog.trace_id这种写法其实不对，得从DataDog的追踪上下文里拿。最可靠的方式是用**Datadog::Tracing.correlation.trace_id** —— 这个方法专门用来获取当前请求/任务关联的trace ID，就算没有活跃的追踪链路（比如某些后台任务没被Datadog监控），它也会返回nil或者0，不会抛错。

如果你的ddtrace版本比较旧（比如v1.x之前），可能需要用Datadog.tracer.active_correlation.trace_id，不过建议尽量升级到最新稳定版，用前者的写法更规范。

把Trace ID写入Rails日志的三种常用方式 #

方式1：用Rails内置的日志标签（最简单）

直接在你的Rails配置文件里（比如config/application.rb或者对应环境的config/environments/*.rb）添加日志标签：

config.log_tags = [
  ->(request) { "trace_id:#{Datadog::Tracing.correlation.trace_id || 'none'}" },
  :remote_ip, # 保留你原本的日志标签
  :request_id
]

这样Rails的每条请求日志都会自动带上trace_id:xxx的标签，比如日志输出会变成：

[trace_id:1234567890abcdef] [127.0.0.1] [abc123] Started GET "/" for 127.0.0.1 at 2024-05-20 10:30:00 +0800

方式2：自定义日志格式化器（更灵活）

如果需要更定制化的日志格式，可以写一个自定义的日志格式化器：

1. 创建格式化器文件app/lib/datadog_log_formatter.rb：

class DatadogLogFormatter < ::Logger::Formatter
  def call(severity, timestamp, progname, msg)
    trace_id = Datadog::Tracing.correlation.trace_id || 'none'
    # 按照你想要的格式拼接内容，这里只是示例
    formatted_msg = "[#{timestamp.iso8601}] [#{severity}] [trace_id:#{trace_id}] #{msg}\n"
    formatted_msg
  end
end

2. 在config/application.rb里配置使用这个格式化器：

config.logger = ActiveSupport::Logger.new(STDOUT)
config.logger.formatter = DatadogLogFormatter.new

这种方式可以完全自定义日志的结构，适合对日志格式有严格要求的场景。

方式3：用中间件包裹请求（适合统一处理请求周期）

如果想在整个请求周期内都把trace ID绑定到日志上，可以写一个中间件：

1. 创建中间件文件app/middlewares/datadog_trace_id_middleware.rb：

class DatadogTraceIdMiddleware
  def initialize(app)
    @app = app
  end

  def call(env)
    trace_id = Datadog::Tracing.correlation.trace_id || 'none'
    # 用Rails的tagged日志功能包裹整个请求
    Rails.logger.tagged("trace_id:#{trace_id}") do
      @app.call(env)
    end
  end
end

2. 在config/application.rb里注册中间件：

config.middleware.use DatadogTraceIdMiddleware

这样每个请求的所有日志都会被自动打上trace ID的标签，非常省心。

注意事项 #

• 确保你的ddtrace gem已经正确安装并初始化，在config/initializers/datadog.rb里要开启分布式追踪：

  Datadog.configure do |c|
    c.tracing.enabled = true
    c.tracing.instrument :rails
  end
  

• 如果是后台任务（比如Sidekiq），想要把trace ID写入任务日志，同样可以用Datadog::Tracing.correlation.trace_id，只要任务被Datadog的Sidekiq instrumentation监控，就能拿到对应的trace ID。

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