Ruby event reference

Every event the Honeybadger Ruby gem sends to Insights when instrumentation is enabled: Rails requests, database queries, view renders, and cache operations; Active Job, Sidekiq, SolidQueue, and Karafka job processing; Net::HTTP requests; Puma, system, and GC stats; and ActiveAgent LLM instrumentation. Each entry lists the event's fields with their types, and links to its raw JSON Schema.

56 events emitted by honeybadger-ruby.

---

Action Controller

exist_fragment?.action_controller

A Rails fragment cache existence check.

Field	Type	Description
event_type	string	Allowed value: exist_fragment?.action_controller.
key	string	Fragment cache key.
duration	number	Duration in milliseconds.
instrumenter_id	string
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "exist_fragment?.action_controller",
  "key": "views/users/123-20260612143000000000/a1b2c3d4e5f6",
  "duration": 0.31,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

expire_fragment.action_controller

A Rails fragment cache expire call.

Field	Type	Description
event_type	string	Allowed value: expire_fragment.action_controller.
key	string	Fragment cache key.
duration	number	Duration in milliseconds.
instrumenter_id	string
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "expire_fragment.action_controller",
  "key": "views/users/123-20260612143000000000/a1b2c3d4e5f6",
  "duration": 0.52,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

halted_callback.action_controller

A before/around filter halted the Rails request processing chain.

Field	Type	Description
event_type	string	Allowed value: halted_callback.action_controller.
filter	string	Name of the filter/callback that halted the chain.
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "halted_callback.action_controller",
  "filter": "require_login",
  "duration": 2.15,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

process_action.action_controller

A Rails controller action finished handling an HTTP request. Includes total duration, database time, view time, route details, and response status.

Field	Type	Description
event_type	string	Allowed value: process_action.action_controller.
controller	string	Controller class name, e.g. "SearchController".
action	string	Action method on the controller, e.g. "index", "destroy".
method	string	HTTP method, e.g. "GET", "POST", "PUT".
path	string	Request path, e.g. "/follows". Often high-cardinality due to ids.
format	string	Response format, e.g. "html", "json".
status	integer	HTTP status code returned to the client.
duration	number	Total wall-clock time the action took, in milliseconds. Includes db_runtime and view_runtime.
db_runtime	number	Milliseconds spent in DB queries during this action.
view_runtime	number	Milliseconds spent rendering views during this action.
request_id	string	Rails request UUID. Also appears on sql.active_record, render_*.action_view, and cache_*.active_support events from the same request.
instrumenter_id	string	Unique identifier for the ActiveSupport::Notifications instrumentation request, assigned by Rails.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "process_action.action_controller",
  "controller": "UsersController",
  "action": "show",
  "method": "GET",
  "path": "/users/123",
  "format": "html",
  "status": 200,
  "duration": 145.2,
  "db_runtime": 38.7,
  "view_runtime": 52.4,
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "hostname": "web-1.example.com",
  "environment": "production"
}

read_fragment.action_controller

A Rails fragment cache read.

Field	Type	Description
event_type	string	Allowed value: read_fragment.action_controller.
key	string	Fragment cache key.
duration	number	Duration in milliseconds.
instrumenter_id	string
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "read_fragment.action_controller",
  "key": "views/users/123-20260612143000000000/a1b2c3d4e5f6",
  "duration": 0.45,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

redirect_to.action_controller

A Rails controller issued a redirect.

Field	Type	Description
event_type	string	Allowed value: redirect_to.action_controller.
status	integer	HTTP redirect status code, e.g. 301, 302.
location	string	URL the client is redirected to.
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "redirect_to.action_controller",
  "status": 302,
  "location": "https://app.example.com/users/123",
  "duration": 0.85,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

send_file.action_controller

A Rails controller started sending a file.

Field	Type	Description
event_type	string	Allowed value: send_file.action_controller.
path	string	Filesystem path of the file being sent.
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "send_file.action_controller",
  "path": "/app/storage/exports/report-2026-06.pdf",
  "duration": 3.42,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

unpermitted_parameters.action_controller

Rails strong parameters filtered out unpermitted keys.

Field	Type	Description
event_type	string	Allowed value: unpermitted_parameters.action_controller.
keys	array<string>	Parameter keys that were not permitted.
context	object	Request context at the time of the violation.
context.controller	string
context.action	string
context.request	object
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "unpermitted_parameters.action_controller",
  "keys": [
    "admin",
    "role"
  ],
  "context": {
    "controller": "UsersController",
    "action": "update",
    "request": {
      "method": "PATCH",
      "path": "/users/123"
    }
  },
  "duration": 0.12,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

write_fragment.action_controller

A Rails fragment cache write.

Field	Type	Description
event_type	string	Allowed value: write_fragment.action_controller.
key	string	Fragment cache key.
duration	number	Duration in milliseconds.
instrumenter_id	string
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "write_fragment.action_controller",
  "key": "views/users/123-20260612143000000000/a1b2c3d4e5f6",
  "duration": 0.62,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

Action Mailer

process.action_mailer

Rails generated an Action Mailer message.

