Sidekiq Metrics API

Note:This endpoint is only available on GitLab 8.9 and above.

This API endpoint allows you to retrieve some information about the current state of Sidekiq, its jobs, queues, and processes.

Get the current Queue Metrics

List information about all the registered queues, their backlog and their latency.

GET /sidekiq/queue_metrics

旋度--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"https://gitlab.example.com/api/v4/sidekiq/queue_metrics

Example response:

{"queues":{"default":{"backlog":0,“延迟”:0}}}

Get the current Process Metrics

List information about all the Sidekiq workers registered to process your queues.

GET /sidekiq/process_metrics

旋度--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"https://gitlab.example.com/api/v4/sidekiq/process_metrics

Example response:

{"processes":[{"hostname":"gitlab.example.com","pid":5649,"tag":"gitlab",“started_at”:"2016-06-14T10:45:07.159-05:00","queues":["post_receive","mailers","archive_repo","system_hook","project_web_hook","gitlab_shell","incoming_email","runner","common","default"],“标签”:[],"concurrency":25,"busy":0}]}

Get the current Job Statistics

List information about the jobs that Sidekiq has performed.

GET /sidekiq/job_stats

旋度--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"https://gitlab.example.com/api/v4/sidekiq/job_stats

Example response:

{"jobs":{"processed":2,“失败”:0,"enqueued":0}}

Get a compound response of all the previously mentioned metrics

List all the currently available information about Sidekiq.

GET /sidekiq/compound_metrics

旋度--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"https://gitlab.example.com/api/v4/sidekiq/compound_metrics

Example response:

{"queues":{"default":{"backlog":0,“延迟”:0}},"processes":[{"hostname":"gitlab.example.com","pid":5649,"tag":"gitlab",“started_at”:"2016-06-14T10:45:07.159-05:00","queues":["post_receive","mailers","archive_repo","system_hook","project_web_hook","gitlab_shell","incoming_email","runner","common","default"],“标签”:[],"concurrency":25,"busy":0}],"jobs":{"processed":2,“失败”:0,"enqueued":0}}