Инструментарий Active Support

Active Support — часть ядра Rails, которая предоставляет расширение языка Ruby, утилиты и другие возможности. Она включает инструментарий API, который может использоваться внутри приложения, для отслеживания определенных действий, которые возникают как в коде Ruby, так и внутри приложения Rails и самого фреймворка. Однако, она не ограничена Rails. При необходимости ее можно независимо использовать в других скриптах Ruby если вы желаете.

В этом руководстве вы научитесь использовать инструменты Active Support API для отслеживания событий внутри Rails или другого Ruby-кода.

После прочтения данного руководства вы будете знать:

• Какой инструментарий предоставляется.
• Как добавить подписчика к хуку.
• Какие есть хуки внутри фреймворка Rails для инструментария.
• Как создать произвольную реализацию инструментария.

1. Введение в инструментарий

Инструментарий API, предоставленный Active Support, позволяет разработчикам создавать хуки, которыми могут пользоваться другие разработчики. Некоторые из них присутствуют в фреймворке Rails, как показано ниже. С этим API, разработчики могут быть оповещены при возникновении определенного события в их приложении или другом коде Ruby.

Например, есть хук внутри Active Record который вызывается каждый раз когда Active Record использует запрос SQL к базе данных. На этот хук можно подписаться и использовать его для отслеживания количества запросов в течении определенного экшна. Есть другой хук, оборачивающий экшны контроллеров. Он может быть использован, например, для отслеживания, как долго выполнялся определенный экшн.

Вы даже можете создать свои собственные события внутри приложения, на которые вы потом сможете подписаться.

2. Подписка на события

Подписаться на событие просто. Используйте ActiveSupport::Notifications.subscribe с блоком, чтобы слушать любое уведомление.

Блок получает следующие аргументы:

• Имя события
• Время начала
• Время окончания
• Уникальный ID для инструментария, запустившего это событие
• Полезная нагрузка (описывается в следующих разделах)

ActiveSupport::Notifications.subscribe "process_action.action_controller" do |name, started, finished, unique_id, data|
  # ваш собственный код
  Rails.logger.info "#{name} Received! (started: #{started}, finished: #{finished})" # process_action.action_controller Received (started: 2019-05-05 13:43:57 -0800, finished: 2019-05-05 13:43:58 -0800)
end

Если вы беспокоитесь об аккуратности started и finished для вычисления точного прошедшего времени, используйте ActiveSupport::Notifications.monotonic_subscribe. Преданный блок получает те же аргументы, что и предыдущий, но started и finished получит значения более аккуратного монотонного времени вместо секундного дискретного времени.

ActiveSupport::Notifications.monotonic_subscribe "process_action.action_controller" do |name, started, finished, unique_id, data|
  # ваш собственный код
  Rails.logger.info "#{name} Received! (started: #{started}, finished: #{finished})" # process_action.action_controller Received (started: 1560978.425334, finished: 1560979.429234)
end

Определение всех этих аргументов блока каждый раз может быть утомительно. Можно легко создать ActiveSupport::Notifications::Event из блока аргументов, например:

ActiveSupport::Notifications.subscribe "process_action.action_controller" do |*args|
  event = ActiveSupport::Notifications::Event.new *args

  event.name      # => "process_action.action_controller"
  event.duration  # => 10 (in milliseconds)
  event.payload   # => {:extra=>information}

  Rails.logger.info "#{event} Received!"
end

В основном вас будет интересовать сама информация. Ниже приведен краткий вариант, как можно получить информацию.

ActiveSupport::Notifications.subscribe "process_action.action_controller" do |*args|
  data = args.extract_options!
  data # { extra: :information }
end

Вы можете также подписаться на события, соответствующие регулярному выражению. Это позволит вам подписаться на несколько событий за раз. Вот как можно подписаться на все события ActionController.

ActiveSupport::Notifications.subscribe /action_controller/ do |*args|
  # Проверка всех событий ActionController
