1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
from __future__ import annotations
from typing import Any
import requests
from gitlab import cli
from gitlab import exceptions as exc
from gitlab.base import RESTManager, RESTObject
__all__ = ["SidekiqManager"]
class SidekiqManager(RESTManager[RESTObject]):
"""Manager for the Sidekiq methods.
This manager doesn't actually manage objects but provides helper function
for the sidekiq metrics API.
"""
_path = "/sidekiq"
_obj_cls = RESTObject
@cli.register_custom_action(cls_names="SidekiqManager")
@exc.on_http_error(exc.GitlabGetError)
def queue_metrics(self, **kwargs: Any) -> dict[str, Any] | requests.Response:
"""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:
Information about the Sidekiq queues
"""
return self.gitlab.http_get(f"{self.path}/queue_metrics", **kwargs)
@cli.register_custom_action(cls_names="SidekiqManager")
@exc.on_http_error(exc.GitlabGetError)
def process_metrics(self, **kwargs: Any) -> dict[str, Any] | requests.Response:
"""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:
Information about the register Sidekiq worker
"""
return self.gitlab.http_get(f"{self.path}/process_metrics", **kwargs)
@cli.register_custom_action(cls_names="SidekiqManager")
@exc.on_http_error(exc.GitlabGetError)
def job_stats(self, **kwargs: Any) -> dict[str, Any] | requests.Response:
"""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:
Statistics about the Sidekiq jobs performed
"""
return self.gitlab.http_get(f"{self.path}/job_stats", **kwargs)
@cli.register_custom_action(cls_names="SidekiqManager")
@exc.on_http_error(exc.GitlabGetError)
def compound_metrics(self, **kwargs: Any) -> dict[str, Any] | requests.Response:
"""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:
All available Sidekiq metrics and statistics
"""
return self.gitlab.http_get(f"{self.path}/compound_metrics", **kwargs)
|
