gigl.common.metrics.decorators#

Attributes#

`F`
`logger`

Classes#

TimerRecordGranularity

Generic enumeration.

Functions#

`flushes_metrics`(get_metrics_service_instance_fn)	Decorator for flushing metrics after function execution.
`profileit`(metric_name, get_metrics_service_instance_fn)	performance profiling decorator

Module Contents#

class gigl.common.metrics.decorators.TimerRecordGranularity[source]#

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

MILLISECONDS = 'ms'[source]#

SECONDS = 's'[source]#

gigl.common.metrics.decorators.flushes_metrics(get_metrics_service_instance_fn)[source]#

Decorator for flushing metrics after function execution. Always catches any raised exceptions by decorated function and flushes metrics before reraising the exception. :return: wrapped result

Parameters:: get_metrics_service_instance_fn (Optional[Callable[[], Optional[gigl.common.metrics.metrics_interface.OpsMetricPublisher]]])
Return type:: Callable[[F], F]

gigl.common.metrics.decorators.profileit(metric_name, get_metrics_service_instance_fn, record_granularity=TimerRecordGranularity.SECONDS)[source]#

performance profiling decorator :param name: name of block being profiled :return: wrapped result

Parameters:

metric_name (str)
get_metrics_service_instance_fn (Optional[Callable[[], Optional[gigl.common.metrics.metrics_interface.OpsMetricPublisher]]])
record_granularity (TimerRecordGranularity)

Return type:

Callable[[F], F]

gigl.common.metrics.decorators.F[source]#

gigl.common.metrics.decorators.logger[source]#