summaryrefslogtreecommitdiff
path: root/gitlab/v4/objects/sidekiq.py
diff options
context:
space:
mode:
Diffstat (limited to 'gitlab/v4/objects/sidekiq.py')
-rw-r--r--gitlab/v4/objects/sidekiq.py83
1 files changed, 0 insertions, 83 deletions
diff --git a/gitlab/v4/objects/sidekiq.py b/gitlab/v4/objects/sidekiq.py
deleted file mode 100644
index dc1094a..0000000
--- a/gitlab/v4/objects/sidekiq.py
+++ /dev/null
@@ -1,83 +0,0 @@
-from gitlab import cli
-from gitlab import exceptions as exc
-from gitlab.base import RESTManager
-
-__all__ = [
- "SidekiqManager",
-]
-
-
-class SidekiqManager(RESTManager):
- """Manager for the Sidekiq methods.
-
- This manager doesn't actually manage objects but provides helper function
- for the sidekiq metrics API.
- """
-
- @cli.register_custom_action("SidekiqManager")
- @exc.on_http_error(exc.GitlabGetError)
- def queue_metrics(self, **kwargs):
- """Return the registered 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 registered 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)