-
Notifications
You must be signed in to change notification settings - Fork 5.9k
/
mgr_module.py
1615 lines (1316 loc) · 52.8 KB
/
mgr_module.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
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import ceph_module # noqa
try:
from typing import Set, Tuple, Iterator, Any, Dict, Optional, Callable, List
except ImportError:
# just for type checking
pass
import logging
import errno
import json
import threading
from collections import defaultdict, namedtuple
import rados
import re
import time
from mgr_util import profile_method
# Full list of strings in "osd_types.cc:pg_state_string()"
PG_STATES = [
"active",
"clean",
"down",
"recovery_unfound",
"backfill_unfound",
"scrubbing",
"degraded",
"inconsistent",
"peering",
"repair",
"recovering",
"forced_recovery",
"backfill_wait",
"incomplete",
"stale",
"remapped",
"deep",
"backfilling",
"forced_backfill",
"backfill_toofull",
"recovery_wait",
"recovery_toofull",
"undersized",
"activating",
"peered",
"snaptrim",
"snaptrim_wait",
"snaptrim_error",
"creating",
"unknown",
"premerge",
"failed_repair",
"laggy",
"wait",
]
class CommandResult(object):
"""
Use with MgrModule.send_command
"""
def __init__(self, tag=None):
self.ev = threading.Event()
self.outs = ""
self.outb = ""
self.r = 0
# This is just a convenience for notifications from
# C++ land, to avoid passing addresses around in messages.
self.tag = tag if tag else ""
def complete(self, r, outb, outs):
self.r = r
self.outb = outb
self.outs = outs
self.ev.set()
def wait(self):
self.ev.wait()
return self.r, self.outb, self.outs
class HandleCommandResult(namedtuple('HandleCommandResult', ['retval', 'stdout', 'stderr'])):
def __new__(cls, retval=0, stdout="", stderr=""):
"""
Tuple containing the result of `handle_command()`
Only write to stderr if there is an error, or in extraordinary circumstances
Avoid having `ceph foo bar` commands say "did foo bar" on success unless there
is critical information to include there.
Everything programmatically consumable should be put on stdout
:param retval: return code. E.g. 0 or -errno.EINVAL
:type retval: int
:param stdout: data of this result.
:type stdout: str
:param stderr: Typically used for error messages.
:type stderr: str
"""
return super(HandleCommandResult, cls).__new__(cls, retval, stdout, stderr)
class MonCommandFailed(RuntimeError): pass
class OSDMap(ceph_module.BasePyOSDMap):
def get_epoch(self):
return self._get_epoch()
def get_crush_version(self):
return self._get_crush_version()
def dump(self):
return self._dump()
def get_pools(self):
# FIXME: efficient implementation
d = self._dump()
return dict([(p['pool'], p) for p in d['pools']])
def get_pools_by_name(self):
# FIXME: efficient implementation
d = self._dump()
return dict([(p['pool_name'], p) for p in d['pools']])
def new_incremental(self):
return self._new_incremental()
def apply_incremental(self, inc):
return self._apply_incremental(inc)
def get_crush(self):
return self._get_crush()
def get_pools_by_take(self, take):
return self._get_pools_by_take(take).get('pools', [])
def calc_pg_upmaps(self, inc,
max_deviation=.01, max_iterations=10, pools=None):
if pools is None:
pools = []
return self._calc_pg_upmaps(
inc,
max_deviation, max_iterations, pools)
def map_pool_pgs_up(self, poolid):
return self._map_pool_pgs_up(poolid)
def pg_to_up_acting_osds(self, pool_id, ps):
return self._pg_to_up_acting_osds(pool_id, ps)
def pool_raw_used_rate(self, pool_id):
return self._pool_raw_used_rate(pool_id)
def get_ec_profile(self, name):
# FIXME: efficient implementation
d = self._dump()
return d['erasure_code_profiles'].get(name, None)
def get_require_osd_release(self):
d = self._dump()
return d['require_osd_release']
class OSDMapIncremental(ceph_module.BasePyOSDMapIncremental):
def get_epoch(self):
return self._get_epoch()
def dump(self):
return self._dump()
def set_osd_reweights(self, weightmap):
"""
weightmap is a dict, int to float. e.g. { 0: .9, 1: 1.0, 3: .997 }
"""
return self._set_osd_reweights(weightmap)
def set_crush_compat_weight_set_weights(self, weightmap):
"""
weightmap is a dict, int to float. devices only. e.g.,
{ 0: 3.4, 1: 3.3, 2: 3.334 }
"""
return self._set_crush_compat_weight_set_weights(weightmap)
class CRUSHMap(ceph_module.BasePyCRUSH):
ITEM_NONE = 0x7fffffff
DEFAULT_CHOOSE_ARGS = '-1'
def dump(self):
return self._dump()
def get_item_weight(self, item):
return self._get_item_weight(item)
def get_item_name(self, item):
return self._get_item_name(item)
def find_takes(self):
return self._find_takes().get('takes', [])
def get_take_weight_osd_map(self, root):
uglymap = self._get_take_weight_osd_map(root)
return {int(k): v for k, v in uglymap.get('weights', {}).items()}
@staticmethod
def have_default_choose_args(dump):
return CRUSHMap.DEFAULT_CHOOSE_ARGS in dump.get('choose_args', {})
@staticmethod
def get_default_choose_args(dump):
return dump.get('choose_args').get(CRUSHMap.DEFAULT_CHOOSE_ARGS, [])
def get_rule(self, rule_name):
# TODO efficient implementation
for rule in self.dump()['rules']:
if rule_name == rule['rule_name']:
return rule
return None
def get_rule_by_id(self, rule_id):
for rule in self.dump()['rules']:
if rule['rule_id'] == rule_id:
return rule
return None
def get_rule_root(self, rule_name):
rule = self.get_rule(rule_name)
if rule is None:
return None
try:
first_take = [s for s in rule['steps'] if 'op' in s and s['op'] == 'take'][0]
except IndexError:
logging.warning("CRUSH rule '{0}' has no 'take' step".format(
rule_name))
return None
else:
return first_take['item']
def get_osds_under(self, root_id):
# TODO don't abuse dump like this
d = self.dump()
buckets = dict([(b['id'], b) for b in d['buckets']])
osd_list = []
def accumulate(b):
for item in b['items']:
if item['id'] >= 0:
osd_list.append(item['id'])
else:
try:
accumulate(buckets[item['id']])
except KeyError:
pass
accumulate(buckets[root_id])
return osd_list
def device_class_counts(self):
result = defaultdict(int) # type: Dict[str, int]
# TODO don't abuse dump like this
d = self.dump()
for device in d['devices']:
cls = device.get('class', None)
result[cls] += 1
return dict(result)
class CLICommand(object):
COMMANDS = {} # type: Dict[str, CLICommand]
def __init__(self, prefix, args="", desc="", perm="rw"):
self.prefix = prefix
self.args = args
self.args_dict = {}
self.desc = desc
self.perm = perm
self.func = None # type: Optional[Callable]
self._parse_args()
def _parse_args(self):
if not self.args:
return
args = self.args.split(" ")
for arg in args:
arg_desc = arg.strip().split(",")
arg_d = {}
for kv in arg_desc:
k, v = kv.split("=")
if k != "name":
arg_d[k] = v
else:
self.args_dict[v] = arg_d
def __call__(self, func):
self.func = func
self.COMMANDS[self.prefix] = self
return self.func
def call(self, mgr, cmd_dict, inbuf):
kwargs = {}
kwargs_switch = False
for a, d in self.args_dict.items():
if 'req' in d and d['req'] == "false" and a not in cmd_dict:
continue
if isinstance(cmd_dict[a], str) and '=' in cmd_dict[a]:
k, arg = cmd_dict[a].split('=', 1)
if k in self.args_dict:
kwargs_switch = True
if kwargs_switch:
try:
k, arg = cmd_dict[a].split('=', 1)
except ValueError as e:
mgr.log.error('found positional arg after switching to kwarg parsing')
return -errno.EINVAL, '', 'Error EINVAL: postitional arg not allowed after kwarg'
kwargs[k.replace("-", "_")] = arg
else:
kwargs[a.replace("-", "_")] = cmd_dict[a]
if inbuf:
kwargs['inbuf'] = inbuf
assert self.func
return self.func(mgr, **kwargs)
def dump_cmd(self):
return {
'cmd': '{} {}'.format(self.prefix, self.args),
'desc': self.desc,
'perm': self.perm
}
@classmethod
def dump_cmd_list(cls):
return [cmd.dump_cmd() for cmd in cls.COMMANDS.values()]
def CLIReadCommand(prefix, args="", desc=""):
return CLICommand(prefix, args, desc, "r")
def CLIWriteCommand(prefix, args="", desc=""):
return CLICommand(prefix, args, desc, "w")
def _get_localized_key(prefix, key):
return '{}/{}'.format(prefix, key)
class Option(dict):
"""
Helper class to declare options for MODULE_OPTIONS list.
Caveat: it uses argument names matching Python keywords (type, min, max),
so any further processing should happen in a separate method.
TODO: type validation.
"""
def __init__(
self, name,
default=None,
type='str',
desc=None, longdesc=None,
min=None, max=None,
enum_allowed=None,
see_also=None,
tags=None,
runtime=False,
):
super(Option, self).__init__(
(k, v) for k, v in vars().items()
if k != 'self' and v is not None)
class Command(dict):
"""
Helper class to declare options for COMMANDS list.
It also allows to specify prefix and args separately, as well as storing a
handler callable.
Usage:
>>> Command(prefix="example",
... args="name=arg,type=CephInt",
... perm='w',
... desc="Blah")
{'poll': False, 'cmd': 'example name=arg,type=CephInt', 'perm': 'w', 'desc': 'Blah'}
"""
def __init__(
self,
prefix,
args=None,
perm="rw",
desc=None,
poll=False,
handler=None
):
super(Command, self).__init__(
cmd=prefix + (' ' + args if args else ''),
perm=perm,
desc=desc,
poll=poll)
self.prefix = prefix
self.args = args
self.handler = handler
def register(self, instance=False):
"""
Register a CLICommand handler. It allows an instance to register bound
methods. In that case, the mgr instance is not passed, and it's expected
to be available in the class instance.
It also uses HandleCommandResult helper to return a wrapped a tuple of 3
items.
"""
return CLICommand(
prefix=self.prefix,
args=self.args,
desc=self['desc'],
perm=self['perm']
)(
func=lambda mgr, *args, **kwargs: HandleCommandResult(*self.handler(
*((instance or mgr,) + args), **kwargs))
)
class CPlusPlusHandler(logging.Handler):
def __init__(self, module_inst):
super(CPlusPlusHandler, self).__init__()
self._module = module_inst
self.setFormatter(logging.Formatter("[{} %(levelname)-4s %(name)s] %(message)s"
.format(module_inst.module_name)))
def emit(self, record):
if record.levelno >= self.level:
self._module._ceph_log(self.format(record))
class ClusterLogHandler(logging.Handler):
def __init__(self, module_inst):
super().__init__()
self._module = module_inst
self.setFormatter(logging.Formatter("%(message)s"))
def emit(self, record):
levelmap = {
'DEBUG': MgrModule.CLUSTER_LOG_PRIO_DEBUG,
'INFO': MgrModule.CLUSTER_LOG_PRIO_INFO,
'WARNING': MgrModule.CLUSTER_LOG_PRIO_WARN,
'ERROR': MgrModule.CLUSTER_LOG_PRIO_ERROR,
'CRITICAL': MgrModule.CLUSTER_LOG_PRIO_ERROR,
}
level = levelmap[record.levelname]
if record.levelno >= self.level:
self._module.cluster_log(self._module.module_name,
level,
self.format(record))
class FileHandler(logging.FileHandler):
def __init__(self, module_inst):
path = module_inst.get_ceph_option("log_file")
idx = path.rfind(".log")
if idx != -1:
self.path = "{}.{}.log".format(path[:idx], module_inst.module_name)
else:
self.path = "{}.{}".format(path, module_inst.module_name)
super(FileHandler, self).__init__(self.path, delay=True)
self.setFormatter(logging.Formatter("%(asctime)s [%(threadName)s] [%(levelname)-4s] [%(name)s] %(message)s"))
class MgrModuleLoggingMixin(object):
def _configure_logging(self, mgr_level, module_level, cluster_level,
log_to_file, log_to_cluster):
self._mgr_level = None
self._module_level = None
self._root_logger = logging.getLogger()
self._unconfigure_logging()
# the ceph log handler is initialized only once
self._mgr_log_handler = CPlusPlusHandler(self)
self._cluster_log_handler = ClusterLogHandler(self)
self._file_log_handler = FileHandler(self)
self.log_to_file = log_to_file
self.log_to_cluster = log_to_cluster
self._root_logger.addHandler(self._mgr_log_handler)
if log_to_file:
self._root_logger.addHandler(self._file_log_handler)
if log_to_cluster:
self._root_logger.addHandler(self._cluster_log_handler)
self._root_logger.setLevel(logging.NOTSET)
self._set_log_level(mgr_level, module_level, cluster_level)
def _unconfigure_logging(self):
# remove existing handlers:
rm_handlers = [
h for h in self._root_logger.handlers if isinstance(h, CPlusPlusHandler) or isinstance(h, FileHandler) or isinstance(h, ClusterLogHandler)]
for h in rm_handlers:
self._root_logger.removeHandler(h)
self.log_to_file = False
self.log_to_cluster = False
def _set_log_level(self, mgr_level, module_level, cluster_level):
self._cluster_log_handler.setLevel(cluster_level.upper())
module_level = module_level.upper() if module_level else ''
if not self._module_level:
# using debug_mgr level
if not module_level and self._mgr_level == mgr_level:
# no change in module level neither in debug_mgr
return
else:
if self._module_level == module_level:
# no change in module level
return
if not self._module_level and not module_level:
level = self._ceph_log_level_to_python(mgr_level)
self.getLogger().debug("setting log level based on debug_mgr: %s (%s)", level, mgr_level)
elif self._module_level and not module_level:
level = self._ceph_log_level_to_python(mgr_level)
self.getLogger().warning("unsetting module log level, falling back to "
"debug_mgr level: %s (%s)", level, mgr_level)
elif module_level:
level = module_level
self.getLogger().debug("setting log level: %s", level)
self._module_level = module_level
self._mgr_level = mgr_level
self._mgr_log_handler.setLevel(level)
self._file_log_handler.setLevel(level)
def _enable_file_log(self):
# enable file log
self.getLogger().warning("enabling logging to file")
self.log_to_file = True
self._root_logger.addHandler(self._file_log_handler)
def _disable_file_log(self):
# disable file log
self.getLogger().warning("disabling logging to file")
self.log_to_file = False
self._root_logger.removeHandler(self._file_log_handler)
def _enable_cluster_log(self):
# enable cluster log
self.getLogger().warning("enabling logging to cluster")
self.log_to_cluster = True
self._root_logger.addHandler(self._cluster_log_handler)
def _disable_cluster_log(self):
# disable cluster log
self.getLogger().warning("disabling logging to cluster")
self.log_to_cluster = False
self._root_logger.removeHandler(self._cluster_log_handler)
def _ceph_log_level_to_python(self, ceph_log_level):
if ceph_log_level:
try:
ceph_log_level = int(ceph_log_level.split("/", 1)[0])
except ValueError:
ceph_log_level = 0
else:
ceph_log_level = 0
log_level = "DEBUG"
if ceph_log_level <= 0:
log_level = "CRITICAL"
elif ceph_log_level <= 1:
log_level = "WARNING"
elif ceph_log_level <= 4:
log_level = "INFO"
return log_level
def getLogger(self, name=None):
return logging.getLogger(name)
class MgrStandbyModule(ceph_module.BaseMgrStandbyModule, MgrModuleLoggingMixin):
"""
Standby modules only implement a serve and shutdown method, they
are not permitted to implement commands and they do not receive
any notifications.
They only have access to the mgrmap (for accessing service URI info
from their active peer), and to configuration settings (read only).
"""
MODULE_OPTIONS = [] # type: List[Dict[str, Any]]
MODULE_OPTION_DEFAULTS = {} # type: Dict[str, Any]
def __init__(self, module_name, capsule):
super(MgrStandbyModule, self).__init__(capsule)
self.module_name = module_name
# see also MgrModule.__init__()
for o in self.MODULE_OPTIONS:
if 'default' in o:
if 'type' in o:
self.MODULE_OPTION_DEFAULTS[o['name']] = o['default']
else:
self.MODULE_OPTION_DEFAULTS[o['name']] = str(o['default'])
mgr_level = self.get_ceph_option("debug_mgr")
log_level = self.get_module_option("log_level")
cluster_level = self.get_module_option('log_to_cluster_level')
self._configure_logging(mgr_level, log_level, cluster_level,
False, False)
# for backwards compatibility
self._logger = self.getLogger()
def __del__(self):
self._cleanup()
self._unconfigure_logging()
def _cleanup(self):
pass
@classmethod
def _register_options(cls, module_name):
cls.MODULE_OPTIONS.append(
Option(name='log_level', type='str', default="", runtime=True,
enum_allowed=['info', 'debug', 'critical', 'error',
'warning', '']))
cls.MODULE_OPTIONS.append(
Option(name='log_to_file', type='bool', default=False, runtime=True))
if not [x for x in cls.MODULE_OPTIONS if x['name'] == 'log_to_cluster']:
cls.MODULE_OPTIONS.append(
Option(name='log_to_cluster', type='bool', default=False,
runtime=True))
cls.MODULE_OPTIONS.append(
Option(name='log_to_cluster_level', type='str', default='info',
runtime=True,
enum_allowed=['info', 'debug', 'critical', 'error',
'warning', '']))
@property
def log(self):
return self._logger
def serve(self):
"""
The serve method is mandatory for standby modules.
:return:
"""
raise NotImplementedError()
def get_mgr_id(self):
return self._ceph_get_mgr_id()
def get_module_option(self, key, default=None):
"""
Retrieve the value of a persistent configuration setting
:param str key:
:param default: the default value of the config if it is not found
:return: str
"""
r = self._ceph_get_module_option(key)
if r is None:
return self.MODULE_OPTION_DEFAULTS.get(key, default)
else:
return r
def get_ceph_option(self, key):
return self._ceph_get_option(key)
def get_store(self, key):
"""
Retrieve the value of a persistent KV store entry
:param key: String
:return: Byte string or None
"""
return self._ceph_get_store(key)
def get_active_uri(self):
return self._ceph_get_active_uri()
def get_localized_module_option(self, key, default=None):
r = self._ceph_get_module_option(key, self.get_mgr_id())
if r is None:
return self.MODULE_OPTION_DEFAULTS.get(key, default)
else:
return r
class MgrModule(ceph_module.BaseMgrModule, MgrModuleLoggingMixin):
COMMANDS = [] # type: List[Any]
MODULE_OPTIONS = [] # type: List[dict]
MODULE_OPTION_DEFAULTS = {} # type: Dict[str, Any]
# Priority definitions for perf counters
PRIO_CRITICAL = 10
PRIO_INTERESTING = 8
PRIO_USEFUL = 5
PRIO_UNINTERESTING = 2
PRIO_DEBUGONLY = 0
# counter value types
PERFCOUNTER_TIME = 1
PERFCOUNTER_U64 = 2
# counter types
PERFCOUNTER_LONGRUNAVG = 4
PERFCOUNTER_COUNTER = 8
PERFCOUNTER_HISTOGRAM = 0x10
PERFCOUNTER_TYPE_MASK = ~3
# units supported
BYTES = 0
NONE = 1
# Cluster log priorities
CLUSTER_LOG_PRIO_DEBUG = 0
CLUSTER_LOG_PRIO_INFO = 1
CLUSTER_LOG_PRIO_SEC = 2
CLUSTER_LOG_PRIO_WARN = 3
CLUSTER_LOG_PRIO_ERROR = 4
def __init__(self, module_name, py_modules_ptr, this_ptr):
self.module_name = module_name
super(MgrModule, self).__init__(py_modules_ptr, this_ptr)
for o in self.MODULE_OPTIONS:
if 'default' in o:
if 'type' in o:
# we'll assume the declared type matches the
# supplied default value's type.
self.MODULE_OPTION_DEFAULTS[o['name']] = o['default']
else:
# module not declaring it's type, so normalize the
# default value to be a string for consistent behavior
# with default and user-supplied option values.
self.MODULE_OPTION_DEFAULTS[o['name']] = str(o['default'])
mgr_level = self.get_ceph_option("debug_mgr")
log_level = self.get_module_option("log_level")
cluster_level = self.get_module_option('log_to_cluster_level')
log_to_file = self.get_module_option("log_to_file")
log_to_cluster = self.get_module_option("log_to_cluster")
self._configure_logging(mgr_level, log_level, cluster_level,
log_to_file, log_to_cluster)
# for backwards compatibility
self._logger = self.getLogger()
self._version = self._ceph_get_version()
self._perf_schema_cache = None
# Keep a librados instance for those that need it.
self._rados = None
def __del__(self):
self._unconfigure_logging()
@classmethod
def _register_options(cls, module_name):
cls.MODULE_OPTIONS.append(
Option(name='log_level', type='str', default="", runtime=True,
enum_allowed=['info', 'debug', 'critical', 'error',
'warning', '']))
cls.MODULE_OPTIONS.append(
Option(name='log_to_file', type='bool', default=False, runtime=True))
if not [x for x in cls.MODULE_OPTIONS if x['name'] == 'log_to_cluster']:
cls.MODULE_OPTIONS.append(
Option(name='log_to_cluster', type='bool', default=False,
runtime=True))
cls.MODULE_OPTIONS.append(
Option(name='log_to_cluster_level', type='str', default='info',
runtime=True,
enum_allowed=['info', 'debug', 'critical', 'error',
'warning', '']))
@classmethod
def _register_commands(cls, module_name):
cls.COMMANDS.extend(CLICommand.dump_cmd_list())
@property
def log(self):
return self._logger
def cluster_log(self, channel, priority, message):
"""
:param channel: The log channel. This can be 'cluster', 'audit', ...
:type channel: str
:param priority: The log message priority. This can be
CLUSTER_LOG_PRIO_DEBUG, CLUSTER_LOG_PRIO_INFO,
CLUSTER_LOG_PRIO_SEC, CLUSTER_LOG_PRIO_WARN or
CLUSTER_LOG_PRIO_ERROR.
:type priority: int
:param message: The message to log.
:type message: str
"""
self._ceph_cluster_log(channel, priority, message)
@property
def version(self):
return self._version
@property
def release_name(self):
"""
Get the release name of the Ceph version, e.g. 'nautilus' or 'octopus'.
:return: Returns the release name of the Ceph version in lower case.
:rtype: str
"""
return self._ceph_get_release_name()
def get_context(self):
"""
:return: a Python capsule containing a C++ CephContext pointer
"""
return self._ceph_get_context()
def notify(self, notify_type, notify_id):
"""
Called by the ceph-mgr service to notify the Python plugin
that new state is available.
:param notify_type: string indicating what kind of notification,
such as osd_map, mon_map, fs_map, mon_status,
health, pg_summary, command, service_map
:param notify_id: string (may be empty) that optionally specifies
which entity is being notified about. With
"command" notifications this is set to the tag
``from send_command``.
"""
pass
def _config_notify(self):
# check logging options for changes
mgr_level = self.get_ceph_option("debug_mgr")
module_level = self.get_module_option("log_level")
cluster_level = self.get_module_option("log_to_cluster_level")
log_to_file = self.get_module_option("log_to_file", False)
log_to_cluster = self.get_module_option("log_to_cluster", False)
self._set_log_level(mgr_level, module_level, cluster_level)
if log_to_file != self.log_to_file:
if log_to_file:
self._enable_file_log()
else:
self._disable_file_log()
if log_to_cluster != self.log_to_cluster:
if log_to_cluster:
self._enable_cluster_log()
else:
self._disable_cluster_log()
# call module subclass implementations
self.config_notify()
def config_notify(self):
"""
Called by the ceph-mgr service to notify the Python plugin
that the configuration may have changed. Modules will want to
refresh any configuration values stored in config variables.
"""
pass
def serve(self):
"""
Called by the ceph-mgr service to start any server that
is provided by this Python plugin. The implementation
of this function should block until ``shutdown`` is called.
You *must* implement ``shutdown`` if you implement ``serve``
"""
pass
def shutdown(self):
"""
Called by the ceph-mgr service to request that this
module drop out of its serve() function. You do not
need to implement this if you do not implement serve()
:return: None
"""
if self._rados:
addrs = self._rados.get_addrs()
self._rados.shutdown()
self._ceph_unregister_client(addrs)
def get(self, data_name):
"""
Called by the plugin to fetch named cluster-wide objects from ceph-mgr.
:param str data_name: Valid things to fetch are osd_crush_map_text,
osd_map, osd_map_tree, osd_map_crush, config, mon_map, fs_map,
osd_metadata, pg_summary, io_rate, pg_dump, df, osd_stats,
health, mon_status, devices, device <devid>, pg_stats,
pool_stats, pg_ready, osd_ping_times.
Note:
All these structures have their own JSON representations: experiment
or look at the C++ ``dump()`` methods to learn about them.
"""
return self._ceph_get(data_name)
def _stattype_to_str(self, stattype):
typeonly = stattype & self.PERFCOUNTER_TYPE_MASK
if typeonly == 0:
return 'gauge'
if typeonly == self.PERFCOUNTER_LONGRUNAVG:
# this lie matches the DaemonState decoding: only val, no counts
return 'counter'
if typeonly == self.PERFCOUNTER_COUNTER:
return 'counter'
if typeonly == self.PERFCOUNTER_HISTOGRAM:
return 'histogram'
return ''
def _perfpath_to_path_labels(self, daemon, path):
# type: (str, str) -> Tuple[str, Tuple[str, ...], Tuple[str, ...]]
label_names = ("ceph_daemon",) # type: Tuple[str, ...]
labels = (daemon,) # type: Tuple[str, ...]
if daemon.startswith('rbd-mirror.'):
match = re.match(
r'^rbd_mirror_image_([^/]+)/(?:(?:([^/]+)/)?)(.*)\.(replay(?:_bytes|_latency)?)$',
path
)
if match:
path = 'rbd_mirror_image_' + match.group(4)
pool = match.group(1)
namespace = match.group(2) or ''
image = match.group(3)
label_names += ('pool', 'namespace', 'image')
labels += (pool, namespace, image)
return path, label_names, labels,
def _perfvalue_to_value(self, stattype, value):
if stattype & self.PERFCOUNTER_TIME:
# Convert from ns to seconds
return value / 1000000000.0
else:
return value
def _unit_to_str(self, unit):
if unit == self.NONE:
return "/s"
elif unit == self.BYTES:
return "B/s"
@staticmethod
def to_pretty_iec(n):
for bits, suffix in [(60, 'Ei'), (50, 'Pi'), (40, 'Ti'), (30, 'Gi'),
(20, 'Mi'), (10, 'Ki')]:
if n > 10 << bits:
return str(n >> bits) + ' ' + suffix
return str(n) + ' '
@staticmethod
def get_pretty_row(elems, width):
"""
Takes an array of elements and returns a string with those elements
formatted as a table row. Useful for polling modules.
:param elems: the elements to be printed
:param width: the width of the terminal
"""
n = len(elems)
column_width = int(width / n)
ret = '|'
for elem in elems:
ret += '{0:>{w}} |'.format(elem, w=column_width - 2)
return ret
def get_pretty_header(self, elems, width):
"""
Like ``get_pretty_row`` but adds dashes, to be used as a table title.
:param elems: the elements to be printed
:param width: the width of the terminal
"""
n = len(elems)
column_width = int(width / n)