cn.leancloud.filter.service.metrics

Interface MetricsService

public interface MetricsService

This is a SPI interface to create a MeterRegistry to generate metrics from filter-service. You can implement this interface as your requirements and provide the implementation under META-INF/services. Then filter-service will load your implementation by using ServiceLoader.

Method Summary

Modifier and Type	Method and Description
MeterRegistry	createMeterRegistry() Create a new MeterRegistry used by filter-service to generate metrics.
default void	start() A start hook called before filter-service start.
default void	stop() A stop hook called after filter-service is stopped.

Method Detail

start

default void start()
            throws Exception

A start hook called before filter-service start.

Throws:

Exception

createMeterRegistry

MeterRegistry createMeterRegistry()
                           throws Exception

Create a new MeterRegistry used by filter-service to generate metrics.

Returns:

a custom MeterRegistry which meet your requirements

Throws:

Exception

stop

default void stop()
           throws Exception

A stop hook called after filter-service is stopped.

Throws:

Exception