end

3. Хуки фреймворка Rails

Внутри фреймворка Ruby on Rails присутствует множество хуков для обычных событий. Они описываются ниже.

3.1. Action Controller

3.1.1. write_fragment.action_controller

{
  key: 'posts/1-dashboard-view'
}

3.1.2. read_fragment.action_controller

{
  key: 'posts/1-dashboard-view'
}

3.1.3. expire_fragment.action_controller

{
  key: 'posts/1-dashboard-view'
}

3.1.4. exist_fragment?.action_controller

{
  key: 'posts/1-dashboard-view'
}

3.1.5. start_processing.action_controller

{
  controller: "PostsController",
  action: "new",
  params: { "action" => "new", "controller" => "posts" },
  headers: #<ActionDispatch::Http::Headers:0x0055a67a519b88>,
  format: :html,
  method: "GET",
  path: "/posts/new"
}

3.1.6. process_action.action_controller

{
  controller: "PostsController",
  action: "index",
  params: {"action" => "index", "controller" => "posts"},
  headers: #<ActionDispatch::Http::Headers:0x0055a67a519b88>,
  format: :html,
  method: "GET",
  path: "/posts",
  request: #<ActionDispatch::Request:0x00007ff1cb9bd7b8>,
  response: #<ActionDispatch::Response:0x00007f8521841ec8>,
  status: 200,
  view_runtime: 46.848,
  db_runtime: 0.157
}

3.1.7. send_file.action_controller

3.1.8. send_data.action_controller

ActionController не добавляет какой-либо конкретной информации при загрузке. Все опции передаются через полезную нагрузку (payload).

3.1.9. redirect_to.action_controller

{
  status: 302,
  location: "http://localhost:3000/posts/new",
  request: #<ActionDispatch::Request:0x00007ff1cb9bd7b8>
}

3.1.10. halted_callback.action_controller

{
  filter: ":halting_filter"
}

3.1.11. unpermitted_parameters.action_controller

3.2. Action Dispatch

3.2.1. process_middleware.action_dispatch

3.2.2. redirect.action_dispatch

3.3. Action View

3.3.1. render_template.action_view

{
  identifier: "/Users/adam/projects/notifications/app/views/posts/index.html.erb",
  layout: "layouts/application",
  locals: {foo: "bar"}
}

3.3.2. render_partial.action_view

{
  identifier: "/Users/adam/projects/notifications/app/views/posts/_form.html.erb",
  locals: {foo: "bar"}
}

3.3.3. render_collection.action_view

:cache_hits включается, только если коллекция рендерится с cached: true.

{
  identifier: "/Users/adam/projects/notifications/app/views/posts/_post.html.erb",
  count: 3,
  cache_hits: 0
}

3.3.4. render_layout.action_view

{
  identifier: "/Users/adam/projects/notifications/app/views/layouts/application.html.erb"
}

3.4. Active Record

3.4.1. sql.active_record

