-
Notifications
You must be signed in to change notification settings - Fork 13
/
client.py
379 lines (296 loc) · 12.7 KB
/
client.py
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
import json
import time
import logging
import requests
from slugify import slugify
# Taking into account different versions of Python
try:
from urlparse import urljoin
from urllib import urlencode
except ImportError: # pragma: no cover
from urllib.parse import urlencode
from urllib.parse import urljoin
from redash_client.constants import VizType, VizWidth, ChartType, TimeInterval
class RedashClient(object):
BASE_URL = "https://sql.telemetry.mozilla.org/"
API_BASE_URL = BASE_URL + "api/"
MAX_RETRY_COUNT = 5
class RedashClientException(Exception):
pass
def __init__(self, api_key):
self._api_key = api_key
self._url_params = urlencode({"api_key": self._api_key})
logging.basicConfig()
self._logger = logging.getLogger()
self._logger.setLevel(logging.INFO)
def get_slug(self, name):
return slugify(name)
def make_visualization_options(self, chart_type=None, viz_type=None,
column_mapping=None, series_options=None,
time_interval=None, stacking=None):
# See the API doc for more details about visualization options:
# https://people-mozilla.org/~ashort/redash_docs/api.html
if viz_type == VizType.COHORT:
return {
"timeInterval": time_interval,
}
# It's a chart viz type.
options = {
"bottomMargin": 50,
"columnMapping": column_mapping,
"globalSeriesType": chart_type,
"legend": {"enabled": True},
"series": {"stacking": "normal" if stacking else None},
"seriesOptions": series_options if series_options else {},
"sortX": True,
"xAxis": {"type": "datetime", "labels": {"enabled": True}},
"yAxis": [{"type": "linear"}, {"type": "linear", "opposite": True}],
}
return options
def _make_request(self, request_function, url, args={}):
if not request_function:
request_function = requests.post
try:
if request_function != requests.post:
response = request_function(url)
else:
response = request_function(url, args)
except requests.RequestException as e:
raise self.RedashClientException(
("Unable to communicate with redash: {error}").format(error=e), e)
if response.status_code != 200:
raise self.RedashClientException(
("Error status returned: {error_code} {error_message}").format(
error_code=response.status_code,
error_message=response.content,
), response.status_code)
try:
json_result = json.loads(response.content), response
except ValueError as e:
raise self.RedashClientException(
("Unable to parse JSON response: {error}").format(error=e))
return json_result
def _get_new_query_id(self, name, sql_query, data_source_id, description):
url_path = "queries?{0}".format(self._url_params)
query_url = urljoin(self.API_BASE_URL, url_path)
new_query_args = json.dumps({
"name": name,
"query": sql_query,
"data_source_id": data_source_id,
"description": description,
})
json_result, response = self._make_request(
requests.post, query_url, new_query_args)
query_id = json_result.get("id", None)
return query_id
def _get_visualization(self, query_id):
url_path = "queries/{0}?{1}".format(str(query_id), self._url_params)
query_url = urljoin(self.API_BASE_URL, url_path)
query_json_data, response = self._make_request(requests.get, query_url)
query_visualizations = query_json_data.get("visualizations", [])
visualization_data = None
if len(query_visualizations) >= 1:
visualization_data = query_visualizations[0]
return visualization_data
def _refresh_graph(self, query_id):
# Refresh our new query so it becomes available
url_path = "queries/{0}/refresh?{1}".format(
str(query_id), self._url_params)
query_url = urljoin(self.API_BASE_URL, url_path)
self._make_request(requests.post, query_url)
def create_new_query(self, name, sql_query,
data_source_id, description=None):
query_id = self._get_new_query_id(
name, sql_query, data_source_id, description)
# If we can't get a query ID, the query has no table. Exit now.
if not query_id:
return None, None
visualization = self._get_visualization(query_id)
table_id = None
if visualization:
table_id = visualization.get("id", None)
self._refresh_graph(query_id)
return query_id, table_id
def get_query_results(self, sql_query, data_source_id):
url_path = "query_results?{0}".format(self._url_params)
query_url = urljoin(self.API_BASE_URL, url_path)
get_query_results_args = json.dumps({
"query": sql_query,
"data_source_id": data_source_id,
})
# If this query is still not uploaded, we'll get a job ID.
# Let's retry in 1 second.
for attempt in range(self.MAX_RETRY_COUNT):
json_response, response = self._make_request(
requests.post, query_url, get_query_results_args)
if "job" not in json_response:
break
time.sleep(1)
rows = json_response.get(
"query_result", {}).get("data", {}).get("rows", [])
return rows
def make_new_visualization_request(self, query_id, viz_type, options, title):
url_path = "visualizations?{0}".format(self._url_params)
query_url = urljoin(self.API_BASE_URL, url_path)
new_visualization_args = json.dumps({
"type": viz_type,
"name": title,
"options": options,
"query_id": query_id,
})
json_result, response = self._make_request(
requests.post, query_url, new_visualization_args)
visualization_id = json_result.get("id", None)
return visualization_id
def create_new_visualization(self, query_id, viz_type=VizType.CHART,
title="Chart", chart_type=None,
column_mapping=None, series_options=None,
time_interval=None, stacking=False):
# Note: column_mapping is a dict of which field names to use for the x and
# y axis. (e.g. {"event":"x","count":"y","type":"series"})
if viz_type == VizType.CHART and (
chart_type not in ChartType.allowed_chart_types or
column_mapping is None):
raise ValueError(("chart_type and column_mapping "
"values required for a Chart visualization"))
# Note: time_interval is one of "daily", "weekly", "monthly"
if (viz_type == VizType.COHORT and
time_interval not in TimeInterval.allowed_time_intervals):
raise ValueError(("time_interval value required for "
"a Cohort visualization"))
if viz_type != VizType.CHART and viz_type != VizType.COHORT:
raise ValueError("VizType must be one of: VizType.CHART, VizType.COHORT")
options = self.make_visualization_options(
chart_type, viz_type, column_mapping,
series_options, time_interval, stacking)
visualization_id = self.make_new_visualization_request(
query_id, viz_type, options, title)
return visualization_id
def create_new_dashboard(self, name):
slug = self.get_slug(name)
# Check if dashboard exists
url_path = "dashboards/{0}?{1}".format(slug, self._url_params)
query_url = urljoin(self.API_BASE_URL, url_path)
new_dashboard_args = json.dumps({"name": name})
try:
json_result, response = self._make_request(
requests.get, query_url)
self._logger.info((
"RedashClient: Dashboard {name} exists and has "
"been fetched").format(name=name))
except self.RedashClientException as ex:
server_error_code = ex.args[1]
if server_error_code == 404:
self._logger.info((
"RedashClient: Dashboard {name} does not exist. "
"Creating a new one.").format(name=name))
url_path = "dashboards?{0}".format(self._url_params)
query_url = urljoin(self.API_BASE_URL, url_path)
json_result, response = self._make_request(
requests.post, query_url, new_dashboard_args)
dashboard_id = json_result.get("id", None)
return dashboard_id
def get_public_url(self, dash_id):
url_path = "dashboards/{0}/share?{1}".format(
str(dash_id), self._url_params)
query_url = urljoin(self.API_BASE_URL, url_path)
json_result, response = self._make_request(requests.post, query_url)
public_url = json_result.get("public_url", None)
return public_url
def publish_dashboard(self, dash_id):
url_path = "dashboards/{0}?{1}".format(str(dash_id), self._url_params)
query_url = urljoin(self.API_BASE_URL, url_path)
publish_dashboard_args = json.dumps({"is_draft": False})
self._make_request(requests.post, query_url, publish_dashboard_args)
def remove_visualization(self, viz_id):
url_path = "widgets/{0}?{1}".format(str(viz_id), self._url_params)
query_url = urljoin(self.API_BASE_URL, url_path)
self._make_request(requests.delete, query_url)
def delete_query(self, query_id):
url_path = "queries/{0}?{1}".format(str(query_id), self._url_params)
query_url = urljoin(self.API_BASE_URL, url_path)
self._make_request(requests.delete, query_url)
def add_visualization_to_dashboard(self, dash_id, viz_id, viz_width):
if viz_width != VizWidth.REGULAR and viz_width != VizWidth.WIDE:
raise ValueError(("viz_width should be one of "
"VizWidth.WIDE or VizWidth.REGULAR"))
url_path = "widgets?{0}".format(self._url_params)
query_url = urljoin(self.API_BASE_URL, url_path)
add_visualization_args = json.dumps({
"dashboard_id": dash_id,
"visualization_id": viz_id,
"width": viz_width,
"options": {},
"text": "",
})
self._make_request(requests.post, query_url, add_visualization_args)
def get_visualization_public_url(self, query_id, widget_id):
url_path = ("embed/query/{query_id}/visualization/{viz_id}"
"?{url_param}").format(
query_id=query_id, viz_id=widget_id, url_param=self._url_params)
query_url = urljoin(self.BASE_URL, url_path)
return query_url
def update_query_schedule(self, query_id, schedule):
url_path = "queries/{0}?{1}".format(str(query_id), self._url_params)
query_url = urljoin(self.API_BASE_URL, url_path)
update_query_args = json.dumps({"schedule": schedule, "id": query_id})
self._make_request(requests.post, query_url, update_query_args)
def update_query(self, query_id, name, sql_query,
data_source_id, description, options=None):
url_path = "queries/{0}?{1}".format(str(query_id), self._url_params)
query_url = urljoin(self.API_BASE_URL, url_path)
update_query_args = {
"data_source_id": data_source_id,
"query": sql_query,
"name": name,
"description": description,
"id": query_id,
}
if options:
update_query_args["options"] = options
self._make_request(requests.post, query_url, json.dumps(update_query_args))
self._refresh_graph(query_id)
def fork_query(self, query_id):
url_path = "queries/{0}/fork?{1}".format(query_id, self._url_params)
query_url = urljoin(self.API_BASE_URL, url_path)
json_result, response = self._make_request(
requests.post, query_url)
fork = {
"id": json_result.get("id", None),
"query": json_result.get("query", None),
"data_source_id": json_result.get("data_source_id", None)
}
return fork
def search_queries(self, keyword):
url_path = "queries/search?q={0}&{1}".format(keyword, self._url_params)
query_url = urljoin(self.API_BASE_URL, url_path)
json_result, response = self._make_request(
requests.get, query_url)
templated_queries = []
for query in json_result:
query_id = query.get("id", None)
visualization = self._get_visualization(query_id)
options = visualization.get("options", None)
viz_type = visualization.get("type", None)
templated_queries.append({
"id": query_id,
"description": query.get("description", None),
"name": query.get("name", None),
"data_source_id": query.get("data_source_id", None),
"options": options,
"type": viz_type,
"query": query.get("query", None)
})
return templated_queries
def get_widget_from_dash(self, name):
slug = self.get_slug(name)
url_path = "dashboards/{0}?{1}".format(slug, self._url_params)
query_url = urljoin(self.API_BASE_URL, url_path)
# Note: row_arr is in the form:
# [{}, {}, {} ...]
#
# Where each object represents a widget in a redash dashboard
json_result, response = self._make_request(
requests.get, query_url)
widgets = json_result.get("widgets", [])
return widgets