--- /dev/null
+"""
+Telemetry module for ceph-mgr
+
+Collect statistics from Ceph cluster and send this back to the Ceph project
+when user has opted-in
+"""
+import errno
+import json
+import re
+import requests
+import uuid
+import time
+from datetime import datetime
+from threading import Event
+from collections import defaultdict
+
+from mgr_module import MgrModule
+
+
+class Module(MgrModule):
+ config = dict()
+
+ metadata_keys = [
+ "arch",
+ "ceph_version",
+ "os",
+ "cpu",
+ "kernel_description",
+ "kernel_version",
+ "distro_description",
+ "distro"
+ ]
+
+ OPTIONS = [
+ {
+ 'name': 'url',
+ 'default': 'https://telemetry.ceph.com/report'
+ },
+ {
+ 'name': 'enabled',
+ 'default': True
+ },
+ {
+ 'name': 'leaderboard',
+ 'default': False
+ },
+ {
+ 'name': 'description',
+ 'default': None
+ },
+ {
+ 'name': 'contact',
+ 'default': None
+ },
+ {
+ 'name': 'organization',
+ 'default': None
+ },
+ {
+ 'name': 'proxy',
+ 'default': None
+ },
+ {
+ 'name': 'interval',
+ 'default': 72
+ }
+ ]
+
+ COMMANDS = [
+ {
+ "cmd": "telemetry config-set name=key,type=CephString "
+ "name=value,type=CephString",
+ "desc": "Set a configuration value",
+ "perm": "rw"
+ },
+ {
+ "cmd": "telemetry config-show",
+ "desc": "Show current configuration",
+ "perm": "r"
+ },
+ {
+ "cmd": "telemetry send",
+ "desc": "Force sending data to Ceph telemetry",
+ "perm": "rw"
+ },
+ {
+ "cmd": "telemetry show",
+ "desc": "Show last report or report to be sent",
+ "perm": "r"
+ },
+ {
+ "cmd": "telemetry self-test",
+ "desc": "Perform a self-test",
+ "perm": "r"
+ }
+ ]
+
+ @property
+ def config_keys(self):
+ return dict((o['name'], o.get('default', None)) for o in self.OPTIONS)
+
+ def __init__(self, *args, **kwargs):
+ super(Module, self).__init__(*args, **kwargs)
+ self.event = Event()
+ self.run = False
+ self.last_upload = None
+ self.last_report = dict()
+ self.report_id = None
+
+ @staticmethod
+ def str_to_bool(string):
+ return str(string).lower() in ['true', 'yes', 'on']
+
+ @staticmethod
+ def is_valid_email(email):
+ regexp = "^.+@([?)[a-zA-Z0-9-.]+.([a-zA-Z]{2,3}|[0-9]{1,3})(]?))$"
+ try:
+ if len(email) <= 7 or len(email) > 255:
+ return False
+
+ if not re.match(regexp, email):
+ return False
+
+ return True
+ except:
+ pass
+
+ return False
+
+ @staticmethod
+ def parse_timestamp(timestamp):
+ return datetime.strptime(timestamp, '%Y-%m-%d %H:%M:%S.%f')
+
+ def set_config_option(self, option, value):
+ if option not in self.config_keys.keys():
+ raise RuntimeError('{0} is a unknown configuration '
+ 'option'.format(option))
+
+ if option == 'interval':
+ try:
+ value = int(value)
+ except (ValueError, TypeError):
+ raise RuntimeError('invalid interval. Please provide a valid '
+ 'integer')
+
+ if value < 24:
+ raise RuntimeError('interval should be set to at least 24 hours')
+
+ if option in ['leaderboard', 'enabled']:
+ value = self.str_to_bool(value)
+
+ if option == 'contact':
+ if value and not self.is_valid_email(value):
+ raise RuntimeError('%s is not a valid e-mail address as a '
+ 'contact', value)
+
+ if option in ['description', 'organization']:
+ if value and len(value) > 256:
+ raise RuntimeError('%s should be limited to 256 '
+ 'characters', option)
+
+ self.config[option] = value
+ return True
+
+ def init_module_config(self):
+ for key, default in self.config_keys.items():
+ self.set_config_option(key, self.get_config(key, default))
+
+ self.last_upload = self.get_config('last_upload', None)
+ if self.last_upload is not None:
+ self.last_upload = int(self.last_upload)
+
+ self.report_id = self.get_config('report_id', None)
+ if self.report_id is None:
+ self.report_id = str(uuid.uuid4())
+ self.set_config('report_id', self.report_id)
+
+ def gather_osd_metadata(self, osd_map):
+ keys = ["osd_objectstore", "rotational"]
+ keys += self.metadata_keys
+
+ metadata = dict()
+ for key in keys:
+ metadata[key] = defaultdict(int)
+
+ for osd in osd_map['osds']:
+ for k, v in self.get_metadata('osd', str(osd['osd'])).items():
+ if k not in keys:
+ continue
+
+ metadata[k][v] += 1
+
+ return metadata
+
+ def gather_mon_metadata(self, mon_map):
+ keys = list()
+ keys += self.metadata_keys
+
+ metadata = dict()
+ for key in keys:
+ metadata[key] = defaultdict(int)
+
+ for mon in mon_map['mons']:
+ for k, v in self.get_metadata('mon', mon['name']).items():
+ if k not in keys:
+ continue
+
+ metadata[k][v] += 1
+
+ return metadata
+
+ def compile_report(self):
+ report = {'leaderboard': False, 'report_version': 1}
+
+ if self.str_to_bool(self.config['leaderboard']):
+ report['leaderboard'] = True
+
+ for option in ['description', 'contact', 'organization']:
+ report[option] = self.config.get(option, None)
+
+ mon_map = self.get('mon_map')
+ osd_map = self.get('osd_map')
+ service_map = self.get('service_map')
+ fs_map = self.get('fs_map')
+ df = self.get('df')
+
+ report['report_id'] = self.report_id
+ report['created'] = self.parse_timestamp(mon_map['created']).isoformat()
+
+ report['mon'] = {
+ 'count': len(mon_map['mons']),
+ 'features': mon_map['features']
+ }
+
+ num_pg = 0
+ report['pools'] = list()
+ for pool in osd_map['pools']:
+ num_pg += pool['pg_num']
+ report['pools'].append(
+ {
+ 'pool': pool['pool'],
+ 'type': pool['type'],
+ 'pg_num': pool['pg_num'],
+ 'pgp_num': pool['pg_placement_num'],
+ 'size': pool['size'],
+ 'min_size': pool['min_size'],
+ 'crush_rule': pool['crush_rule']
+ }
+ )
+
+ report['osd'] = {
+ 'count': len(osd_map['osds']),
+ 'require_osd_release': osd_map['require_osd_release'],
+ 'require_min_compat_client': osd_map['require_min_compat_client']
+ }
+
+ report['fs'] = {
+ 'count': len(fs_map['filesystems'])
+ }
+
+ report['metadata'] = dict()
+ report['metadata']['osd'] = self.gather_osd_metadata(osd_map)
+ report['metadata']['mon'] = self.gather_mon_metadata(mon_map)
+
+ report['usage'] = {
+ 'pools': len(df['pools']),
+ 'pg_num:': num_pg,
+ 'total_objects': df['stats']['total_objects'],
+ 'total_used_bytes': df['stats']['total_used_bytes'],
+ 'total_bytes': df['stats']['total_bytes'],
+ 'total_avail_bytes': df['stats']['total_avail_bytes']
+ }
+
+ report['services'] = defaultdict(int)
+ for key, value in service_map['services'].items():
+ report['services'][key] += 1
+
+ return report
+
+ def send(self, report):
+ self.log.info('Upload report to: %s', self.config['url'])
+ proxies = dict()
+ if 'proxy' in self.config:
+ self.log.info('Using HTTP(S) proxy: %s', self.config['proxy'])
+ proxies['http'] = self.config['proxy']
+ proxies['https'] = self.config['proxy']
+
+ requests.put(url=self.config['url'], json=report, proxies=proxies)
+
+ def handle_command(self, command):
+ if command['prefix'] == 'telemetry config-show':
+ return 0, json.dumps(self.config), ''
+ elif command['prefix'] == 'telemetry config-set':
+ key = command['key']
+ value = command['value']
+ if not value:
+ return -errno.EINVAL, '', 'Value should not be empty or None'
+
+ self.log.debug('Setting configuration option %s to %s', key, value)
+ self.set_config_option(key, value)
+ self.set_config(key, value)
+ return 0, 'Configuration option {0} updated'.format(key), ''
+ elif command['prefix'] == 'telemetry send':
+ self.last_report = self.compile_report()
+ self.send(self.last_report)
+ return 0, 'Report send to {0}'.format(self.config['url']), ''
+ elif command['prefix'] == 'telemetry show':
+ report = self.last_report
+ if not report:
+ report = self.compile_report()
+ return 0, json.dumps(report), ''
+ elif command['prefix'] == 'telemetry self-test':
+ self.self_test()
+ return 0, 'Self-test succeeded', ''
+ else:
+ return (-errno.EINVAL, '',
+ "Command not found '{0}'".format(command['prefix']))
+
+ def self_test(self):
+ report = self.compile_report()
+ if len(report) == 0:
+ raise RuntimeError('Report is empty')
+
+ if 'report_id' not in report:
+ raise RuntimeError('report_id not found in report')
+
+ def shutdown(self):
+ self.run = False
+ self.event.set()
+
+ def serve(self):
+ self.init_module_config()
+ self.run = True
+
+ self.log.debug('Waiting for mgr to warm up')
+ self.event.wait(10)
+
+ while self.run:
+ if self.config['enabled']:
+ self.log.info('Not sending report until configured to do so')
+ self.event.wait(1800)
+ continue
+
+ now = int(time.time())
+ if not self.last_upload or (now - self.last_upload) > \
+ self.config['interval'] * 3600:
+ self.log.info('Compiling and sending report to %s',
+ self.config['url'])
+
+ try:
+ self.last_report = self.compile_report()
+ except:
+ self.log.exception('Exception while compiling report:')
+
+ try:
+ self.send(self.last_report)
+ self.last_upload = now
+ self.set_config('last_upload', str(now))
+ except:
+ self.log.exception('Exception while sending report:')
+ else:
+ self.log.info('Interval for sending new report has not expired')
+
+ sleep = 3600
+ self.log.debug('Sleeping for %d seconds', sleep)
+ self.event.wait(sleep)
+
+ def self_test(self):
+ self.compile_report()
+ return True
+
+ @staticmethod
+ def can_run():
+ return True, ''
projects / ceph.git / commitdiff