Shoryuken

Shoryuken is a thread-based message processor for AWS SQS. AppSignal instruments Shoryuken automatically when the Shoryuken gem is detected on start. No manual installation is required if Shoryuken is part of a Rails app. If you’re using a standalone Shoryuken app, see our integration guide.

Performance monitoring

Event timeline

Shoryuken jobs appear in the event timeline of your application’s performance actions as perform_job.shoryuken events.

Incident grouping

AppSignal detects job names from the Shoryuken worker class name, suffixed with the perform method name, resulting in something like MyWorker#perform. AppSignal groups jobs by this name for performance incidents and notifications.

Enqueue instrumentation

Enqueuing a Shoryuken job records an enqueue.shoryuken event, titled after the job being enqueued. AppSignal records enqueue events on the active transaction’s event timeline, for example when you enqueue a job from within a web request or from within another job. It only records them when a transaction is active, so enqueuing a job outside of a transaction records nothing. To stop recording enqueue events across all background job integrations, set the enable_job_enqueue_instrumentation config option to false. This does not affect the instrumentation of the jobs themselves.

Batch support

If an app uses a worker with the :batch => true option, that worker processes multiple messages in the same tick. This requires Ruby gem 2.11.3 or higher, which adds support for the batch option.

# my_worker.rb
class MyWorker
  include Shoryuken::Worker

  shoryuken_options :queue => "batched", :batch => true

  def perform(sqs_msg, body)
    # Do stuff
    puts "Performing BatchedWorker job: #{body}"
    sleep 1
  end
end

Example application

We have an example application for a standalone Shoryuken application available in our examples repository on GitHub.

Sequel

Sidekiq

⌘I

AppSignal for Ruby

AppSignal for Elixir

AppSignal for Node.js

AppSignal for Front-end

AppSignal for Python

AppSignal for Go

AppSignal for Java

AppSignal for PHP

OpenTelemetry

Wrap

Collector

Standalone agent

Performance monitoring

Event timeline

Incident grouping

Enqueue instrumentation

Batch support

Example application

​Performance monitoring

​Event timeline

​Incident grouping

​Enqueue instrumentation

​Batch support

​Example application

Performance monitoring

Event timeline

Incident grouping

Enqueue instrumentation

Batch support

Example application