org.springframework.boot.actuate.autoconfigure

Class MetricRepositoryAutoConfiguration

java.lang.Object

org.springframework.boot.actuate.autoconfigure.MetricRepositoryAutoConfiguration

@Configuration
public class MetricRepositoryAutoConfiguration
extends Object

Auto-configuration for metrics services. Creates user-facing GaugeService and CounterService instances, and also back end repositories to catch the data pumped into them.

An InMemoryMetricRepository is always created unless another MetricRepository is already provided by the user. In general, even if metric data needs to be stored and analysed remotely, it is recommended to use an in-memory repository to buffer metric updates locally. The values can be exported (e.g. on a periodic basis) using an Exporter, most implementations of which have optimizations for sending data to remote repositories.

If Spring Messaging is on the classpath a MessageChannel called "metricsChannel" is also created (unless one already exists) and all metric update events are published additionally as messages on that channel. Additional analysis or actions can be taken by clients subscribing to that channel.

In addition if Codahale's metrics library is on the classpath a MetricRegistry will be created and wired up to the counter and gauge services in addition to the basic repository. Users can create Codahale metrics by prefixing their metric names with the appropriate type (e.g. "histogram.*", "meter.*").

By default all metric updates go to all MetricWriter instances in the application context. To change this behaviour define your own metric writer bean called "primaryMetricWriter", mark it @Primary, and this one will receive all updates from the default counter and gauge services. Alternatively you can provide your own counter and gauge services and wire them to whichever writer you choose.

Author:

Dave Syer

See Also:

GaugeService, CounterService, MetricWriter, InMemoryMetricRepository, CodahaleMetricWriter, Exporter

Constructor Summary

Constructors

Constructor and Description
MetricRepositoryAutoConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
CounterService	counterService()
GaugeService	gaugeService()

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricRepositoryAutoConfiguration

public MetricRepositoryAutoConfiguration()

Method Detail

counterService

@Bean
@ConditionalOnMissingBean
public CounterService counterService()

gaugeService

@Bean
@ConditionalOnMissingBean
public GaugeService gaugeService()