Field	Type	Description
event_type	string	Allowed value: process.action_mailer.
mailer	string	Mailer class name, e.g. "UserMailer".
action	string	Mailer action method, e.g. "welcome_email".
message_id	string	Message-ID header of the generated email.
subject	string	Email subject line.
to	array<string>	Recipient addresses.
cc	array<string>	CC addresses.
bcc	array<string>	BCC addresses.
date	string	Email date header as a string.
attachments	array<object>	File attachments included in the email.
attachments.filename	string
params	object	Params passed to the mailer action.
params.*	any	Additional caller-defined keys.
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "process.action_mailer",
  "mailer": "UserMailer",
  "action": "welcome_email",
  "message_id": "684af2d1c3b4a_1a2b3c4d5e6f@web-1.example.com.mail",
  "subject": "Welcome to Example App",
  "to": [
    "user@example.com"
  ],
  "cc": [
    "support@example.com"
  ],
  "bcc": [
    "audit@example.com"
  ],
  "date": "Fri, 12 Jun 2026 14:30:00 +0000",
  "attachments": [
    {
      "filename": "welcome-guide.pdf"
    }
  ],
  "params": {
    "user_id": 123
  },
  "duration": 84.21,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

Action View

render_collection.action_view

A Rails view render. This shape is shared by template, partial, and collection render events. A typical request has one template render and several partial renders.

Field	Type	Description
event_type	string	Allowed value: render_collection.action_view.
view	string	Path of the template file, e.g. "[PROJECT_ROOT]/app/views/users/show.html.erb".
layout	string | null	Layout the template was rendered into, e.g. "application". Null when the render skipped layouts.
duration	number	Render duration in milliseconds.
request_id	string	Rails request UUID. Shared by all events from the same HTTP request.
instrumenter_id	string	Unique identifier for the ActiveSupport::Notifications instrumentation request, assigned by Rails.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "render_collection.action_view",
  "view": "[PROJECT_ROOT]/app/views/comments/_comment.html.erb",
  "layout": null,
  "duration": 6.4,
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "hostname": "web-1.example.com",
  "environment": "production"
}

render_partial.action_view

A Rails view render. This shape is shared by template, partial, and collection render events. A typical request has one template render and several partial renders.

Field	Type	Description
event_type	string	Allowed value: render_partial.action_view.
view	string	Path of the template file, e.g. "[PROJECT_ROOT]/app/views/users/show.html.erb".
layout	string | null	Layout the template was rendered into, e.g. "application". Null when the render skipped layouts.
duration	number	Render duration in milliseconds.
request_id	string	Rails request UUID. Shared by all events from the same HTTP request.
instrumenter_id	string	Unique identifier for the ActiveSupport::Notifications instrumentation request, assigned by Rails.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "render_partial.action_view",
  "view": "[PROJECT_ROOT]/app/views/users/_user.html.erb",
  "layout": null,
  "duration": 1.8,
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "hostname": "web-1.example.com",
  "environment": "production"
}

render_template.action_view

A Rails view render. This shape is shared by template, partial, and collection render events. A typical request has one template render and several partial renders.

Field	Type	Description
event_type	string	Allowed value: render_template.action_view.
view	string	Path of the template file, e.g. "[PROJECT_ROOT]/app/views/users/show.html.erb".
layout	string | null	Layout the template was rendered into, e.g. "application". Null when the render skipped layouts.
duration	number	Render duration in milliseconds.
request_id	string	Rails request UUID. Shared by all events from the same HTTP request.
instrumenter_id	string	Unique identifier for the ActiveSupport::Notifications instrumentation request, assigned by Rails.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "render_template.action_view",
  "view": "[PROJECT_ROOT]/app/views/users/show.html.erb",
  "layout": "layouts/application",
  "duration": 24.6,
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "hostname": "web-1.example.com",
  "environment": "production"
}

Active Agent

embed.active_agent

An embedding request made through ActiveAgent.

Field	Type	Description
event_type	string	Allowed value: embed.active_agent.
provider	string	Model provider name.
provider_module	string	ActiveAgent provider module class name.
model	string	Embedding model identifier.
trace_id	string	Trace ID for correlating events within a single agent run.
input_size	integer	Number of input strings submitted for embedding.
embedding_count	integer	Number of embedding vectors returned.
encoding_format	string	Encoding format requested, e.g. "float".
dimensions	integer	Embedding vector dimensions.
response_model	string	Model identifier as returned by the provider.
response_id	string	Provider-assigned response ID.
usage	object	Token usage reported by the provider.
usage.input_tokens	integer
usage.total_tokens	integer
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "embed.active_agent",
  "provider": "OpenAI",
  "provider_module": "OpenAI::Embeddings",
  "model": "text-embedding-3-small",
  "trace_id": "9b4f2a6e-1c8d-4e7a-b3f5-6d2c9e0a4b18",
  "input_size": 3,
  "embedding_count": 3,
  "encoding_format": "float",
  "dimensions": 1536,
  "response_model": "text-embedding-3-small",
  "response_id": "embd-9f8e7d6c5b4a3210fedc",
  "usage": {
    "input_tokens": 42,
    "total_tokens": 42
  },
  "duration": 184.27,
  "instrumenter_id": "d9f4a7b2c1e8d3f6a0b5",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

process.active_agent

An ActiveAgent action ran. Honeybadger forwards the ActiveAgent payload as-is, so extra fields depend on your ActiveAgent version and provider.

Field	Type	Description
event_type	string	Allowed value: process.active_agent.
trace_id	string	Trace ID for correlating events within a single agent run.
provider	string	Model provider name.
duration	number	Duration in milliseconds.
instrumenter_id	string	ActiveSupport::Notifications instrumenter UUID, added by the Honeybadger notification subscriber.
request_id	string	Rails request UUID, present on any event fired during a web request context. Set by the Honeybadger agent when available.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "process.active_agent",
  "trace_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "provider": "openai",
  "duration": 2310.47,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

