mycroft.metrics Namespace Reference

Classes
class	MetricsAggregator
class	MetricsPublisher
class	Stopwatch

Functions
def	report_metric (name, data)
def	report_timing (ident, system, timing, additional_data=None)

Function Documentation

def mycroft.metrics.report_metric	(		name,
			data
	)

Report a general metric to the Mycroft servers

Args:
    name (str): Name of metric. Must use only letters and hyphens
    data (dict): JSON dictionary to report. Must be valid JSON

Definition at line 29 of file scripts/mycroft/metrics/__init__.py.

def mycroft.metrics.report_timing	(		ident,
			system,
			timing,
			additional_data = None
	)

    Create standardized message for reporting timing.

    ident (str):            identifier of user interaction
    system (str):           system the that's generated the report
    timing (stopwatch):     Stopwatch object with recorded timing
    additional_data (dict): dictionary with related data

Definition at line 45 of file scripts/mycroft/metrics/__init__.py.