summaryrefslogtreecommitdiff
path: root/gitlab/v4/objects/sidekiq.py
diff options
context:
space:
mode:
authorNejc Habjan <hab.nejc@gmail.com>2021-02-07 00:29:59 +0100
committerNejc Habjan <hab.nejc@gmail.com>2021-02-07 16:05:05 +0100
commita5a48ad08577be70c6ca511d3b4803624e5c2043 (patch)
treec1b80daad6dbb6ea3b1a3498d70016ef77abf6b3 /gitlab/v4/objects/sidekiq.py
parent9d6c1882d567116e16484f3e0a1036da4967c537 (diff)
downloadgitlab-a5a48ad08577be70c6ca511d3b4803624e5c2043.tar.gz
refactor(v4): split objects and managers per API resource
Diffstat (limited to 'gitlab/v4/objects/sidekiq.py')
-rw-r--r--gitlab/v4/objects/sidekiq.py80
1 files changed, 80 insertions, 0 deletions
diff --git a/gitlab/v4/objects/sidekiq.py b/gitlab/v4/objects/sidekiq.py
new file mode 100644
index 0000000..0c0c02c
--- /dev/null
+++ b/gitlab/v4/objects/sidekiq.py
@@ -0,0 +1,80 @@
+from gitlab import cli
+from gitlab import exceptions as exc
+from gitlab.base import * # noqa
+from gitlab.mixins import * # noqa
+
+
+class SidekiqManager(RESTManager):
+ """Manager for the Sidekiq methods.
+
+ This manager doesn't actually manage objects but provides helper fonction
+ for the sidekiq metrics API.
+ """
+
+ @cli.register_custom_action("SidekiqManager")
+ @exc.on_http_error(exc.GitlabGetError)
+ def queue_metrics(self, **kwargs):
+ """Return the registred queues information.
+
+ Args:
+ **kwargs: Extra options to send to the server (e.g. sudo)
+
+ Raises:
+ GitlabAuthenticationError: If authentication is not correct
+ GitlabGetError: If the information couldn't be retrieved
+
+ Returns:
+ dict: Information about the Sidekiq queues
+ """
+ return self.gitlab.http_get("/sidekiq/queue_metrics", **kwargs)
+
+ @cli.register_custom_action("SidekiqManager")
+ @exc.on_http_error(exc.GitlabGetError)
+ def process_metrics(self, **kwargs):
+ """Return the registred sidekiq workers.
+
+ Args:
+ **kwargs: Extra options to send to the server (e.g. sudo)
+
+ Raises:
+ GitlabAuthenticationError: If authentication is not correct
+ GitlabGetError: If the information couldn't be retrieved
+
+ Returns:
+ dict: Information about the register Sidekiq worker
+ """
+ return self.gitlab.http_get("/sidekiq/process_metrics", **kwargs)
+
+ @cli.register_custom_action("SidekiqManager")
+ @exc.on_http_error(exc.GitlabGetError)
+ def job_stats(self, **kwargs):
+ """Return statistics about the jobs performed.
+
+ Args:
+ **kwargs: Extra options to send to the server (e.g. sudo)
+
+ Raises:
+ GitlabAuthenticationError: If authentication is not correct
+ GitlabGetError: If the information couldn't be retrieved
+
+ Returns:
+ dict: Statistics about the Sidekiq jobs performed
+ """
+ return self.gitlab.http_get("/sidekiq/job_stats", **kwargs)
+
+ @cli.register_custom_action("SidekiqManager")
+ @exc.on_http_error(exc.GitlabGetError)
+ def compound_metrics(self, **kwargs):
+ """Return all available metrics and statistics.
+
+ Args:
+ **kwargs: Extra options to send to the server (e.g. sudo)
+
+ Raises:
+ GitlabAuthenticationError: If authentication is not correct
+ GitlabGetError: If the information couldn't be retrieved
+
+ Returns:
+ dict: All available Sidekiq metrics and statistics
+ """
+ return self.gitlab.http_get("/sidekiq/compound_metrics", **kwargs)