{
  sql: "SELECT \"posts\".* FROM \"posts\" ",
  name: "Post Load",
  connection: #<ActiveRecord::ConnectionAdapters::SQLite3Adapter:0x00007f9f7a838850>,
  binds: [#<ActiveModel::Attribute::WithCastValue:0x00007fe19d15dc00>],
  type_casted_binds: [11],
  statement_name: nil
}

3.4.2. instantiation.active_record

{
  record_count: 1,
  class_name: "User"
}

3.5. Action Mailer

3.5.1. deliver.action_mailer

{
  mailer: "Notification",
  message_id: "4f5b5491f1774_181b23fc3d4434d38138e5@mba.local.mail",
  subject: "Rails Guides",
  to: ["users@rails.com", "dhh@rails.com"],
  from: ["me@rails.com"],
  date: Sat, 10 Mar 2012 14:18:09 +0100,
  mail: "...", # опущено для краткости
  perform_deliveries: true
}

3.5.2. process.action_mailer

{
  mailer: "Notification",
  action: "welcome_email",
  args: []
}

3.6. Active Support

3.6.1. cache_read.active_support

3.6.2. cache_generate.active_support

Это событие используется только когда #fetch вызывается с блоком.

{
  key: "name-of-complicated-computation",
  store: "ActiveSupport::Cache::MemCacheStore"
}

3.6.3. cache_fetch_hit.active_support

Это событие используется только когда #fetch вызывается с блоком.

{
  key: "name-of-complicated-computation",
  store: "ActiveSupport::Cache::MemCacheStore"
}

3.6.4. cache_write.active_support

{
  key: "name-of-complicated-computation",
  store: "ActiveSupport::Cache::MemCacheStore"
}

3.6.5. cache_delete.active_support

{
  key: "name-of-complicated-computation",
  store: "ActiveSupport::Cache::MemCacheStore"
}

3.6.6. cache_exist?.active_support

{
  key: "name-of-complicated-computation",
  store: "ActiveSupport::Cache::MemCacheStore"
}

3.7. Active Job

3.7.1. enqueue_at.active_job

3.7.2. enqueue.active_job

3.7.3. enqueue_retry.active_job

3.7.4. perform_start.active_job

3.7.5. perform.active_job

3.7.6. retry_stopped.active_job

3.7.7. discard.active_job

3.8. Action Cable

3.8.1. perform_action.action_cable

3.8.2. transmit.action_cable

3.8.3. transmit_subscription_confirmation.action_cable

3.8.4. transmit_subscription_rejection.action_cable

3.8.5. broadcast.action_cable

3.9. Active Storage

3.9.1. service_upload.active_storage

3.9.2. service_streaming_download.active_storage

3.9.3. service_download.active_storage

3.9.4. service_download_chunk.active_storage

3.9.5. service_delete.active_storage

3.9.6. service_delete_prefixed.active_storage

3.9.7. service_exist.active_storage

3.9.8. service_url.active_storage

3.9.9. service_update_metadata.active_storage

3.9.10. preview.active_storage

3.9.11. transform.active_storage

3.9.12. analyze.active_storage

3.10. Action Mailbox

3.10.1. process.action_mailbox

{
  mailbox: #<RepliesMailbox:0x00007f9f7a8388>,
  inbound_email: {
    id: 1,
    message_id: "0CB459E0-0336-41DA-BC88-E6E28C697DDB@37signals.com",
    status: "processing"
  }
}

3.11. Railties

3.11.1. load_config_initializer.railties

3.12. Rails

3.12.1. deprecation.rails

4. Исключения

Если происходит исключение во время любого инструментария, полезная нагрузка будет включать информацию о нем.

5. Создание пользовательского события

Добавить свои события очень просто. ActiveSupport::Notifications будет делать всю тяжелую работу за вас. Просто вызовите instrument с name, payload и блоком. Уведомление будет отправлено после возвращения блока. ActiveSupport сгенерирует время старта и окончания и добавит уникальный ID инструментария. Все данные переданные в вызов instrument будут выполнены в полезной нагрузке.

Пример:

ActiveSupport::Notifications.instrument "my.custom.event", this: :data do
  # Создание ваших пользовательских настроек тут
end

Теперь можно слушать это событие:

ActiveSupport::Notifications.subscribe "my.custom.event" do |name, started, finished, unique_id, data|
  puts data.inspect # {:this=>:data}
end

Также есть вариант вызова инструментария без передачи блока. Это позволяет использовать инфраструктуру инструментария для других применений (обмен сообщениями).

ActiveSupport::Notifications.instrument "my.custom.event", this: :data

ActiveSupport::Notifications.subscribe "my.custom.event" do |name, started, finished, unique_id, data|
  puts data.inspect # {:this=>:data}
end

Вы должны следовать соглашениям Rails при создании своих событий. Формат: event.library. Если ваше приложение отправляет Tweets, вы должны назвать событие tweet.twitter.