prompt.active_agent

A model prompt request made through ActiveAgent.

Field	Type	Description
event_type	string	Allowed value: prompt.active_agent.
provider	string	Model provider name, e.g. "openai", "anthropic".
provider_module	string	ActiveAgent provider module class name.
model	string	Model identifier, e.g. "gpt-4o", "claude-3-opus".
trace_id	string	Trace ID for correlating events within a single agent run.
message_count	integer	Number of messages in the prompt context.
stream	boolean	Whether the response was streamed.
finish_reason	string	Stop reason returned by the provider, e.g. "stop", "length".
response_model	string	Model identifier as returned by the provider response.
response_id	string	Provider-assigned response ID.
temperature	number	Sampling temperature used.
max_tokens	integer	Max tokens parameter.
top_p	number	Top-p nucleus sampling parameter.
tool_count	integer	Number of tools available to the model.
has_instructions	boolean	Whether a system instructions block was included.
usage	object	Token usage reported by the provider.
usage.input_tokens	integer
usage.output_tokens	integer
usage.total_tokens	integer
duration	number	Duration in milliseconds.
instrumenter_id	string	ActiveSupport::Notifications instrumenter UUID, added by the Honeybadger notification subscriber.
request_id	string	Rails request UUID, present on any event fired during a web request context. Set by the Honeybadger agent when available.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "prompt.active_agent",
  "provider": "openai",
  "provider_module": "ActiveAgent::GenerationProvider::OpenAIProvider",
  "model": "gpt-4o",
  "trace_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "message_count": 4,
  "stream": false,
  "finish_reason": "stop",
  "response_model": "gpt-4o-2024-08-06",
  "response_id": "chatcmpl-Bx7Qk2T9fJ3aV1mN5pR8sLwY",
  "temperature": 0.7,
  "max_tokens": 1024,
  "top_p": 1,
  "tool_count": 3,
  "has_instructions": true,
  "usage": {
    "input_tokens": 412,
    "output_tokens": 186,
    "total_tokens": 598
  },
  "duration": 1820.43,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

stream_close.active_agent

An ActiveAgent streaming response closed. Honeybadger forwards the ActiveAgent payload as-is, so extra fields depend on your ActiveAgent version and provider.

Field	Type	Description
event_type	string	Allowed value: stream_close.active_agent.
trace_id	string	Trace ID for correlating events within a single agent run.
provider	string	Model provider name.
duration	number	Duration in milliseconds.
instrumenter_id	string	ActiveSupport::Notifications instrumenter UUID, added by the Honeybadger notification subscriber.
request_id	string	Rails request UUID, present on any event fired during a web request context. Set by the Honeybadger agent when available.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "stream_close.active_agent",
  "trace_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "provider": "openai",
  "duration": 1864.92,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

stream_open.active_agent

An ActiveAgent streaming response opened. Honeybadger forwards the ActiveAgent payload as-is, so extra fields depend on your ActiveAgent version and provider.

Field	Type	Description
event_type	string	Allowed value: stream_open.active_agent.
trace_id	string	Trace ID for correlating events within a single agent run.
provider	string	Model provider name.
duration	number	Duration in milliseconds.
instrumenter_id	string	ActiveSupport::Notifications instrumenter UUID, added by the Honeybadger notification subscriber.
request_id	string	Rails request UUID, present on any event fired during a web request context. Set by the Honeybadger agent when available.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "stream_open.active_agent",
  "trace_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "provider": "openai",
  "duration": 412.78,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

tool_call.active_agent

An ActiveAgent tool call ran. Honeybadger forwards the ActiveAgent payload as-is, so extra fields depend on your ActiveAgent version and provider.

Field	Type	Description
event_type	string	Allowed value: tool_call.active_agent.
trace_id	string	Trace ID for correlating events within a single agent run.
provider	string	Model provider name.
duration	number	Duration in milliseconds.
instrumenter_id	string	ActiveSupport::Notifications instrumenter UUID, added by the Honeybadger notification subscriber.
request_id	string	Rails request UUID, present on any event fired during a web request context. Set by the Honeybadger agent when available.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "tool_call.active_agent",
  "trace_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "provider": "openai",
  "duration": 35.61,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

Active Job

discard.active_job

An Active Job job was discarded.

Field	Type	Description
event_type	string	Allowed value: discard.active_job.
job_class	string	ActiveJob class name.
job_id	string	Unique job identifier.
queue_name	string	Queue the job is on.
adapter_class	string	ActiveJob adapter class, e.g. "SidekiqAdapter".
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails ActiveSupport::Notifications instrumenter UUID.
request_id	string	Rails request UUID from the active web request context, if any. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "discard.active_job",
  "job_class": "WelcomeEmailJob",
  "job_id": "c6e1f6b2-8d4a-4f0e-9b7c-1a2d3e4f5a6b",
  "queue_name": "default",
  "adapter_class": "ActiveJob::QueueAdapters::SidekiqAdapter",
  "duration": 0.34,
  "instrumenter_id": "a3c8e1f5b7d2c4e9f0a6",
  "request_id": "3d9c2f81-6e5a-4f7b-9c0d-8a1b2c3d4e5f",
  "hostname": "worker-1.example.com",
  "environment": "production"
}

enqueue_all.active_job

A batch of Active Job jobs was enqueued.

