---
title: "Logs"
description: "Structured logs allow you to send, view and query logs sent from your applications within Sentry."
url: https://docs.sentry.io/platforms/ruby/logs/
---

# Set Up Logs | Sentry for Ruby

With Sentry Structured Logs, you can send text-based log information from your applications to Sentry. Once in Sentry, these logs can be viewed alongside relevant errors, searched by text-string, or searched using their individual attributes.

## [Requirements](https://docs.sentry.io/platforms/ruby/logs.md#requirements)

Logs for Ruby are supported in Sentry Ruby SDK version `5.24.0` and above.

```bash
gem install sentry-ruby
```

Or add it to your Gemfile:

```ruby
gem "sentry-ruby"
```

## [Setup](https://docs.sentry.io/platforms/ruby/logs.md#setup)

To enable logging, you need to initialize the SDK with the `enable_logs` option set to `true`.

```ruby
Sentry.init do |config|
  config.dsn = "___PUBLIC_DSN___"
  config.enable_logs = true
end
```

## [Usage](https://docs.sentry.io/platforms/ruby/logs.md#usage)

Once the feature is enabled on the SDK and the SDK is initialized, you can send logs using the `Sentry.logger` APIs.

The `logger` namespace exposes six methods that you can use to log messages at different log levels: `trace`, `debug`, `info`, `warn`, `error`, and `fatal`.

You can pass additional attributes directly to the logging functions. These properties will be sent to Sentry, and can be searched from within the Logs UI, and even added to the Logs views as a dedicated column.

```ruby
Sentry.logger.info("Updated global cache")

Sentry.logger.debug("Cache miss for user %{user_id}", user_id: 123)

Sentry.logger.trace(
  "Starting database connection %{database}",
  database: "users"
)

Sentry.logger.warn(
  "Rate limit reached for endpoint %{endpoint}",
  endpoint: "/api/results/"
)

Sentry.logger.error(
  "Failed to process payment. Order: %{order_id}. Amount: %{amount}",
  order_id: "or_2342", amount: 99.99
)

Sentry.logger.fatal(
  "Database %{database} connection pool exhausted",
  database: "users"
)
```

You can also use message templates with positional or hash parameters:

```ruby
# Using named parameters
Sentry.logger.info("User %{name} logged in", name: "Jane Doe")

# Using positional parameters
Sentry.logger.info("User %s logged in", ["Jane Doe"])
```

Any other arbitrary attributes will be sent as part of the log event payload:

```ruby
# Here `user_id` and `action` will be sent as extra attributes that
# Sentry Logs UI displays
Sentry.logger.info(
  "User %{user} logged in",
  user: "Jane", user_id: 123, action: "create"
)
```

## [Options](https://docs.sentry.io/platforms/ruby/logs.md#options)

### [before\_send\_log](https://docs.sentry.io/platforms/ruby/logs.md#before_send_log)

To filter logs before they are sent to Sentry, use the `before_send_log` callback. Return `nil` to skip a log, or return the log object to send it.

```ruby
Sentry.init do |config|
  config.dsn = "___PUBLIC_DSN___"
  config.enable_logs = true

  config.before_send_log = lambda do |log|
    # Skip info logs
    return if log.level == :info

    log
  end
end
```

### [std\_lib\_logger\_filter](https://docs.sentry.io/platforms/ruby/logs.md#std_lib_logger_filter)

When using the `:logger` patch for Ruby's standard library logger, you can filter log messages using `std_lib_logger_filter`. The callback receives the logger instance, message, and severity level. Return `true` to send the log, or `false` to skip it.

```ruby
Sentry.init do |config|
  config.dsn = "___PUBLIC_DSN___"
  config.enable_logs = true
  config.enabled_patches << :logger

  # Only send ERROR and FATAL logs to Sentry
  config.std_lib_logger_filter = proc do |logger, message, severity|
    [:error, :fatal].include?(severity)
  end
end
```

## [Best Practices](https://docs.sentry.io/platforms/ruby/logs.md#best-practices)

### [Wide Events Over Scattered Logs](https://docs.sentry.io/platforms/ruby/logs.md#wide-events-over-scattered-logs)

Instead of many thin logs that are hard to correlate, emit one comprehensive log per operation with all relevant context.

