RailsSemanticLogging

Opinionated Rails semantic logger configuration with Datadog support. Provides a consistent, structured JSON logging setup for Rails applications, with hooks for Sidekiq, ActiveJob, and Datadog-friendly formatters.

Features

Datadog formatter with Standard Attributes mapping
Default payload enrichment for controllers (host, user_agent, referer) mapped to http.*
JSON formatter for structured logging without Datadog-specific fields
ActiveJob integration with named tags (job_class, job_id, queue, executions, and provider_job_id when the adapter assigns one) instead of array tags
Sidekiq integration with job context in all log lines
Configurable via anyway_config (YAML, env vars, or code)
Environment-aware defaults (Datadog JSON in production, color in development, fatal in test)
RSpec matcher for asserting log output in tests

Installation

Add to your application's Gemfile:

gem 'rails_semantic_logging'

Then run bundle install.

Usage

Basic Configuration

The gem auto-configures via a Railtie when loaded by Rails. Out of the box:

Datadog JSON formatter in production, color formatter elsewhere
request_id and client_ip log tags
Default payload enrichment (host, user_agent, referer) on all controller actions
Quiet assets logging
Sync mode in test environment
Log level: INFO (production), DEBUG (development), FATAL (test)
LOG_LEVEL env var override supported

Custom Configuration

# config/application.rb (inside class body)
RailsSemanticLogging.configure do |config|
  config.application_name = 'My App'
  config.environment_name = ENV.fetch('NAMESPACE', Rails.env)

  # Add custom log tags (merged with default request_id + client_ip)
  config.custom_log_tags = {
    user: ->(request) { extract_user_id(request) },
    tenant: ->(request) { request.headers['X-Tenant-ID'] }
  }

  # Override formatters (default: :datadog for production, :color for development)
  # config.production_formatter = :json     # plain JSON without Datadog mapping
  # config.production_formatter = :datadog  # Datadog Standard Attributes (default)
  # config.development_formatter = :color   # colorized console output (default)

  # Disable automatic payload enrichment on controllers (default: true)
  # config.default_payload = false
end

Configuration can also be set via YAML (config/rails_semantic_logging.yml) or environment variables (RAILS_SEMANTIC_LOGGING_QUIET_ASSETS=false) thanks to anyway_config.

Formatter override via YAML

# config/rails_semantic_logging.yml
production:
  production_formatter: json

development:
  development_formatter: color

Formatter override via environment variables

RAILS_SEMANTIC_LOGGING_PRODUCTION_FORMATTER=datadog bin/rails server
RAILS_SEMANTIC_LOGGING_DEVELOPMENT_FORMATTER=color bin/rails server

Both string and symbol values are accepted for formatter options (e.g. "datadog" from YAML/ENV is equivalent to :datadog in Ruby).

Configuration Options

Option	Default	Description
`application_name`	Rails app name	SemanticLogger application name
`environment_name`	`Rails.env`	SemanticLogger environment name
`custom_log_tags`	`{}`	Extra log tags (merged with `request_id` + `client_ip`)
`quiet_assets`	`true`	Silence asset pipeline logs
`sync_in_test`	`true`	Use synchronous logging in test environment
`default_payload`	`true`	Auto-include host, user_agent, referer in controller logs
`production_formatter`	`:datadog`	Formatter for production (`:datadog`, `:json`, or instance)
`development_formatter`	`:color`	Formatter for non-production environments

Datadog Integration

Standard Attributes Mapping

The :datadog formatter maps all log fields to Datadog Standard Attributes so logs are automatically parsed and correlated in Datadog without custom pipelines.

Core log fields

SemanticLogger field	Datadog Standard Attribute	Notes
Logger name	`logger.name`	Class/module that emitted the log
Level	`status`	`debug`, `info`, `warn`, `error`, `fatal`
Duration	`duration`	Converted to nanoseconds
Exception class	`error.kind`	e.g. `RuntimeError`
Exception message	`error.message`	Human-readable description
Backtrace	`error.stack`	Full stack trace as string

HTTP fields (from controller payload)

When default_payload is enabled (default), controller request logs include:

Payload field	Datadog Standard Attribute	Source
`status`	`http.status_code`	Rails built-in
`method`	`http.method`	Rails built-in
`path`	`http.url`	Rails built-in
`host`	`http.url_details.host`	`DefaultPayload` concern
`user_agent`	`http.useragent`	`DefaultPayload` concern
`referer`	`http.referer`	`DefaultPayload` concern

Datadog trace correlation

When Datadog tracing is active, the formatter injects: dd.trace_id, dd.span_id, dd.env, dd.service, dd.version.

Routing error enrichment

rails_semantic_logger logs unmatched routes as a real ActionController::RoutingError. When the formatter sees one, it parses the standard No route matches [GET] "/foo" message and populates http.method, http.url_details.path and http.status_code (the canonical 404) on the log event. The exception message is also used as the top-level message so the log line is never empty. This keeps unmatched-route logs correlated with the original request URL in Datadog without requiring a custom server-side log pipeline. Actual request data (when present in the payload) always wins over the message-derived fields.