Field	Type	Description
event_type	string	Allowed value: enqueue_all.active_job.
adapter_class	string	ActiveJob adapter class.
jobs	array<object>	Jobs included in the batch.
jobs.job_class	string
jobs.job_id	string
jobs.queue_name	string
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails ActiveSupport::Notifications instrumenter UUID.
request_id	string	Rails request UUID from the active web request context, if any. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "enqueue_all.active_job",
  "adapter_class": "ActiveJob::QueueAdapters::SidekiqAdapter",
  "jobs": [
    {
      "job_class": "WelcomeEmailJob",
      "job_id": "c6e1f6b2-8d4a-4f0e-9b7c-1a2d3e4f5a6b",
      "queue_name": "default"
    },
    {
      "job_class": "SyncCrmContactJob",
      "job_id": "8a2b4c6d-0e1f-4a3b-8c5d-7e9f1a2b3c4d",
      "queue_name": "default"
    }
  ],
  "duration": 3.86,
  "instrumenter_id": "d9f4a7b2c1e8d3f6a0b5",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

enqueue_at.active_job

An Active Job job was scheduled to run later.

Field	Type	Description
event_type	string	Allowed value: enqueue_at.active_job.
job_class	string	ActiveJob class name.
job_id	string	Unique job identifier.
queue_name	string	Queue the job is on.
adapter_class	string	ActiveJob adapter class, e.g. "SidekiqAdapter".
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails ActiveSupport::Notifications instrumenter UUID.
request_id	string	Rails request UUID from the active web request context, if any. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "enqueue_at.active_job",
  "job_class": "WeeklyDigestJob",
  "job_id": "5f7e9d1c-3b2a-4c8e-a6f0-9d8c7b6a5e4f",
  "queue_name": "low",
  "adapter_class": "ActiveJob::QueueAdapters::SidekiqAdapter",
  "duration": 2.11,
  "instrumenter_id": "d9f4a7b2c1e8d3f6a0b5",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

enqueue_retry.active_job

An Active Job job was queued for retry.

Field	Type	Description
event_type	string	Allowed value: enqueue_retry.active_job.
job_class	string	ActiveJob class name.
job_id	string	Unique job identifier.
queue_name	string	Queue the job is on.
adapter_class	string	ActiveJob adapter class, e.g. "SidekiqAdapter".
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails ActiveSupport::Notifications instrumenter UUID.
request_id	string	Rails request UUID from the active web request context, if any. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "enqueue_retry.active_job",
  "job_class": "WelcomeEmailJob",
  "job_id": "c6e1f6b2-8d4a-4f0e-9b7c-1a2d3e4f5a6b",
  "queue_name": "default",
  "adapter_class": "ActiveJob::QueueAdapters::SidekiqAdapter",
  "duration": 1.27,
  "instrumenter_id": "a3c8e1f5b7d2c4e9f0a6",
  "request_id": "3d9c2f81-6e5a-4f7b-9c0d-8a1b2c3d4e5f",
  "hostname": "worker-1.example.com",
  "environment": "production"
}

enqueue.active_job

An Active Job job was enqueued.

Field	Type	Description
event_type	string	Allowed value: enqueue.active_job.
job_class	string	ActiveJob class name.
job_id	string	Unique job identifier.
queue_name	string	Queue the job is on.
adapter_class	string	ActiveJob adapter class, e.g. "SidekiqAdapter".
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails ActiveSupport::Notifications instrumenter UUID.
request_id	string	Rails request UUID from the active web request context, if any. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "enqueue.active_job",
  "job_class": "WelcomeEmailJob",
  "job_id": "c6e1f6b2-8d4a-4f0e-9b7c-1a2d3e4f5a6b",
  "queue_name": "default",
  "adapter_class": "ActiveJob::QueueAdapters::SidekiqAdapter",
  "duration": 1.94,
  "instrumenter_id": "d9f4a7b2c1e8d3f6a0b5",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

perform.active_job

An Active Job job ran, whether it succeeded or raised an exception.

Field	Type	Description
event_type	string	Allowed value: perform.active_job.
job_class	string	ActiveJob class name.
job_id	string	Unique job identifier.
queue_name	string	Queue the job ran on.
adapter_class	string	ActiveJob adapter class, e.g. "SidekiqAdapter".
status	string	Job execution outcome: 'success' if completed without exception, 'failure' if an exception was raised. Allowed values: success, failure.
exception_object	string	The exception instance if the job raised, absent on success. Serialized as a string in JSON format.
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails ActiveSupport::Notifications instrumenter UUID.
request_id	string	Rails request UUID from the active web request context, if any. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "perform.active_job",
  "job_class": "WelcomeEmailJob",
  "job_id": "b1d2e3f4-5a6b-4c7d-8e9f-0a1b2c3d4e5f",
  "queue_name": "default",
  "adapter_class": "ActiveJob::QueueAdapters::SidekiqAdapter",
  "status": "success",
  "duration": 532.18,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "worker-1.example.com",
  "environment": "production"
}

retry_stopped.active_job

An Active Job job stopped retrying after too many failed attempts.

Field	Type	Description
event_type	string	Allowed value: retry_stopped.active_job.
job_class	string	ActiveJob class name.
job_id	string	Unique job identifier.
queue_name	string	Queue the job is on.
adapter_class	string	ActiveJob adapter class, e.g. "SidekiqAdapter".
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails ActiveSupport::Notifications instrumenter UUID.
request_id	string	Rails request UUID from the active web request context, if any. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "retry_stopped.active_job",
  "job_class": "SyncInventoryJob",
  "job_id": "c2e3f4a5-6b7c-4d8e-9f0a-1b2c3d4e5f6a",
  "queue_name": "default",
  "adapter_class": "ActiveJob::QueueAdapters::SidekiqAdapter",
  "duration": 1.05,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "worker-1.example.com",
  "environment": "production"
}