This makes debugging dramatically faster — one query returns everything about a specific order, user, or request.

```ruby
# ❌ Scattered thin logs
Sentry.logger.info("Starting checkout")
Sentry.logger.info("Validating cart")
Sentry.logger.info("Processing payment")
Sentry.logger.info("Checkout complete")

# ✅ One wide event with full context
Sentry.logger.info("Checkout completed",
  order_id: order.id,
  user_id: user.id,
  user_tier: user.subscription,
  cart_value: cart.total,
  item_count: cart.items.count,
  payment_method: "stripe",
  duration_ms: ((Time.now - start_time) * 1000).to_i
)
```

### [Include Business Context](https://docs.sentry.io/platforms/ruby/logs.md#include-business-context)

Add attributes that help you prioritize and debug:

* **User context** — tier, account age, lifetime value
* **Transaction data** — order value, item count
* **Feature state** — active feature flags
* **Request metadata** — endpoint, method, duration

This lets you filter logs by high-value customers or specific features.

```ruby
Sentry.logger.info("API request completed",
  # User context
  user_id: user.id,
  user_tier: user.plan, # "free" | "pro" | "enterprise"
  account_age_days: user.age_days,

  # Request data
  endpoint: "/api/orders",
  method: "POST",
  duration_ms: 234,

  # Business context
  order_value: 149.99,
  feature_flags: ["new-checkout", "discount-v2"]
)
```

### [Consistent Attribute Naming](https://docs.sentry.io/platforms/ruby/logs.md#consistent-attribute-naming)

Pick a naming convention and stick with it across your codebase. Inconsistent names make queries impossible.

**Recommended:** Use `snake_case` for custom attributes to match Ruby conventions.

```ruby
# ❌ Inconsistent naming
{ user: "123" }
{ userId: "123" }
{ user_id: "123" }
{ UserID: "123" }

# ✅ Consistent snake_case
{
  user_id: "123",
  order_id: "456",
  cart_value: 99.99,
  item_count: 3
}
```

## [Default Attributes](https://docs.sentry.io/platforms/ruby/logs.md#default-attributes)

The Ruby SDK automatically sets several default attributes on all log entries to provide context and improve debugging:

### [Core Attributes](https://docs.sentry.io/platforms/ruby/logs.md#core-attributes)

* `environment`: The environment set in the SDK if defined. This is sent from the SDK as `sentry.environment`.
* `release`: The release set in the SDK if defined. This is sent from the SDK as `sentry.release`.
* `sdk.name`: The name of the SDK that sent the log. This is sent from the SDK as `sentry.sdk.name`.
* `sdk.version`: The version of the SDK that sent the log. This is sent from the SDK as `sentry.sdk.version`.

### [Message Template Attributes](https://docs.sentry.io/platforms/ruby/logs.md#message-template-attributes)

If the log was parameterized, Sentry adds the message template and parameters as log attributes.

* `message.template`: The parameterized template string. This is sent from the SDK as `sentry.message.template`.
* `message.parameter.X`: The parameters to fill the template string. X can either be the number that represent the parameter's position in the template string (`sentry.message.parameter.0`, `sentry.message.parameter.1`, etc) or the parameter's name (`sentry.message.parameter.item_id`, `sentry.message.parameter.user_id`, etc). This is sent from the SDK as `sentry.message.parameter.X`.

### [Server Attributes](https://docs.sentry.io/platforms/ruby/logs.md#server-attributes)

* `server.address`: The address of the server that sent the log. Equivalent to `server_name` that gets attached to Sentry errors.

### [User Attributes](https://docs.sentry.io/platforms/ruby/logs.md#user-attributes)

If user information is available in the current scope, the following attributes are added to the log:

* `user.id`: The user ID.
* `user.name`: The username.
* `user.email`: The email address.

### [Integration Attributes](https://docs.sentry.io/platforms/ruby/logs.md#integration-attributes)

If a log is generated by an SDK integration, the SDK will set additional attributes to help you identify the source of the log.

* `origin`: The origin of the log. This is sent from the SDK as `sentry.origin`.

## [Other Logging Integrations](https://docs.sentry.io/platforms/ruby/logs.md#other-logging-integrations)

Available integrations:

* [Standard library logging](https://docs.sentry.io/platforms/ruby/integrations/logging.md)