Datadog instrumentation for Sidekiq, integrated via server middleware.
Configure it in an initializer:
Sidekiq.configure_client do |config|
config.client_middleware do |chain|
chain.add Sidekiq::Middleware::Client::Datadog
end
end
Sidekiq.configure_server do |config|
config.client_middleware do |chain|
chain.add Sidekiq::Middleware::Client::Datadog
end
config.server_middleware do |chain|
chain.add Sidekiq::Middleware::Server::Datadog
end
end
Options can be configured to be passed to the middleware constructor when it is added to the chain
Sidekiq.configure_server do |config|
config.server_middleware do |chain|
chain.add(Sidekiq::Middleware::Server::Datadog, statsd_port: 3334)
end
endCustom tags can be configured using the tags: property
Sidekiq.configure_server do |config|
config.server_middleware do |chain|
chain.add(Sidekiq::Middleware::Server::Datadog, tags: ['runtime:jruby'])
end
endDynamic tags can be configured by passing a lambda in the tags array. It is executed at runtime when the job is processed
Sidekiq.configure_server do |config|
config.server_middleware do |chain|
chain.add(Sidekiq::Middleware::Server::Datadog, tags: [->(worker_or_worker_class, job, queue, error){
"source:#{job['source']}"
}])
end
end
# NOTE: Your lambda will either receive a `Worker` object for the Server middleware,
# or a String with the `worker_class` for the Client middleware.
# If you are using that argument, your lambda should be able to handle both cases.You can supress some of the default tags from being emitted by passing in skip_tags.
This is also useful if you would like to change one of the default tags, you can define
a custom lambda and define it as skip_tags
Sidekiq.configure_server do |config|
config.server_middleware do |chain|
chain.add(Sidekiq::Middleware::Server::Datadog,
skip_tags: ["name"],
tags: [->(worker_or_worker_class, job, queue, error){
"name:#{ my_logic_for_name }"
}])
end
endBoth Client and Server middlewares support the same options:
- hostname - the hostname used for instrumentation, defaults to system hostname. Can also be set with the
INSTRUMENTATION_HOSTNAMEenv var. - metric_name - the metric name (prefix) to use, defaults to "sidekiq.job".
- tags - array of custom tags. These can be plain strings or lambda blocks.
- skip_tags - array of tag names that shouldn't be emitted.
- statsd_host - the statsD host, defaults to "localhost". Can also be set with the
STATSD_HOSTenv var - statsd_port - the statsD port, defaults to 8125. Can also be set with the
STATSD_PORTenv var - statsd - custom statsd instance
For more detailed configuration options, please see the original documentation.
The client middleware will expose:
sidekiq.job_enqueuedcounter, with tags:host,env,name(the job name) andqueue
The server middleware will expose:
sidekiq.jobcounter, with tags:host,env,name(the job name),queue, andstatus(okorerror). Ifstatusiserror, there will be an additionalerrortag with the exception class.sidekiq.job.timetiming (ms) metric with the same tags, specifying the job runtime.sidekiq.job.queued_timetiming (ms) metric with the same tags, specifying how long the job was waiting in the queue before starting.
The base metric names sidekiq.job and sidekiq.job_enqueued can be overriden using the
metric_name option.