What is the best way to add manual instrumentation for Shoryuken jobs?

[murshed-panorama]

For one of our Rails applications, we use Shoryuken to process messages from an SQS queue.

Using a Shoryuken Middleware, we created a Middleware just for OpenTelemetry in our application so that it can capture information about the job that is being processed. Is this the recommended way to do that?

We're not aware of any production-ready OpenTelemetry Instrumentation gems specifically for Shoryuken, so that is why we're going this route with a middleware.

# In the initializer
OTelTracer = OpenTelemetry.tracer_provider.tracer("MY_APP_TRACER")

require "opentelemetry/sdk"

class OpenTelemetryMiddleware
  def call(worker_instance, queue, sqs_msg, body)
    s = OTelTracer.start_span("shoryuken")
    OpenTelemetry::Trace.with_span(s) do |span, context|
      span.set_attribute("my_company.queue_name", queue)

      # Yield to the next middleware in the stack
      yield
    end
  ensure
    s&.finish
  end
end

# Shoryuken Initializer

Shoryuken.configure_server do |config|
  # Other Shoryuken initialization code
  
  config.server_middleware do |chain|
    chain.add OpenTelemetryMiddleware
  end
end

We're using Rails 6.1.7 and Shoryuken 6.2.1