Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Boxiang Sun
gitlab-ce
Commits
06e0ef07
Commit
06e0ef07
authored
Jun 14, 2016
by
Patricio Cano
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Added API endpoint for Sidekiq Metrics
parent
c6cc7680
Changes
5
Show whitespace changes
Inline
Side-by-side
Showing
5 changed files
with
284 additions
and
0 deletions
+284
-0
doc/api/README.md
doc/api/README.md
+1
-0
doc/api/sidekiq_metrics.md
doc/api/sidekiq_metrics.md
+152
-0
lib/api/api.rb
lib/api/api.rb
+1
-0
lib/api/sidekiq_metrics.rb
lib/api/sidekiq_metrics.rb
+90
-0
spec/requests/api/sidekiq_metrics_spec.rb
spec/requests/api/sidekiq_metrics_spec.rb
+40
-0
No files found.
doc/api/README.md
View file @
06e0ef07
...
@@ -31,6 +31,7 @@ following locations:
...
@@ -31,6 +31,7 @@ following locations:
-
[
Services
](
services.md
)
-
[
Services
](
services.md
)
-
[
Session
](
session.md
)
-
[
Session
](
session.md
)
-
[
Settings
](
settings.md
)
-
[
Settings
](
settings.md
)
-
[
Sidekiq Metrics
](
sidekiq_metrics.md
)
-
[
System Hooks
](
system_hooks.md
)
-
[
System Hooks
](
system_hooks.md
)
-
[
Tags
](
tags.md
)
-
[
Tags
](
tags.md
)
-
[
Users
](
users.md
)
-
[
Users
](
users.md
)
...
...
doc/api/sidekiq_metrics.md
0 → 100644
View file @
06e0ef07
# 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
}
}
```
lib/api/api.rb
View file @
06e0ef07
...
@@ -59,5 +59,6 @@ module API
...
@@ -59,5 +59,6 @@ module API
mount
::
API
::
Licenses
mount
::
API
::
Licenses
mount
::
API
::
Subscriptions
mount
::
API
::
Subscriptions
mount
::
API
::
Gitignores
mount
::
API
::
Gitignores
mount
::
API
::
SidekiqMetrics
end
end
end
end
lib/api/sidekiq_metrics.rb
0 → 100644
View file @
06e0ef07
require
'sidekiq/api'
module
API
class
SidekiqMetrics
<
Grape
::
API
before
{
authenticated_as_admin!
}
helpers
do
def
queue_metrics
Sidekiq
::
Queue
.
all
.
each_with_object
({})
do
|
queue
,
hash
|
hash
[
queue
.
name
]
=
{
backlog:
queue
.
size
,
latency:
queue
.
latency
.
to_i
}
end
end
def
process_metrics
Sidekiq
::
ProcessSet
.
new
.
map
do
|
process
|
{
hostname:
process
[
'hostname'
],
pid:
process
[
'pid'
],
tag:
process
[
'tag'
],
started_at:
Time
.
at
(
process
[
'started_at'
]),
queues:
process
[
'queues'
],
labels:
process
[
'labels'
],
concurrency:
process
[
'concurrency'
],
busy:
process
[
'busy'
]
}
end
end
def
job_stats
stats
=
Sidekiq
::
Stats
.
new
{
processed:
stats
.
processed
,
failed:
stats
.
failed
,
enqueued:
stats
.
enqueued
}
end
end
# Get Sidekiq Queue metrics
#
# Parameters:
# None
#
# Example:
# GET /sidekiq/queue_metrics
#
get
'sidekiq/queue_metrics'
do
{
queues:
queue_metrics
}
end
# Get Sidekiq Process metrics
#
# Parameters:
# None
#
# Example:
# GET /sidekiq/process_metrics
#
get
'sidekiq/process_metrics'
do
{
processes:
process_metrics
}
end
# Get Sidekiq Job statistics
#
# Parameters:
# None
#
# Example:
# GET /sidekiq/job_stats
#
get
'sidekiq/job_stats'
do
{
jobs:
job_stats
}
end
# Get Sidekiq Compound metrics. Includes all previous metrics
#
# Parameters:
# None
#
# Example:
# GET /sidekiq/compound_metrics
#
get
'sidekiq/compound_metrics'
do
{
queues:
queue_metrics
,
processes:
process_metrics
,
jobs:
job_stats
}
end
end
end
\ No newline at end of file
spec/requests/api/sidekiq_metrics_spec.rb
0 → 100644
View file @
06e0ef07
require
'spec_helper'
describe
API
::
SidekiqMetrics
,
api:
true
do
include
ApiHelpers
let
(
:admin
)
{
create
(
:user
,
:admin
)
}
describe
'GET sidekiq/*'
do
it
'defines the `queue_metrics` endpoint'
do
get
api
(
'/sidekiq/queue_metrics'
,
admin
)
expect
(
response
.
status
).
to
eq
(
200
)
expect
(
json_response
).
to
be_a
Hash
end
it
'defines the `process_metrics` endpoint'
do
get
api
(
'/sidekiq/process_metrics'
,
admin
)
expect
(
response
.
status
).
to
eq
(
200
)
expect
(
json_response
[
'processes'
]).
to
be_an
Array
end
it
'defines the `job_stats` endpoint'
do
get
api
(
'/sidekiq/job_stats'
,
admin
)
expect
(
response
.
status
).
to
eq
(
200
)
expect
(
json_response
).
to
be_a
Hash
end
it
'defines the `compound_metrics` endpoint'
do
get
api
(
'/sidekiq/compound_metrics'
,
admin
)
expect
(
response
.
status
).
to
eq
(
200
)
expect
(
json_response
).
to
be_a
Hash
expect
(
json_response
[
'queues'
]).
to
be_a
Hash
expect
(
json_response
[
'processes'
]).
to
be_an
Array
expect
(
json_response
[
'jobs'
]).
to
be_a
Hash
end
end
end
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment