class OpenTracing::Instrumentation::Sidekiq::ClientMiddleware

Sidekiq producer middleware

Constants

DEFAULT_OPERATION_NAME_BUILDER
DEFAULT_OPERATION_NAME_TEMPLATE
DEFAULT_SPAN_KIND

Attributes

error_writter[R]
logger[R]
operation_name_builder[R]
span_kind[R]
tagger[R]
tracer[R]

Public Class Methods

new( tracer: OpenTracing.global_tracer, tagger: JobTagger.new, error_writter: Common::ErrorWriter.new, logger: nil, span_kind: DEFAULT_SPAN_KIND, operation_name_builder: DEFAULT_OPERATION_NAME_BUILDER ) click to toggle source

rubocop:disable Metrics/ParameterLists

# File lib/opentracing/instrumentation/sidekiq/client_middleware.rb, line 27
def initialize(
  tracer: OpenTracing.global_tracer,
  tagger: JobTagger.new,
  error_writter: Common::ErrorWriter.new,
  logger: nil,
  span_kind: DEFAULT_SPAN_KIND,
  operation_name_builder: DEFAULT_OPERATION_NAME_BUILDER
)
  @tracer = tracer
  @tagger = tagger
  @error_writter = error_writter
  @logger = logger
  @span_kind = span_kind
  @operation_name_builder = operation_name_builder
end

Public Instance Methods

call(_worker_class, job, _queue, _redis_pool, &block) click to toggle source

rubocop:enable Metrics/ParameterLists

# File lib/opentracing/instrumentation/sidekiq/client_middleware.rb, line 44
def call(_worker_class, job, _queue, _redis_pool, &block)
  scope = safe_start_scope(job)
  inject(scope.span.context, job)
  log(scope.span, job, &block)
ensure
  safe_close_scope(scope)
end

Private Instance Methods

build_tags(job) click to toggle source
# File lib/opentracing/instrumentation/sidekiq/client_middleware.rb, line 79
def build_tags(job)
  tagger.build_tags(job, span_kind)
end
inject(span_context, carrier) click to toggle source
# File lib/opentracing/instrumentation/sidekiq/client_middleware.rb, line 83
def inject(span_context, carrier)
  tracer.inject(span_context, OpenTracing::FORMAT_TEXT_MAP, carrier)
end
log(span, job) { || ... } click to toggle source
# File lib/opentracing/instrumentation/sidekiq/client_middleware.rb, line 70
def log(span, job)
  tagger.write_args_log(span, job['jid'], job['args'])

  yield
rescue StandardError => e
  error_writter.write_error(span, e)
  raise
end
safe_close_scope(scope) click to toggle source
# File lib/opentracing/instrumentation/sidekiq/client_middleware.rb, line 62
def safe_close_scope(scope)
  return unless scope

  scope.close
rescue StandardError => e
  logger&.error(e)
end
safe_start_scope(job) click to toggle source
# File lib/opentracing/instrumentation/sidekiq/client_middleware.rb, line 54
def safe_start_scope(job)
  tags = build_tags(job)
  operation_name = operation_name_builder.build(tags)
  tracer.start_active_span(operation_name, tags: tags)
rescue StandardError => e
  logger&.error(e)
end