summaryrefslogtreecommitdiff
path: root/doc/api/sidekiq_metrics.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/sidekiq_metrics.md')
-rw-r--r--doc/api/sidekiq_metrics.md152
1 files changed, 0 insertions, 152 deletions
diff --git a/doc/api/sidekiq_metrics.md b/doc/api/sidekiq_metrics.md
deleted file mode 100644
index de627c1a969..00000000000
--- a/doc/api/sidekiq_metrics.md
+++ /dev/null
@@ -1,152 +0,0 @@
-# Sidekiq Metrics
-
->**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, it's 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
-```
-
-```bash
-curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/sidekiq/queue_metrics
-```
-
-Example response:
-
-```json
-{
- "queues": {
- "default": {
- "backlog": 0,
- "latency": 0
- }
- }
-}
-```
-
-## Get the current Process Metrics
-
-List information about all the Sidekiq workers registered to process your queues.
-
-```
-GET /sidekiq/process_metrics
-```
-
-```bash
-curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/sidekiq/process_metrics
-```
-
-Example response:
-
-```json
-{
- "processes": [
- {
- "hostname": "local.host",
- "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"
- ],
- "labels": [],
- "concurrency": 25,
- "busy": 0
- }
- ]
-}
-```
-
-## Get the current Job Statistics
-
-List information about the jobs that Sidekiq has performed.
-
-```
-GET /sidekiq/job_stats
-```
-
-```bash
-curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/sidekiq/job_stats
-```
-
-Example response:
-
-```json
-{
- "jobs": {
- "processed": 2,
- "failed": 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
-```
-
-```bash
-curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/sidekiq/compound_metrics
-```
-
-Example response:
-
-```json
-{
- "queues": {
- "default": {
- "backlog": 0,
- "latency": 0
- }
- },
- "processes": [
- {
- "hostname": "local.host",
- "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"
- ],
- "labels": [],
- "concurrency": 25,
- "busy": 0
- }
- ],
- "jobs": {
- "processed": 2,
- "failed": 0,
- "enqueued": 0
- }
-}
-```
-