Active Record

sql.active_record

A SQL query from Rails Active Record. Use request_id to group queries from the same HTTP request.

Field	Type	Description
event_type	string	Allowed value: sql.active_record.
query	string	The SQL text with bind parameters obfuscated.
duration	number	Wall-clock time the query took, in milliseconds.
cached	boolean	Whether the query result was served from the ActiveRecord query cache.
async	boolean	Whether the query was executed asynchronously.
request_id	string	Rails request UUID. Shared by all events from the same HTTP request.
instrumenter_id	string	Unique identifier for the ActiveSupport::Notifications instrumentation request, assigned by Rails.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "sql.active_record",
  "query": "SELECT \"users\".* FROM \"users\" WHERE \"users\".\"id\" = ? LIMIT ?",
  "duration": 2.34,
  "cached": false,
  "async": false,
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "hostname": "web-1.example.com",
  "environment": "production"
}

Active Storage

service_download.active_storage

A Rails Active Storage download.

Field	Type	Description
event_type	string	Allowed value: service_download.active_storage.
key	string	Storage key (blob identifier).
service	string	Storage service name, e.g. "disk", "s3".
checksum	string	Content checksum.
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "service_download.active_storage",
  "key": "xtapjjcjiudrlk3tdwirsnz4dawl",
  "service": "S3",
  "checksum": "9X2k1mFqLpZ3vR8sT4wYuA==",
  "duration": 45.3,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

service_upload.active_storage

A Rails Active Storage upload.

Field	Type	Description
event_type	string	Allowed value: service_upload.active_storage.
key	string	Storage key (blob identifier).
service	string	Storage service name, e.g. "disk", "s3".
checksum	string	Content checksum.
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "service_upload.active_storage",
  "key": "xtapjjcjiudrlk3tdwirsnz4dawl",
  "service": "S3",
  "checksum": "9X2k1mFqLpZ3vR8sT4wYuA==",
  "duration": 182.64,
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

Active Support

cache_cleanup.active_support

A Rails cache cleanup.

Field	Type	Description
event_type	string	Allowed value: cache_cleanup.active_support.
key	string	Cache key.
store	string	Cache store class name.
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "cache_cleanup.active_support",
  "key": "262144",
  "store": "ActiveSupport::Cache::MemoryStore",
  "duration": 4.87,
  "instrumenter_id": "d9f4a7b2c1e8d3f6a0b5",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

cache_decrement.active_support

A Rails cache decrement.

Field	Type	Description
event_type	string	Allowed value: cache_decrement.active_support.
key	string	Cache key.
store	string	Cache store class name.
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "cache_decrement.active_support",
  "key": "counters/available_slots",
  "store": "ActiveSupport::Cache::RedisCacheStore",
  "duration": 0.31,
  "instrumenter_id": "d9f4a7b2c1e8d3f6a0b5",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

cache_delete_multi.active_support

A Rails multi-key cache delete.

Field	Type	Description
event_type	string	Allowed value: cache_delete_multi.active_support.
key	array<string>	Cache keys deleted.
store	string	Cache store class name.
duration	number	Duration in milliseconds.
instrumenter_id	string
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "cache_delete_multi.active_support",
  "key": [
    "views/users/123",
    "views/users/124"
  ],
  "store": "ActiveSupport::Cache::RedisCacheStore",
  "duration": 0.74,
  "instrumenter_id": "d9f4a7b2c1e8d3f6a0b5",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

cache_delete.active_support

A Rails cache delete.

Field	Type	Description
event_type	string	Allowed value: cache_delete.active_support.
key	string	Cache key.
store	string	Cache store class name.
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "cache_delete.active_support",
  "key": "users/123",
  "store": "ActiveSupport::Cache::RedisCacheStore",
  "duration": 0.38,
  "instrumenter_id": "d9f4a7b2c1e8d3f6a0b5",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

cache_exist?.active_support

A Rails cache existence check.

Field	Type	Description
event_type	string	Allowed value: cache_exist?.active_support.
key	string	Cache key.
store	string	Cache store class name.
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "cache_exist?.active_support",
  "key": "users/123",
  "store": "ActiveSupport::Cache::RedisCacheStore",
  "duration": 0.21,
  "instrumenter_id": "d9f4a7b2c1e8d3f6a0b5",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

cache_fetch_hit.active_support

A Rails cache fetch hit.

Field	Type	Description
event_type	string	Allowed value: cache_fetch_hit.active_support.
key	string	Cache key.
store	string	Cache store class name.
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "cache_fetch_hit.active_support",
  "key": "users/123",
  "store": "ActiveSupport::Cache::RedisCacheStore",
  "duration": 0.05,
  "instrumenter_id": "d9f4a7b2c1e8d3f6a0b5",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

cache_generate.active_support

A Rails cache generate call.

Field	Type	Description
event_type	string	Allowed value: cache_generate.active_support.
key	string	Cache key.
store	string	Cache store class name.
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "cache_generate.active_support",
  "key": "users/123",
  "store": "ActiveSupport::Cache::RedisCacheStore",
  "duration": 12.84,
  "instrumenter_id": "d9f4a7b2c1e8d3f6a0b5",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

cache_increment.active_support

A Rails cache increment.

