io.stargate.metrics.jersey

Class MetricsBinder

java.lang.Object

io.stargate.metrics.jersey.MetricsBinder

Direct Known Subclasses:

MetricsBinderWithTenantId

public class MetricsBinder
extends Object

Class that registers all the needed metric application listeners to the Jersey environment for a module.

By default it registers the:

1. Meter listener, that meters HTTP requests
2. Counter listener, that counts HTTP requests

Both listeners can be disabled by setting stargate.metrics.http_meter_listener.enabled or stargate.metrics.http_counter_listener.enabled to false.

Both listeners use default tag providers, module name and path parameters (if enabled). The meter listener adds HttpMeterTagsProvider in addition, that adds method, URI and status to the tags. The counter listener adds HttpCounterTagsProvider in addition, that adds only the exception tag.

Both of those providers extend on top of the HttpMetricsTagProvider that is passed as the constructor parameter to this class. However, each provider can ignore the global HttpMetricsTagProvider by setting stargate.metrics.http_meter_listener.ignore_http_tags_provider or stargate.metrics.http_counter_listener.ignore_http_tags_provider to true.

Constructor Summary

Constructors

Constructor and Description
MetricsBinder(Metrics metrics, HttpMetricsTagProvider httpMetricsTagProvider, String module) Default constructor with no non-APR URI regexes.
MetricsBinder(Metrics metrics, HttpMetricsTagProvider httpMetricsTagProvider, String module, Collection<String> nonApiUriRegexes) Default constructor.
MetricsBinder(Metrics metrics, HttpMetricsTagProvider httpMetricsTagProvider, String module, Collection<String> nonApiUriRegexes, MetricsListenerConfig meterListenerConfig, MetricsListenerConfig counterListenerConfig) Secondary constructor.

Method Summary

Modifier and Type	Method and Description
protected List<io.micrometer.jersey2.server.JerseyTagsProvider>	getCounterTagsProviders(MetricsListenerConfig config, Metrics metrics, HttpMetricsTagProvider httpMetricsTagProvider, String module, Collection<String> nonApiUriRegexes)
protected List<io.micrometer.jersey2.server.JerseyTagsProvider>	getDefaultTagsProvider(Metrics metrics, String module, Collection<String> nonApiUriRegexes)
protected List<io.micrometer.jersey2.server.JerseyTagsProvider>	getMeterTagsProviders(MetricsListenerConfig config, Metrics metrics, HttpMetricsTagProvider httpMetricsTagProvider, String module, Collection<String> nonApiUriRegexes)
void	register(io.dropwizard.jersey.setup.JerseyEnvironment jersey) Registers application listeners in the JerseyEnvironment, based on the meterListenerConfig and counterListenerConfig.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetricsBinder

public MetricsBinder(Metrics metrics,
                     HttpMetricsTagProvider httpMetricsTagProvider,
                     String module)

Default constructor with no non-APR URI regexes. Uses SystemPropsMetricsListenerConfig for metering and counting configuration.

Parameters:

metrics - Metrics instance.

httpMetricsTagProvider - Global HttpMetricsTagProvider registered in the OSGi

module - Module name

MetricsBinder

public MetricsBinder(Metrics metrics,
                     HttpMetricsTagProvider httpMetricsTagProvider,
                     String module,
                     Collection<String> nonApiUriRegexes)

Default constructor. Uses SystemPropsMetricsListenerConfig for metering and counting configuration.

Parameters:

metrics - Metrics instance.

httpMetricsTagProvider - Global HttpMetricsTagProvider registered in the OSGi

module - Module name

nonApiUriRegexes - List of regexes for URIs that should be tagged with #module-other tag.

MetricsBinder

public MetricsBinder(Metrics metrics,
                     HttpMetricsTagProvider httpMetricsTagProvider,
                     String module,
                     Collection<String> nonApiUriRegexes,
                     MetricsListenerConfig meterListenerConfig,
                     MetricsListenerConfig counterListenerConfig)

Secondary constructor.

Parameters:

metrics - Metrics instance.

httpMetricsTagProvider - Global HttpMetricsTagProvider registered in the OSGi

module - Module name

nonApiUriRegexes - List of regexes for URIs that should be tagged with #module-other tag.

meterListenerConfig - config for metering HTTP requests

counterListenerConfig - config for counting HTTP requests

Method Detail

register

public void register(io.dropwizard.jersey.setup.JerseyEnvironment jersey)

Registers application listeners in the JerseyEnvironment, based on the meterListenerConfig and counterListenerConfig.

Parameters:

jersey - JerseyEnvironment

getMeterTagsProviders

protected List<io.micrometer.jersey2.server.JerseyTagsProvider> getMeterTagsProviders(MetricsListenerConfig config,
                                                                                      Metrics metrics,
                                                                                      HttpMetricsTagProvider httpMetricsTagProvider,
                                                                                      String module,
                                                                                      Collection<String> nonApiUriRegexes)

getCounterTagsProviders

protected List<io.micrometer.jersey2.server.JerseyTagsProvider> getCounterTagsProviders(MetricsListenerConfig config,
                                                                                        Metrics metrics,
                                                                                        HttpMetricsTagProvider httpMetricsTagProvider,
                                                                                        String module,
                                                                                        Collection<String> nonApiUriRegexes)

getDefaultTagsProvider

protected List<io.micrometer.jersey2.server.JerseyTagsProvider> getDefaultTagsProvider(Metrics metrics,
                                                                                       String module,
                                                                                       Collection<String> nonApiUriRegexes)