def inventory_ajax(env): """Backend endpoint for inventory table""" draw = int(request.args.get('draw', 0)) envs = environments() check_env(env, envs) headers, fact_names = inventory_facts() query = AndOperator() fact_query = OrOperator() fact_query.add([EqualsOperator("name", name) for name in fact_names]) query.add(fact_query) if env != '*': query.add(EqualsOperator("environment", env)) facts = puppetdb.facts(query=query) fact_data = {} for fact in facts: if fact.node not in fact_data: fact_data[fact.node] = {} fact_data[fact.node][fact.name] = fact.value total = len(fact_data) return render_template('inventory.json.tpl', draw=draw, total=total, total_filtered=total, fact_data=fact_data, columns=fact_names)
def facts(env): """Displays an alphabetical list of all facts currently known to PuppetDB. :param env: Serves no purpose for this function, only for consistency's sake :type env: :obj:`string` """ envs = environments() check_env(env, envs) facts = get_or_abort(puppetdb.fact_names) # we consider a column label to count for ~5 lines column_label_height = 5 # 1 label per different letter and up to 3 more labels for letters spanning # multiple columns. column_label_count = 3 + len(set(map(lambda fact: fact[0].upper(), facts))) break_size = (len(facts) + column_label_count * column_label_height) / 4.0 next_break = break_size facts_columns = [] facts_current_column = [] facts_current_letter = [] letter = None count = 0 for fact in facts: count += 1 if count > next_break: next_break += break_size if facts_current_letter: facts_current_column.append(facts_current_letter) if facts_current_column: facts_columns.append(facts_current_column) facts_current_column = [] facts_current_letter = [] letter = None if letter != fact[0].upper(): if facts_current_letter: facts_current_column.append(facts_current_letter) facts_current_letter = [] letter = fact[0].upper() count += column_label_height facts_current_letter.append(fact) if facts_current_letter: facts_current_column.append(facts_current_letter) if facts_current_column: facts_columns.append(facts_current_column) return render_template('facts.html', facts_columns=facts_columns, envs=envs, current_env=env)
def nodes(env): """Fetch all (active) nodes from PuppetDB and stream a table displaying those nodes. Downside of the streaming aproach is that since we've already sent our headers we can't abort the request if we detect an error. Because of this we'll end up with an empty table instead because of how yield_or_stop works. Once pagination is in place we can change this but we'll need to provide a search feature instead. :param env: Search for nodes in this (Catalog and Fact) environment :type env: :obj:`string` """ envs = environments() status_arg = request.args.get('status', '') check_env(env, envs) query = AndOperator() if env != '*': query.add(EqualsOperator("catalog_environment", env)) if status_arg in ['failed', 'changed', 'unchanged']: query.add(EqualsOperator('latest_report_status', status_arg)) elif status_arg == 'unreported': unreported = datetime.utcnow() unreported = (unreported - timedelta(hours=app.config['UNRESPONSIVE_HOURS'])) unreported = unreported.replace(microsecond=0).isoformat() unrep_query = OrOperator() unrep_query.add(NullOperator('report_timestamp', True)) unrep_query.add(LessEqualOperator('report_timestamp', unreported)) query.add(unrep_query) if len(query.operations) == 0: query = None nodelist = puppetdb.nodes( query=query, unreported=app.config['UNRESPONSIVE_HOURS'], with_status=True, with_event_numbers=app.config['WITH_EVENT_NUMBERS']) nodes = [] for node in yield_or_stop(nodelist): if status_arg: if node.status == status_arg: nodes.append(node) else: nodes.append(node) return Response( stream_with_context( stream_template('nodes.html', nodes=nodes, envs=envs, current_env=env)))
def catalogs_ajax(env, compare): """Server data to catalogs as JSON to Jquery datatables """ draw = int(request.args.get('draw', 0)) start = int(request.args.get('start', 0)) length = int(request.args.get('length', app.config['NORMAL_TABLE_COUNT'])) paging_args = {'limit': length, 'offset': start} search_arg = request.args.get('search[value]') order_column = int(request.args.get('order[0][column]', 0)) order_filter = CATALOGS_COLUMNS[order_column].get( 'filter', CATALOGS_COLUMNS[order_column]['attr']) order_dir = request.args.get('order[0][dir]', 'asc') order_args = '[{"field": "%s", "order": "%s"}]' % (order_filter, order_dir) envs = environments() check_env(env, envs) query = AndOperator() if env != '*': query.add(EqualsOperator("catalog_environment", env)) if search_arg: query.add(RegexOperator("certname", r"%s" % search_arg)) query.add(NullOperator("catalog_timestamp", False)) nodes = get_or_abort(puppetdb.nodes, query=query, include_total=True, order_by=order_args, **paging_args) catalog_list = [] total = None for node in nodes: if total is None: total = puppetdb.total catalog_list.append({ 'certname': node.name, 'catalog_timestamp': node.catalog_timestamp, 'form': compare, }) if total is None: total = 0 return render_template('catalogs.json.tpl', total=total, total_filtered=total, draw=draw, columns=CATALOGS_COLUMNS, catalogs=catalog_list, envs=envs, current_env=env)
def reports(env, node_name): """Query and Return JSON data to reports Jquery datatable :param env: Search for all reports in this environment :type env: :obj:`string` """ envs = environments() check_env(env, envs) return render_template('reports.html', envs=envs, current_env=env, node_name=node_name, columns=REPORTS_COLUMNS)
def inventory(env): """Fetch all (active) nodes from PuppetDB and stream a table displaying those nodes along with a set of facts about them. :param env: Search for facts in this environment :type env: :obj:`string` """ envs = environments() check_env(env, envs) headers, fact_names = inventory_facts() return render_template('inventory.html', envs=envs, current_env=env, fact_headers=headers)
def metric(env, metric): """Lists all information about the metric of the given name. :param env: While this parameter serves no function purpose it is required for the environments template block :type env: :obj:`string` """ envs = environments() check_env(env, envs) name = unquote(metric) metric = get_or_abort(puppetdb.metric, metric) return render_template('metric.html', name=name, metric=sorted(metric.items()), envs=envs, current_env=env)
def catalogs(env, compare): """Lists all nodes with a compiled catalog. :param env: Find the nodes with this catalog_environment value :type env: :obj:`string` """ envs = environments() check_env(env, envs) if not app.config['ENABLE_CATALOG']: log.warning('Access to catalog interface disabled by administrator') abort(403) return render_template('catalogs.html', compare=compare, columns=CATALOGS_COLUMNS, envs=envs, current_env=env)
def catalog_node(env, node_name): """Fetches from PuppetDB the compiled catalog of a given node. :param env: Find the catalog with this environment value :type env: :obj:`string` """ envs = environments() check_env(env, envs) if app.config['ENABLE_CATALOG']: catalog = get_or_abort(puppetdb.catalog, node=node_name) return render_template('catalog.html', catalog=catalog, envs=envs, current_env=env) else: log.warn('Access to catalog interface disabled by administrator') abort(403)
def metrics(env): """Lists all available metrics that PuppetDB is aware of. :param env: While this parameter serves no function purpose it is required for the environments template block :type env: :obj:`string` """ envs = environments() check_env(env, envs) # the list response is a dict in the format: # { # "domain1": { # "property1": { # ... # } # }, # "domain2": { # "property2": { # ... # } # } # } # The MBean names are the combination of the domain and the properties # with a ":" in between, example: # domain1:property1 # domain2:property2 # reference: https://jolokia.org/reference/html/protocol.html#list metrics_domains = get_or_abort(puppetdb.metric) metrics = [] # get all of the domains for domain in list(metrics_domains.keys()): # iterate over all of the properties in this domain properties = list(metrics_domains[domain].keys()) for prop in properties: # combine the current domain and each property with # a ":" in between metrics.append(domain + ':' + prop) return render_template('metrics.html', metrics=sorted(metrics), envs=envs, current_env=env)
def catalog_compare(env, compare, against): """Compares the catalog of one node, parameter compare, with that of with that of another node, parameter against. :param env: Ensure that the 2 catalogs are in the same environment :type env: :obj:`string` """ envs = environments() check_env(env, envs) if app.config['ENABLE_CATALOG']: compare_cat = get_or_abort(puppetdb.catalog, node=compare) against_cat = get_or_abort(puppetdb.catalog, node=against) return render_template('catalog_compare.html', compare=compare_cat, against=against_cat, envs=envs, current_env=env) else: log.warn('Access to catalog interface disabled by administrator') abort(403)
def fact(env, fact, value): """Fetches the specific fact(/value) from PuppetDB and displays per node for which this fact is known. :param env: Searches for facts in this environment :type env: :obj:`string` :param fact: Find all facts with this name :type fact: :obj:`string` :param value: Find all facts with this value :type value: :obj:`string` """ envs = environments() check_env(env, envs) render_graph = False if fact in app.config['GRAPH_FACTS'] and not value: render_graph = True value_json = value if value is not None: value_object = parse_python(value) if type(value_object) is str: value_json = value_object else: value_json = dumps(value_object) natural_time_delta_sort = False if fact in ["uptime"]: natural_time_delta_sort = True return render_template( 'fact.html', fact=fact, value=value, value_json=value_json, render_graph=render_graph, envs=envs, current_env=env, natural_time_delta_sort=natural_time_delta_sort )
def node(env, node_name): """Display a dashboard for a node showing as much data as we have on that node. This includes facts and reports but not Resources as that is too heavy to do within a single request. :param env: Ensure that the node, facts and reports are in this environment :type env: :obj:`string` """ envs = environments() check_env(env, envs) query = AndOperator() if env != '*': query.add(EqualsOperator("environment", env)) query.add(EqualsOperator("certname", node_name)) node = get_or_abort(puppetdb.node, node_name) return render_template('node.html', node=node, envs=envs, current_env=env, columns=REPORTS_COLUMNS[:2])
def reports_ajax(env, node_name): """Query and Return JSON data to reports Jquery datatable :param env: Search for all reports in this environment :type env: :obj:`string` """ draw = int(request.args.get('draw', 0)) start = int(request.args.get('start', 0)) length = int(request.args.get('length', app.config['NORMAL_TABLE_COUNT'])) paging_args = {'limit': length, 'offset': start} search_arg = request.args.get('search[value]') order_column = int(request.args.get('order[0][column]', 0)) order_filter = REPORTS_COLUMNS[order_column].get( 'filter', REPORTS_COLUMNS[order_column]['attr']) order_dir = request.args.get('order[0][dir]', 'desc') order_args = '[{"field": "%s", "order": "%s"}]' % (order_filter, order_dir) status_args = request.args.get('columns[1][search][value]', '').split('|') date_args = request.args.get('columns[0][search][value]', '') max_col = len(REPORTS_COLUMNS) for i in range(len(REPORTS_COLUMNS)): if request.args.get("columns[%s][data]" % i, None): max_col = i + 1 envs = environments() check_env(env, envs) reports_query = AndOperator() if env != '*': reports_query.add(EqualsOperator("environment", env)) if node_name: reports_query.add(EqualsOperator("certname", node_name)) if search_arg: search_query = OrOperator() search_query.add(RegexOperator("certname", r"%s" % search_arg)) search_query.add(RegexOperator("puppet_version", r"%s" % search_arg)) search_query.add( RegexOperator("configuration_version", r"%s" % search_arg)) reports_query.add(search_query) if date_args: dates = json.loads(date_args) if len(dates) > 0: date_query = AndOperator() if 'min' in dates: date_query.add(GreaterEqualOperator('end_time', dates['min'])) if 'max' in dates: date_query.add(LessEqualOperator('end_time', dates['max'])) reports_query.add(date_query) status_query = OrOperator() for status_arg in status_args: if status_arg in ['failed', 'changed', 'unchanged']: arg_query = AndOperator() arg_query.add(EqualsOperator('status', status_arg)) arg_query.add(EqualsOperator('noop', False)) status_query.add(arg_query) if status_arg == 'unchanged': arg_query = AndOperator() arg_query.add(EqualsOperator('noop', True)) arg_query.add(EqualsOperator('noop_pending', False)) status_query.add(arg_query) elif status_arg == 'noop': arg_query = AndOperator() arg_query.add(EqualsOperator('noop', True)) arg_query.add(EqualsOperator('noop_pending', True)) status_query.add(arg_query) if len(status_query.operations) == 0: if len(reports_query.operations) == 0: reports_query = None else: reports_query.add(status_query) if status_args[0] != 'none': reports = get_or_abort(puppetdb.reports, query=reports_query, order_by=order_args, include_total=True, **paging_args) reports, reports_events = tee(reports) total = None else: reports = [] reports_events = [] total = 0 # Convert metrics to relational dict metrics = {} for report in reports_events: if total is None: total = puppetdb.total metrics[report.hash_] = {} for m in report.metrics: if m['category'] not in metrics[report.hash_]: metrics[report.hash_][m['category']] = {} metrics[report.hash_][m['category']][m['name']] = m['value'] if total is None: total = 0 return render_template('reports.json.tpl', draw=draw, total=total, total_filtered=total, reports=reports, metrics=metrics, envs=envs, current_env=env, columns=REPORTS_COLUMNS[:max_col])
def report(env, node_name, report_id, show_error_as): """Displays a single report including all the events associated with that report and their status. The report_id may be the puppetdb's report hash or the configuration_version. This allows for better integration into puppet-hipchat. :param env: Search for reports in this environment :type env: :obj:`string` :param node_name: Find the reports whose certname match this value :type node_name: :obj:`string` :param report_id: The hash or the configuration_version of the desired report :type report_id: :obj:`string` :param show_error_as: 'friendly' or 'raw', the former means that messages will be show in a mode transformed for human-readability, the latter that the messages will be unchanged :param show_error_as: :obj:`string` """ envs = environments() check_env(env, envs) query = AndOperator() report_id_query = OrOperator() report_id_query.add(EqualsOperator("hash", report_id)) report_id_query.add(EqualsOperator("configuration_version", report_id)) if env != '*': query.add(EqualsOperator("environment", env)) query.add(EqualsOperator("certname", node_name)) query.add(report_id_query) reports = puppetdb.reports(query=query) try: report = next(reports) except StopIteration: abort(404) if show_error_as not in ['friendly', 'raw']: abort(404) report.version = commonmark.commonmark(report.version) events = [{ 'resource': f"{event.item['type']}[{event.item['title']}]", 'status': event.status, 'old': event.item['old'], 'new': event.item['new'], 'failed': event.failed, } for event in report.events()] logs = [ { 'timestamp': log['time'], 'level': log["level"], 'source': log['source'], 'tags': ', '.join(log['tags']), 'message': get_message(node_name, log, show_error_as), 'location': get_location(log), # this could be also done with a different rendered in DataTables, # - feel free to refactor it into that if you know how 'short_location': get_short_location(get_location(log)), } for log in report.logs ] return render_template('report.html', report=report, events=events, logs=logs, metrics=report.metrics, envs=envs, current_env=env, current_show_error_as=show_error_as)
def fact_ajax(env, node, fact, value): """Fetches the specific facts matching (node/fact/value) from PuppetDB and return a JSON table :param env: Searches for facts in this environment :type env: :obj:`string` :param node: Find all facts for this node :type node: :obj:`string` :param fact: Find all facts with this name :type fact: :obj:`string` :param value: Filter facts whose value is equal to this :type value: :obj:`string` """ draw = int(request.args.get('draw', 0)) envs = environments() check_env(env, envs) render_graph = False if fact in app.config['GRAPH_FACTS'] and value is None and node is None: render_graph = True query = AndOperator() if node is not None: query.add(EqualsOperator("certname", node)) if env != '*': query.add(EqualsOperator("environment", env)) if value is not None: # interpret the value as a proper type... value = parse_python(value) # ...to know if it should be quoted or not in the query to PuppetDB # (f.e. a string should, while a number should not) query.add(EqualsOperator('value', value)) # if we have not added any operations to the query, # then make it explicitly empty if len(query.operations) == 0: query = None facts = [f for f in get_or_abort( puppetdb.facts, name=fact, query=query)] total = len(facts) counts = {} json = { 'draw': draw, 'recordsTotal': total, 'recordsFiltered': total, 'data': []} for fact_h in facts: line = [] if fact is None: line.append(fact_h.name) if node is None: line.append('<a href="{0}">{1}</a>'.format( url_for('node', env=env, node_name=fact_h.node), fact_h.node)) if value is None: if isinstance(fact_h.value, str): # https://github.com/voxpupuli/puppetboard/issues/706 # Force quotes around string values # This lets plain int values that are stored as strings in the db # be findable when searched via the facts page value_for_url = '"' + quote_plus(fact_h.value) + '"' else: value_for_url = fact_h.value line.append('["{0}", {1}]'.format( url_for( 'fact', env=env, fact=fact_h.name, value=value_for_url), dumps(fact_h.value))) json['data'].append(line) if render_graph: if fact_h.value not in counts: counts[fact_h.value] = 0 counts[fact_h.value] += 1 if render_graph: json['chart'] = [ {"label": "{0}".format(k).replace('\n', ' '), "value": counts[k]} for k in sorted(counts, key=lambda k: counts[k], reverse=True)] return jsonify(json)
def index(env): """This view generates the index page and displays a set of metrics and latest reports on nodes fetched from PuppetDB. :param env: Search for nodes in this (Catalog and Fact) environment :type env: :obj:`string` """ envs = environments() metrics = { 'num_nodes': 0, 'num_resources': 0, 'avg_resources_node': 0, } if (env != app.config['DEFAULT_ENVIRONMENT']): check_env(env, envs) if env == '*': query = app.config['OVERVIEW_FILTER'] prefix = 'puppetlabs.puppetdb.population' num_nodes = get_or_abort(puppetdb.metric, f"{prefix}:name=num-nodes") num_resources = get_or_abort(puppetdb.metric, f"{prefix}:name=num-resources") metrics['num_nodes'] = num_nodes['Value'] metrics['num_resources'] = num_resources['Value'] try: # Compute our own average because avg_resources_node['Value'] # returns a string of the format "num_resources/num_nodes" # example: "1234/9" instead of doing the division itself. metrics['avg_resources_node'] = "{0:10.0f}".format( (num_resources['Value'] / num_nodes['Value'])) except ZeroDivisionError: metrics['avg_resources_node'] = 0 else: query = AndOperator() query.add(EqualsOperator('catalog_environment', env)) num_nodes_query = ExtractOperator() num_nodes_query.add_field(FunctionOperator('count')) num_nodes_query.add_query(query) if app.config['OVERVIEW_FILTER'] is not None: query.add(app.config['OVERVIEW_FILTER']) num_resources_query = ExtractOperator() num_resources_query.add_field(FunctionOperator('count')) num_resources_query.add_query(EqualsOperator("environment", env)) num_nodes = get_or_abort(puppetdb._query, 'nodes', query=num_nodes_query) num_resources = get_or_abort(puppetdb._query, 'resources', query=num_resources_query) metrics['num_nodes'] = num_nodes[0]['count'] metrics['num_resources'] = num_resources[0]['count'] try: metrics['avg_resources_node'] = "{0:10.0f}".format( (num_resources[0]['count'] / num_nodes[0]['count'])) except ZeroDivisionError: metrics['avg_resources_node'] = 0 nodes = get_or_abort(puppetdb.nodes, query=query, unreported=app.config['UNRESPONSIVE_HOURS'], with_status=True, with_event_numbers=app.config['WITH_EVENT_NUMBERS']) nodes_overview = [] stats = { 'changed': 0, 'unchanged': 0, 'failed': 0, 'unreported': 0, 'noop': 0, } for node in nodes: if node.status == 'unreported': stats['unreported'] += 1 elif node.status == 'changed': stats['changed'] += 1 elif node.status == 'failed': stats['failed'] += 1 elif node.status == 'noop': stats['noop'] += 1 else: stats['unchanged'] += 1 if node.status != 'unchanged': nodes_overview.append(node) return render_template( 'index.html', metrics=metrics, nodes=nodes_overview, stats=stats, envs=envs, current_env=env, )
def failures(env: str, show_error_as: str): nodes_query = AndOperator() nodes_query.add(EqualsOperator('latest_report_status', 'failed')) envs = environments() check_env(env, envs) if env != '*': nodes_query.add(EqualsOperator("catalog_environment", env)) if show_error_as not in ['friendly', 'raw']: abort(404) nodes = puppetdb.nodes( query=nodes_query, with_status=True, with_event_numbers=False, ) failures = [] for node in yield_or_stop(nodes): report_query = AndOperator() report_query.add(EqualsOperator('hash', node.latest_report_hash)) reports = puppetdb.reports( query=report_query, ) latest_failed_report = next(reports) source = None message = None for log in latest_failed_report.logs: if log['level'] not in ['info', 'notice', 'warning']: if log['source'] != 'Facter': source = log['source'] message = log['message'] break if source and message: if show_error_as == 'friendly': error = to_html(get_friendly_error(source, message, node.name)) else: error = get_raw_error(source, message) else: error = to_html(f'Node {node.name} is failing but we could not find the errors') failure = { 'certname': node.name, 'timestamp': node.report_timestamp, 'error': error, 'report_hash': node.latest_report_hash, } failures.append(failure) return Response(stream_with_context( stream_template('failures.html', failures=failures, envs=envs, current_env=env, current_show_error_as=show_error_as)))