Field	Type	Description
event_type	string	Allowed value: cache_increment.active_support.
key	string	Cache key.
store	string	Cache store class name.
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "cache_increment.active_support",
  "key": "counters/page_views",
  "store": "ActiveSupport::Cache::RedisCacheStore",
  "duration": 0.33,
  "instrumenter_id": "d9f4a7b2c1e8d3f6a0b5",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

cache_prune.active_support

A Rails cache prune call.

Field	Type	Description
event_type	string	Allowed value: cache_prune.active_support.
key	string	Cache key.
store	string	Cache store class name.
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "cache_prune.active_support",
  "key": "262144",
  "store": "ActiveSupport::Cache::MemoryStore",
  "duration": 3.52,
  "instrumenter_id": "d9f4a7b2c1e8d3f6a0b5",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

cache_read_multi.active_support

A Rails multi-key cache read.

Field	Type	Description
event_type	string	Allowed value: cache_read_multi.active_support.
key	array<string>	Cache keys read.
hits	array<string>	Keys that were cache hits.
store	string	Cache store class name.
duration	number	Duration in milliseconds.
instrumenter_id	string
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "cache_read_multi.active_support",
  "key": [
    "views/users/123",
    "views/users/124"
  ],
  "hits": [
    "views/users/123"
  ],
  "store": "ActiveSupport::Cache::RedisCacheStore",
  "duration": 0.88,
  "instrumenter_id": "d9f4a7b2c1e8d3f6a0b5",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

cache_read.active_support

A Rails cache read.

Field	Type	Description
event_type	string	Allowed value: cache_read.active_support.
key	string	Cache key.
store	string	Cache store class name.
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "cache_read.active_support",
  "key": "users/123",
  "store": "ActiveSupport::Cache::RedisCacheStore",
  "duration": 0.42,
  "instrumenter_id": "d9f4a7b2c1e8d3f6a0b5",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

cache_write_multi.active_support

A Rails multi-key cache write.

Field	Type	Description
event_type	string	Allowed value: cache_write_multi.active_support.
key	array<string>	Cache keys written.
store	string	Cache store class name.
duration	number	Duration in milliseconds.
instrumenter_id	string
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "cache_write_multi.active_support",
  "key": [
    "views/users/123",
    "views/users/124"
  ],
  "store": "ActiveSupport::Cache::RedisCacheStore",
  "duration": 1.12,
  "instrumenter_id": "d9f4a7b2c1e8d3f6a0b5",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

cache_write.active_support

A Rails cache write.

Field	Type	Description
event_type	string	Allowed value: cache_write.active_support.
key	string	Cache key.
store	string	Cache store class name.
duration	number	Duration in milliseconds.
instrumenter_id	string	Rails instrumenter UUID.
request_id	string	Rails request UUID, present on any event fired during a web request context. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "cache_write.active_support",
  "key": "users/123",
  "store": "ActiveSupport::Cache::RedisCacheStore",
  "duration": 0.61,
  "instrumenter_id": "d9f4a7b2c1e8d3f6a0b5",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

Autotuner

report.autotuner

A tuning recommendation from the Autotuner gem.

Field	Type	Description
event_type	string	Allowed value: report.autotuner.
report	string	Human-readable tuning recommendation text.
request_id	string	Rails request UUID, present on any event fired during a web request context. Set by the Honeybadger agent when available.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "report.autotuner",
  "report": "The following suggestions reduce the number of major GC collections during requests.\nSuggested tuning values:\n  RUBY_GC_HEAP_OLDOBJECT_LIMIT_FACTOR=1.2 (default: 2.0)",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

stats.autotuner

Periodic Ruby process memory and object metrics from Autotuner. Field names depend on the Autotuner version and enabled checks.

Field	Type	Description
event_type	string	Allowed value: stats.autotuner.
request_id	string	Rails request UUID, present on any event fired during a web request context. Set by the Honeybadger agent when available.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "stats.autotuner",
  "request_time": 145.2,
  "gc_time": 12.4,
  "minor_gc_count": 3,
  "major_gc_count": 0,
  "heap_pages": 5460,
  "hostname": "web-1.example.com",
  "environment": "production"
}

Flipper

feature_operation.flipper

A Flipper feature flag check or mutation recorded by Honeybadger.

Field	Type	Description
event_type	string	Allowed value: feature_operation.flipper.
feature_name	string	Name of the Flipper feature flag.
operation	string	Operation performed, e.g. "enabled?", "enable", "disable".
result	any	Result of the operation. Checks return booleans, while mutations can return other values.
request_id	string	Rails request UUID, present on any event fired during a web request context. Set by the Honeybadger agent when available.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).
instrumenter_id	string	ActiveSupport::Notifications instrumenter UUID, added by the Honeybadger notification subscriber.
duration	number	Duration of the instrumented operation in milliseconds.

Example

{
  "event_type": "feature_operation.flipper",
  "feature_name": "new_dashboard",
  "operation": "enabled?",
  "result": true,
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production",
  "instrumenter_id": "d6a5b3f4c2e1908a7b6c",
  "duration": 0.42
}

Karafka

consumer.consumed.karafka

A Karafka consumer processed a batch of Kafka messages.

