-
Notifications
You must be signed in to change notification settings - Fork 445
/
configuration.py
361 lines (262 loc) · 8.07 KB
/
configuration.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
# Distributed under the terms of the Modified BSD License.
import copy
import sys
import base64
from collections.abc import MutableMapping
from hdijupyterutils.constants import (
EVENTS_HANDLER_CLASS_NAME,
LOGGING_CONFIG_CLASS_NAME,
)
from hdijupyterutils.utils import join_paths
from hdijupyterutils.configuration import override as _override
from hdijupyterutils.configuration import override_all as _override_all
from hdijupyterutils.configuration import with_override
from .constants import (
HOME_PATH,
CONFIG_FILE,
MAGICS_LOGGER_NAME,
LIVY_KIND_PARAM,
LANG_SCALA,
LANG_PYTHON,
LANG_R,
SESSION_KIND_SPARKR,
SESSION_KIND_SPARK,
SESSION_KIND_PYSPARK,
CONFIGURABLE_RETRY,
NO_AUTH,
AUTH_BASIC,
)
from sparkmagic.livyclientlib.exceptions import BadUserConfigurationException
# import sparkmagic.utils.constants as constants
from requests_kerberos import REQUIRED
d = {}
path = join_paths(HOME_PATH, CONFIG_FILE)
def override(config, value):
_override(d, path, config, value)
def override_all(obj):
_override_all(d, obj)
_with_override = with_override(d, path)
# Helpers
def get_livy_kind(language):
if language == LANG_SCALA:
return SESSION_KIND_SPARK
elif language == LANG_PYTHON:
return SESSION_KIND_PYSPARK
elif language == LANG_R:
return SESSION_KIND_SPARKR
else:
raise BadUserConfigurationException(
"Cannot get session kind for {}.".format(language)
)
def get_auth_value(username, password):
if username == "" and password == "":
return NO_AUTH
return AUTH_BASIC
@_with_override
def authenticators():
return {
"Kerberos": "sparkmagic.auth.kerberos.Kerberos",
"None": "sparkmagic.auth.customauth.Authenticator",
"Basic_Access": "sparkmagic.auth.basic.Basic",
}
# Configs
def _recursive_merge(target, updates):
"""
Recursively merge two dictionaries of dictionaries.
This function can mutate both parameters.
Callers should deepcopy dictionaries before passing them in.
"""
for k, v in target.items():
if k in updates:
if all(isinstance(e, MutableMapping) for e in (v, updates[k])):
updates[k] = _recursive_merge(v, updates[k])
out = target.copy()
out.update(updates)
return out
def get_session_properties(language):
properties = copy.deepcopy(session_configs_defaults())
properties = _recursive_merge(properties, copy.deepcopy(session_configs()))
properties[LIVY_KIND_PARAM] = get_livy_kind(language)
return properties
@_with_override
def session_configs():
return {}
@_with_override
def session_configs_defaults():
return {}
@_with_override
def kernel_python_credentials():
return {
"username": "",
"base64_password": "",
"url": "http://localhost:8998",
"auth": NO_AUTH,
}
def base64_kernel_python_credentials():
return _credentials_override(kernel_python_credentials)
# No one's gonna use pyspark and pyspark3 notebook on different endpoints. Reuse the old config.
@_with_override
def kernel_python3_credentials():
return kernel_python_credentials()
def base64_kernel_python3_credentials():
return base64_kernel_python_credentials()
@_with_override
def kernel_scala_credentials():
return {
"username": "",
"base64_password": "",
"url": "http://localhost:8998",
"auth": NO_AUTH,
}
def base64_kernel_scala_credentials():
return _credentials_override(kernel_scala_credentials)
@_with_override
def kernel_r_credentials():
return {
"username": "",
"base64_password": "",
"url": "http://localhost:8998",
"auth": NO_AUTH,
}
def base64_kernel_r_credentials():
return _credentials_override(kernel_r_credentials)
@_with_override
def logging_config():
return {
"version": 1,
"formatters": {
"magicsFormatter": {
"format": "%(asctime)s\t%(levelname)s\t%(message)s",
"datefmt": "",
}
},
"handlers": {
"magicsHandler": {
"class": LOGGING_CONFIG_CLASS_NAME,
"formatter": "magicsFormatter",
"home_path": HOME_PATH,
}
},
"loggers": {
MAGICS_LOGGER_NAME: {
"handlers": ["magicsHandler"],
"level": "DEBUG",
"propagate": 0,
}
},
}
@_with_override
def http_session_config():
return {"adapters": []}
@_with_override
def events_handler_class():
return EVENTS_HANDLER_CLASS_NAME
@_with_override
def wait_for_idle_timeout_seconds():
return 15
@_with_override
def livy_session_startup_timeout_seconds():
return 60
@_with_override
def fatal_error_suggestion():
return """The code failed because of a fatal error:
\t{}.
Some things to try:
a) Make sure Spark has enough available resources for Jupyter to create a Spark context.
b) Contact your Jupyter administrator to make sure the Spark magics library is configured correctly.
c) Restart the kernel."""
@_with_override
def resource_limit_mitigation_suggestion():
return ""
@_with_override
def ignore_ssl_errors():
return False
@_with_override
def coerce_dataframe():
return True
@_with_override
def use_auto_viz():
return True
@_with_override
def default_maxrows():
return 2500
@_with_override
def default_samplemethod():
return "take"
@_with_override
def default_samplefraction():
return 0.1
@_with_override
def pyspark_dataframe_encoding():
return "utf-8"
@_with_override
def heartbeat_refresh_seconds():
return 30
@_with_override
def heartbeat_retry_seconds():
return 10
@_with_override
def livy_server_heartbeat_timeout_seconds():
return 60
@_with_override
def server_extension_default_kernel_name():
return "pysparkkernel"
@_with_override
def custom_headers():
return {}
@_with_override
def retry_policy():
return CONFIGURABLE_RETRY
@_with_override
def retry_seconds_to_sleep_list():
return [0.2, 0.5, 1, 3, 5]
@_with_override
def configurable_retry_policy_max_retries():
# Sum of default values is ~10 seconds.
# Plus 15 seconds more wanted, that's 3 more 5 second retries.
return 8
@_with_override
def shutdown_session_on_spark_statement_errors():
# If set to true, any spark statement errors will cause the Livy
# session to be cleaned up
return False
@_with_override
def all_errors_are_fatal():
# If set to true, any error will be considered fatal and be raised
return False
@_with_override
def cleanup_all_sessions_on_exit():
# If set to true, all registered livy sessions will be attempted to be cleaned up before exiting
return False
@_with_override
def kerberos_auth_configuration():
return {"mutual_authentication": REQUIRED}
def _credentials_override(f):
"""Provides special handling for credentials. It still calls _override().
If 'base64_password' in config is set, it will base64 decode it and returned in return value's 'password' field.
If 'base64_password' is not set, it will fallback to 'password' in config.
"""
credentials = f()
base64_decoded_credentials = {
k: credentials.get(k) for k in ("username", "password", "url", "auth")
}
base64_password = credentials.get("base64_password")
if base64_password is not None:
try:
base64_decoded_credentials["password"] = base64.b64decode(
base64_password
).decode()
except Exception:
exception_type, exception, traceback = sys.exc_info()
msg = "base64_password for %s contains invalid base64 string: %s %s" % (
f.__name__,
exception_type,
exception,
)
raise BadUserConfigurationException(msg)
if base64_decoded_credentials["auth"] is None:
base64_decoded_credentials["auth"] = get_auth_value(
base64_decoded_credentials["username"],
base64_decoded_credentials["password"],
)
return base64_decoded_credentials