gigl.common.metrics.metrics_interface

Classes

OpsMetricPublisher

Interface to implement to publish metrics to some monitoring system.

Module Contents

class gigl.common.metrics.metrics_interface.OpsMetricPublisher

Bases: abc.ABC

Interface to implement to publish metrics to some monitoring system.

To publish metrics to a monitoring system, you need to implement a class with this interface and expose the class path in the task config file: ``` metrics_config:

metrics_cls_path: “path.to.the.class.that.implements.OpsMetricPublisher”

```

abstract add_count(metric_name, count)

Parameters:

• metric_name (str)

• count (int)

abstract add_gauge(metric_name, gauge)

Parameters:

• metric_name (str)

• gauge (float)

abstract add_level(metric_name, level)

Parameters:

• metric_name (str)

• level (int)

abstract add_timer(metric_name, timer)

Parameters:

• metric_name (str)

• timer (int)

abstract flush_metrics()