Field	Type	Description
event_type	string	Allowed value: consumer.consumed.karafka.
topic	string	Kafka topic consumed from.
partition	integer	Kafka partition consumed from.
consumer_group	string	Consumer group identifier.
consumer	string	Consumer class name.
processed	integer	Number of messages processed in this batch.
duration	number	Processing duration in milliseconds.
processing_lag	integer	Latency between when the first message in the batch was produced and when processing began, in milliseconds.
consumption_lag	integer	Latency between the last committed offset and the newest available offset, in milliseconds.
request_id	string	Rails request UUID from the active web request context, if any. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "consumer.consumed.karafka",
  "topic": "orders",
  "partition": 0,
  "consumer_group": "orders_consumers",
  "consumer": "OrdersConsumer",
  "processed": 25,
  "duration": 845.3,
  "processing_lag": 213,
  "consumption_lag": 1378,
  "request_id": "3d9c2f81-6e5a-4f7b-9c0d-8a1b2c3d4e5f",
  "hostname": "worker-1.example.com",
  "environment": "production"
}

error.occurred.karafka

A Karafka consumer or the Karafka framework raised an error.

Field	Type	Description
event_type	string	Allowed value: error.occurred.karafka.
type	string	Error source identifier, e.g., 'consumer.consume.error' or 'connection.error'.
error	string	Exception message and class name.
topic	string	Kafka topic where the error occurred, if applicable.
partition	integer	Kafka partition where the error occurred, if applicable.
consumer_group	string	Consumer group where the error occurred, if applicable.
request_id	string	Rails request UUID from the active web request context, if any. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "error.occurred.karafka",
  "type": "consumer.consume.error",
  "error": "JSON::ParserError: unexpected token at 'invalid'",
  "topic": "orders",
  "partition": 0,
  "consumer_group": "orders_consumers",
  "request_id": "3d9c2f81-6e5a-4f7b-9c0d-8a1b2c3d4e5f",
  "hostname": "worker-1.example.com",
  "environment": "production"
}

statistics_emitted.karafka

Kafka broker and consumer statistics from librdkafka.

Field	Type	Description
event_type	string	Allowed value: statistics_emitted.karafka.
consumer_group_id	string	Karafka consumer group identifier.
statistics	object	Raw librdkafka statistics payload. The shape is defined by librdkafka. See https://github.com/confluentinc/librdkafka/blob/master/STATISTICS.md
statistics.*	any	Additional caller-defined keys.
request_id	string	Rails request UUID from the active web request context, if any. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "statistics_emitted.karafka",
  "consumer_group_id": "example_app_group",
  "statistics": {
    "client_id": "example_app",
    "type": "consumer",
    "rxmsgs": 12840
  },
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "worker-1.example.com",
  "environment": "production"
}

Metrics

metric.hb

A metric recorded through Honeybadger's instrumentation API and flushed by the metrics registry. The metric_type field tells you whether the event came from gauge, increment_counter, decrement_counter, histogram, or time.

Field	Type	Description
event_type	string	Allowed value: metric.hb.
metric_name	string	Name of the metric as passed to the recording call.
metric_type	string	The metric type. Timers are gauges recorded via Honeybadger.time. Allowed values: gauge, counter, histogram, timer.
samples	integer	Number of observations recorded in this flush window.
interval	integer	Length of the aggregation/flush window in seconds (insights.registry_flush_interval, default 60).
total	number	Sum of all recorded values in the window (gauge, timer, and histogram metrics).
min	number	Minimum recorded value in the window (gauge, timer, and histogram metrics).
max	number	Maximum recorded value in the window (gauge, timer, and histogram metrics).
avg	number	Average of recorded values in the window (gauge, timer, and histogram metrics).
latest	number	Most recently recorded value in the window (gauge, timer, and histogram metrics).
counter	number	Accumulated counter value for the window (counter metrics).
bins	array<array<number>>	Histogram bin counts as [upper_bound, count] pairs. The final bin's upper bound is 1e20, which represents infinity.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).
metric_source	string	Source plugin or component that recorded the metric, e.g. "rails", "sidekiq", "solid_queue", "net_http", "puma", "autotuner".

Example

{
  "event_type": "metric.hb",
  "metric_name": "duration.process_action.action_controller",
  "metric_type": "gauge",
  "metric_source": "rails",
  "samples": 20,
  "interval": 60,
  "total": 1820.5,
  "min": 12.3,
  "max": 210.4,
  "avg": 91.03,
  "latest": 88.6,
  "hostname": "web-1.example.com",
  "environment": "production"
}

Net::HTTP

request.net_http

An outbound HTTP request made with Ruby's Net::HTTP.

Field	Type	Description
event_type	string	Allowed value: request.net_http.
method	string	HTTP method, e.g. "GET", "POST".
host	string	Destination host.
url	string	Full request URL. Only present when the net_http.insights.full_url config option is enabled.
status	integer	HTTP response status code.
duration	number	Round-trip duration in milliseconds.
request_id	string	Rails request UUID, present on any event fired during a web request context. Set by the Honeybadger agent when available.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "request.net_http",
  "method": "GET",
  "host": "api.example.com",
  "url": "https://api.example.com/v2/items/42",
  "status": 200,
  "duration": 89.4,
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

Puma

stats.puma

A periodic Puma stats snapshot. Cluster mode records one event per worker. Single mode records one event per cycle. Fields come directly from Puma.stats.

Field	Type	Description
event_type	string	Allowed value: stats.puma.
worker	integer	Worker index in cluster mode. Absent in single mode.
pool_capacity	integer	Number of threads available to pick up new requests.
max_threads	integer	Maximum number of threads configured for this worker.
requests_count	integer	Total requests processed by this worker since start.
backlog	integer	Number of connections waiting for a thread.
running	integer	Number of threads currently running.
request_id	string	Rails request UUID, present on any event fired during a web request context. Set by the Honeybadger agent when available.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "stats.puma",
  "worker": 0,
  "pool_capacity": 3,
  "max_threads": 5,
  "requests_count": 18342,
  "backlog": 0,
  "running": 5,
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

