Debian Codegraph @

ansible_collections/netapp/storagegrid/plugins/modules/na_sg_grid_metrics.py

raw
1 #!/usr/bin/python
2
3 # (c) 2025, NetApp Inc
4 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
5
6 """NetApp StorageGRID - Operations on Metrics"""
7
8 from __future__ import absolute_import, division, print_function
9
10 __metaclass__ = type
11
12
13 ANSIBLE_METADATA = {
14 "metadata_version": "1.0",
15 "status": ["preview"],
16 "supported_by": "community",
17 }
18
19
20 DOCUMENTATION = """
21 module: na_sg_grid_metrics
22 short_description: NetApp StorageGRID grab metrics.
23 extends_documentation_fragment:
24 - netapp.storagegrid.netapp.sg
25 version_added: '21.16.0'
26 author: NetApp Ansible Team (@vinaykus) <[email protected]>
27 description:
28 - Get metrics on NetApp StorageGRID.
29 options:
30 query:
31 description:
32 - Prometheus query string to execute.
33 type: str
34 required: true
35 time:
36 description:
37 - Evaluation time for the query. If not provided, default current time(date-time) is used.
38 - Use it as C(start_time) for query over range of time.
39 aliases: ['start_time']
40 type: str
41 end_time:
42 description:
43 - End time for the query range.
44 type: str
45 step:
46 description:
47 - Step width/interval duration for the query range.
48 type: str
49 timeout:
50 description:
51 - Timeout duration for the query execution.
52 type: str
53 """
54
55 EXAMPLES = """
56 - name: Query metrics
57 netapp.storagegrid.na_sg_grid_metrics:
58 api_url: "https://<storagegrid-endpoint-url>"
59 auth_token: "storagegrid-auth-token"
60 validate_certs: false
61 query: storagegrid_storage_utilization_usable_space_bytes
62 time: 2025-08-01T00:00:00.000Z
63 timeout: 30s
64 register: sg_metric
65
66 - name: Query metrics over range of time
67 netapp.storagegrid.na_sg_grid_metrics:
68 api_url: "https://<storagegrid-endpoint-url>"
69 auth_token: "storagegrid-auth-token"
70 validate_certs: false
71 query: storagegrid_storage_utilization_usable_space_bytes{site_name="site1"}
72 start_time: 2025-08-27T10:10:58.668Z
73 end_time: 2025-08-27T10:11:59.668Z
74 step: 60s
75 timeout: 30s
76 register: sg_metric
77 """
78
79 RETURN = """
80 sg_metric:
81 description: Returns information about the StorageGRID metrics.
82 returned: always
83 type: dict
84 sample: {
85 "query": {
86 "result": [
87 {
88 "metric": {
89 "__name__": "storagegrid_storage_utilization_usable_space_bytes",
90 "instance": "sg-sn-01",
91 "job": "ldr",
92 "node_id": "658a91d7-d6f4-4d8e-a8ba-e15e6408b604",
93 "service": "ldr",
94 "site_id": "99d94acc-b2d4-4e4e-86e5-b715af68b40b",
95 "site_name": "site1"
96 },
97 "value": [
98 1756195871.224,
99 "29456490549248"
100 ]
101 }
102 ],
103 "resultType": "vector"
104 }
105 }
106 """
107
108 import ansible_collections.netapp.storagegrid.plugins.module_utils.netapp as netapp_utils
109 from ansible.module_utils.basic import AnsibleModule
110 from ansible_collections.netapp.storagegrid.plugins.module_utils.netapp_module import NetAppModule
111 from ansible_collections.netapp.storagegrid.plugins.module_utils.netapp import SGRestAPI
112
113
114 class SgMetrics:
115 """
116 Operations on Metrics for StorageGRID
117 """
118
119 def __init__(self):
120 """
121 Parse arguments, setup variables,
122 check parameters and ensure request module is installed
123 """
124 self.argument_spec = netapp_utils.na_storagegrid_host_argument_spec()
125 self.argument_spec.update(
126 dict(
127 query=dict(type="str", required=True),
128 time=dict(type="str", required=False, aliases=['start_time']),
129 timeout=dict(type="str", required=False),
130 end_time=dict(type="str", required=False),
131 step=dict(type="str", required=False),
132 )
133 )
134 self.module = AnsibleModule(
135 argument_spec=self.argument_spec,
136 supports_check_mode=True
137 )
138 self.na_helper = NetAppModule()
139
140 # set up variables
141 self.parameters = self.na_helper.set_parameters(self.module.params)
142 # Calling generic SG rest_api class
143 self.rest_api = SGRestAPI(self.module)
144 # Get API version
145 self.rest_api.get_sg_product_version(api_root="grid")
146 # Checking for the parameters passed and create new parameters list
147
148 self.params = {
149 "query": self.parameters["query"],
150 "timeout": self.parameters.get("timeout")
151 }
152
153 def get_metric_query(self):
154 ''' Get metrics query'''
155 api = "api/v4/grid/metric-query"
156 self.params.update({
157 "time": self.parameters.get("time")
158 })
159 response, error = self.rest_api.get(api, self.params)
160 if error:
161 self.module.fail_json(msg=error)
162
163 return response["data"]
164
165 def get_metric_query_range(self):
166 ''' Get metrics query range'''
167 api = "api/v4/grid/metric-query-range"
168 self.params.update({
169 "start": self.parameters.get("time"),
170 "end": self.parameters.get("end_time"),
171 "step": self.parameters.get("step")
172 })
173 response, error = self.rest_api.get(api, self.params)
174 if error:
175 self.module.fail_json(msg=error)
176
177 return response["data"]
178
179 def apply(self):
180 ''' Apply metrics '''
181 result_message = dict()
182 if self.parameters.get("query") and not self.parameters.get("end_time") and not self.parameters.get("step"):
183 result_message = self.get_metric_query()
184 elif all(self.parameters.get(k) for k in ["query", "time", "end_time", "step"]):
185 result_message = self.get_metric_query_range()
186 else:
187 self.module.fail_json(
188 msg="If 'query' provided, 'time' (or 'start_time'), 'end_time', and 'step' must also be specified for query over range of time."
189 )
190
191 self.module.exit_json(changed=False, sg_metric=result_message)
192
193
194 def main():
195 """
196 Main function
197 """
198 na_sg_grid_metrics = SgMetrics()
199 na_sg_grid_metrics.apply()
200
201
202 if __name__ == "__main__":
203 main()