Example: Complete request log (production)

{
  "timestamp": "2025-10-26T10:30:45.123Z",
  "status": "info",
  "host": "web-01",
  "logger.name": "Rails",
  "message": "Completed 200 OK in 42ms",
  "duration": 42500000,
  "http.status_code": 200,
  "http.method": "GET",
  "http.url": "/api/v1/bikes",
  "http.url_details.host": "api.example.com",
  "http.useragent": "Mozilla/5.0 (iPhone; iOS 17.0)",
  "http.referer": "https://app.example.com/dashboard",
  "dd.trace_id": "1234567890",
  "dd.span_id": "9876543210"
}

Example: Background job log

{
  "timestamp": "2025-10-26T10:31:00.456Z",
  "status": "info",
  "host": "worker-01",
  "logger.name": "Rails",
  "message": "Performing ImportBikesJob from Sidekiq(default)",
  "named_tags": {
    "job_class": "ImportBikesJob",
    "job_id": "abc-123",
    "queue": "default",
    "executions": 0,
    "provider_job_id": "9632"
  }
}

executions is the ActiveJob attempt counter (0 on the first run), so retries are visible directly in the logs. provider_job_id is the queue backend's native identifier — the solid_queue_jobs row id under Solid Queue, the jid under Sidekiq — which lets a log line be correlated with the job in Mission Control and the backend's own tables. It is only present once the job has been enqueued, so synchronous (perform_now / :inline / :test) executions omit it.

Example: Error log

{
  "timestamp": "2025-10-26T10:32:15.789Z",
  "status": "error",
  "host": "web-01",
  "logger.name": "BikeService",
  "message": "Failed to import bike",
  "error.kind": "ActiveRecord::RecordInvalid",
  "error.message": "Validation failed: VIN is not unique",
  "error.stack": "app/services/bike_service.rb:42:in `import'\n..."
}

Formatters

JSON Formatter `:json`

Plain structured JSON without Datadog-specific field mapping. Useful for non-Datadog log pipelines.

{
  "timestamp": "2025-10-26T10:30:45.123Z",
  "level": "info",
  "host": "server-1",
  "name": "Rails",
  "message": "Processing request",
  "duration_ms": 42.5
}

Color Formatter `:color` (development default)

Uses the built-in SemanticLogger::Formatters::Color for human-readable development output.

RSpec Matchers

Include the matchers module in your spec config:

require 'rails_semantic_logging/rspec/matchers'

RSpec.configure do |config|
  config.include RailsSemanticLogging::RSpec::Matchers
end

Two matchers are provided. They cover complementary use cases.

`log_semantic` — declarative "was X logged?" assertion

Returns a boolean: true if any captured log line matches all the supplied criteria. Use it when the question is "did this happen?".

expect { logger.info("hello") }.to log_semantic(level: :info, message: /hello/)
expect { logger.warn("oops", key: "val") }.to log_semantic(payload: { key: "val" })
expect { do_work }.to log_semantic(named_tags: { job_class: 'MyJob' })

`have_logged_message` — find a specific log and assert on it

Finds the first log event whose message matches the expected pattern, then hands the raw SemanticLogger::Log (and, optionally, a formatted version) over to a user block so you can make arbitrary assertions on it.

The expected message can be a String, a Regexp, or any object with === (so RSpec built-in matchers like a_string_starting_with("...") work too). An optional second argument constrains the level.

expect { service.call }.to have_logged_message("Imported")
expect { service.call }.to have_logged_message(/import/, :warn)

expect { service.call }
  .to have_logged_message("Imported").with_formatted_event { |event, formatted|
    expect(event.payload).to include(items: 3)
    expect(event.named_tags).to include(tenant: 'eu')
    expect(formatted.dig('http', 'status_code')).to eq(200)
  }

with_formatted_event defaults to the gem's Datadog formatter; pass any SemanticLogger::Formatters::Base subclass to use a different one:

.with_formatted_event(SemanticLogger::Formatters::Json) { |event, formatted| ... }

formatted is the formatter's JSON output, re-parsed with indifferent access — so both formatted[:status] and formatted['status'] work.

The matcher passes a duplicated copy of the log event to the formatter, so a formatter that mutates log.payload / log.named_tags cannot leak those mutations into the event you receive in the block.

Puma Integration

When using Puma in clustered mode, reopen log appenders after forking:

# config/puma.rb
if workers_number.positive?
  preload_app!

  before_worker_boot do
    SemanticLogger.reopen
  end
end

Development

git clone https://github.com/fabn/rails_semantic_logging.git
cd rails_semantic_logging
bundle install
bundle exec rspec
bundle exec rubocop

License

The gem is available as open source under the terms of the MIT License.