summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/api-objects.rst1
-rw-r--r--docs/gl_objects/sidekiq.rst16
2 files changed, 17 insertions, 0 deletions
diff --git a/docs/api-objects.rst b/docs/api-objects.rst
index 31f9da9..4050a51 100644
--- a/docs/api-objects.rst
+++ b/docs/api-objects.rst
@@ -23,3 +23,4 @@ API objects manipulation
gl_objects/system_hooks
gl_objects/todos
gl_objects/users
+ gl_objects/sidekiq
diff --git a/docs/gl_objects/sidekiq.rst b/docs/gl_objects/sidekiq.rst
new file mode 100644
index 0000000..a75a02d
--- /dev/null
+++ b/docs/gl_objects/sidekiq.rst
@@ -0,0 +1,16 @@
+###############
+Sidekiq metrics
+###############
+
+Use the :attr:`gitlab.Gitlab.sideqik` manager object to access Gitlab Sidekiq
+server metrics.
+
+Examples
+--------
+
+.. code-block:: python
+
+ gl.sidekiq.queue_metrics()
+ gl.sidekiq.process_metrics()
+ gl.sidekiq.job_stats()
+ gl.sidekiq.compound_metrics()