Class: Sentry::Rails::LogSubscribers::ActionControllerSubscriber

Inherits:
Sentry::Rails::LogSubscriber show all
Includes:
ParameterFilter
Defined in:
lib/sentry/rails/log_subscribers/action_controller_subscriber.rb

Overview

LogSubscriber for ActionController events that captures HTTP request processing and logs them using Sentry’s structured logging system.

This subscriber captures process_action.action_controller events and formats them with relevant request information including controller, action, HTTP status, request parameters, and performance metrics.

Examples:

Usage

# Enable structured logging for ActionController
Sentry.init do |config|
  config.enable_logs = true
  config.rails.structured_logging = true
  config.rails.structured_logging.subscribers = { action_controller: Sentry::Rails::LogSubscribers::ActionControllerSubscriber }
end

Constant Summary

Constants included from ParameterFilter

ParameterFilter::EMPTY_HASH

Instance Method Summary collapse

Methods included from ParameterFilter

backend, #filter_sensitive_params

Methods inherited from Sentry::Rails::LogSubscriber

#detach_from

Instance Method Details

#process_action(event) ⇒ Object

Handle process_action.action_controller events

Parameters:

  • event (ActiveSupport::Notifications::Event) —

    The controller action event



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/sentry/rails/log_subscribers/action_controller_subscriber.rb', line 29

def process_action(event)
  payload = event.payload

  controller = payload[:controller]
  action = payload[:action]

  status = extract_status(payload)

  attributes = {
    controller: controller,
    action: action,
    duration_ms: duration_ms(event),
    method: payload[:method],
    path: payload[:path],
    format: payload[:format]
  }

  attributes[:status] = status if status

  if payload[:view_runtime]
    attributes[:view_runtime_ms] = payload[:view_runtime].round(2)
  end

  if payload[:db_runtime]
    attributes[:db_runtime_ms] = payload[:db_runtime].round(2)
  end

  if Sentry.configuration.send_default_pii && payload[:params]
    filtered_params = filter_sensitive_params(payload[:params])
    attributes[:params] = filtered_params unless filtered_params.empty?
  end

  level = level_for_request(payload)
  message = "#{controller}##{action}"

  log_structured_event(
    message: message,
    level: level,
    attributes: attributes
  )
end