Sidekiq

enqueue.sidekiq

A job was enqueued to a Sidekiq queue.

Field	Type	Description
event_type	string	Allowed value: enqueue.sidekiq.
jid	string	Sidekiq job ID.
worker	string	Worker class name.
queue	string	Queue the job was pushed to.
request_id	string	Rails request UUID from the active web request context, if any. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "enqueue.sidekiq",
  "jid": "f8a1c2d3e4b5a6c7d8e9f0a1",
  "worker": "WelcomeEmailJob",
  "queue": "default",
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}

perform.sidekiq

A Sidekiq job ran.

Field	Type	Description
event_type	string	Allowed value: perform.sidekiq.
jid	string	Sidekiq job ID.
worker	string	Worker class name.
queue	string	Queue the job ran on.
status	string	Job execution outcome: 'success' if completed without exception, 'failure' if an exception was raised.
duration	number	Execution duration in milliseconds.
request_id	string	Rails request UUID from the active web request context, if any. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "perform.sidekiq",
  "jid": "8f0c1d2e3a4b5c6d7e8f9a0b",
  "worker": "WelcomeEmailWorker",
  "queue": "default",
  "status": "success",
  "duration": 487.32,
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "worker-1.example.com",
  "environment": "production"
}

stats.sidekiq

Sidekiq cluster statistics from the Honeybadger agent.

Field	Type	Description
event_type	string	Allowed value: stats.sidekiq.
processed	integer	Total jobs processed (lifetime counter).
failed	integer	Total jobs failed (lifetime counter).
scheduled_size	integer	Jobs in the scheduled set.
retry_size	integer	Jobs in the retry set.
dead_size	integer	Jobs in the dead set.
processes_size	integer	Number of running Sidekiq processes.
default_queue_latency	number	Latency of the default queue in seconds as returned by Sidekiq::Stats.
capacity	integer	Total worker thread capacity across all processes.
utilization	number	Worker utilization ratio (0.0–1.0).
queues	object	Per-queue stats keyed by queue name.
queues.*	any	Additional caller-defined keys.
request_id	string	Rails request UUID from the active web request context, if any. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "stats.sidekiq",
  "processed": 1284512,
  "failed": 1432,
  "scheduled_size": 87,
  "retry_size": 12,
  "dead_size": 3,
  "processes_size": 2,
  "default_queue_latency": 0.42,
  "capacity": 20,
  "utilization": 0.35,
  "queues": {
    "default": {
      "latency": 420,
      "depth": 6,
      "busy": 5
    },
    "mailers": {
      "latency": 0,
      "depth": 0,
      "busy": 2
    }
  },
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "worker-1.example.com",
  "environment": "production"
}

Solid Queue

stats.solid_queue

Solid Queue cluster statistics from the Honeybadger agent.

Field	Type	Description
event_type	string	Allowed value: stats.solid_queue.
jobs_in_progress	integer	Jobs currently being executed.
jobs_blocked	integer	Jobs blocked waiting on a concurrency limit.
jobs_failed	integer	Jobs in the failed state.
jobs_scheduled	integer	Jobs scheduled for future execution.
jobs_processed	integer	Total jobs processed (lifetime counter).
active_workers	integer	Number of active worker processes.
active_dispatchers	integer	Number of active dispatcher processes.
queues	object	Per-queue depth keyed by queue name.
queues.*	any	Additional caller-defined keys.
request_id	string	Rails request UUID from the active web request context, if any. Merged globally by the Honeybadger agent.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "stats.solid_queue",
  "jobs_in_progress": 4,
  "jobs_blocked": 2,
  "jobs_failed": 7,
  "jobs_scheduled": 156,
  "jobs_processed": 184329,
  "active_workers": 2,
  "active_dispatchers": 1,
  "queues": {
    "default": {
      "depth": 23
    },
    "mailers": {
      "depth": 2
    }
  },
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "worker-1.example.com",
  "environment": "production"
}

System

report.system

A periodic memory and load average snapshot from the Honeybadger system plugin.

Field	Type	Description
event_type	string	Allowed value: report.system.
mem	object	Memory statistics in megabytes.
mem.total	number	Total system memory.
mem.free	number	Free memory.
mem.buffers	number	Memory used for buffers.
mem.cached	number	Memory used for cache.
mem.free_total	number	Total available memory (free + buffers + cached).
load	object	System load averages.
load.one	number	1-minute load average.
load.five	number	5-minute load average.
load.fifteen	number	15-minute load average.
request_id	string	Rails request UUID, present on any event fired during a web request context. Set by the Honeybadger agent when available.
hostname	string	Server hostname. Attached to every event by default (events.attach_hostname).
environment	string	Application environment, e.g. "production". Attached to every event by default (events.attach_environment).

Example

{
  "event_type": "report.system",
  "mem": {
    "total": 16384,
    "free": 2048.5,
    "buffers": 512.25,
    "cached": 6144.75,
    "free_total": 8705.5
  },
  "load": {
    "one": 0.42,
    "five": 0.38,
    "fifteen": 0.35
  },
  "request_id": "0f5e4bb2-3c46-4b1c-91d5-2f4e8a6b9c01",
  "hostname": "web-1.example.com",
  "environment": "production"
}