ratpack.codahale.metrics

Class CodaHaleMetricsModule.Config

java.lang.Object

ratpack.codahale.metrics.CodaHaleMetricsModule.Config

Enclosing class:

CodaHaleMetricsModule

public static class CodaHaleMetricsModule.Config
extends java.lang.Object

The configuration object for CodaHaleMetricsModule.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CodaHaleMetricsModule.Config.Console
static class	CodaHaleMetricsModule.Config.Csv
static class	CodaHaleMetricsModule.Config.Jmx
static class	CodaHaleMetricsModule.Config.Slf4j
static class	CodaHaleMetricsModule.Config.WebSocket

Field Summary

Fields

Modifier and Type	Field and Description
static java.time.Duration	DEFAULT_INTERVAL

Constructor Summary

Constructors

Constructor and Description
Config()

Method Summary

Modifier and Type	Method and Description
CodaHaleMetricsModule.Config	console()
CodaHaleMetricsModule.Config	console(Action<? super CodaHaleMetricsModule.Config.Console> configure) Configure the console metrics publisher.
CodaHaleMetricsModule.Config	csv(Action<? super CodaHaleMetricsModule.Config.Csv> configure) Configure the csv metrics publisher.
java.util.Optional<CodaHaleMetricsModule.Config.Console>	getConsole() Get the settings for the console metrics publisher.
java.util.Optional<CodaHaleMetricsModule.Config.Csv>	getCsv() Get the settings for the csv metrics publisher.
java.util.Optional<Graphite>	getGraphite() Get the settings for the Graphite metrics publisher.
java.util.Optional<CodaHaleMetricsModule.Config.Jmx>	getJmx() Get the settings for the JMX metrics publisher.
java.util.Map<java.lang.String,java.lang.String>	getRequestMetricGroups() A map of regular expressions used to group request metrics.
java.util.Optional<CodaHaleMetricsModule.Config.Slf4j>	getSlf4j() Get the settings for the Slf4j Logger metrics publisher.
java.util.Optional<CodaHaleMetricsModule.Config.WebSocket>	getWebSocket() Get the settings for the websockets metrics broadcaster.
CodaHaleMetricsModule.Config	graphite(Action<? super Graphite> configure) Configure the Graphite metrics publisher.
boolean	isJvmMetrics() The state of jvm metrics collection.
CodaHaleMetricsModule.Config	jmx()
CodaHaleMetricsModule.Config	jmx(Action<? super CodaHaleMetricsModule.Config.Jmx> configure) Configure the JMX metrics publisher.
CodaHaleMetricsModule.Config	jvmMetrics(boolean jvmMetrics) The state of JVM metrics reporting.
CodaHaleMetricsModule.Config	requestMetricGroups(java.util.Map<java.lang.String,java.lang.String> requestMetricGroups) Configure the request metric groups
CodaHaleMetricsModule.Config	slf4j()
CodaHaleMetricsModule.Config	slf4j(Action<? super CodaHaleMetricsModule.Config.Slf4j> configure) Configure the Slf4j logger metrics publisher.
CodaHaleMetricsModule.Config	webSocket()
CodaHaleMetricsModule.Config	webSocket(Action<? super CodaHaleMetricsModule.Config.WebSocket> configure) Configure the websockets metrics broadcaster.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INTERVAL

public static final java.time.Duration DEFAULT_INTERVAL

Constructor Detail

Config

public Config()

Method Detail

isJvmMetrics

public boolean isJvmMetrics()

The state of jvm metrics collection.

Returns:

True if jvm metrics collection is enabled. False otherwise

jvmMetrics

public CodaHaleMetricsModule.Config jvmMetrics(boolean jvmMetrics)

The state of JVM metrics reporting.

Parameters:

jvmMetrics - True is JVM metrics are report. False otherwise

Returns:

this

getRequestMetricGroups

public java.util.Map<java.lang.String,java.lang.String> getRequestMetricGroups()

A map of regular expressions used to group request metrics.

The value is a regular expression to test the current request path against for a match. If matched, the key is the name to use when recording the metric. Please note that request paths do not start with a /

As soon as a match is made against a regular expression no further matches are attempted.

Should no matches be made the default metric grouping will be used.

Returns:

the request metric group expressions

See Also:

RequestTimingHandler

requestMetricGroups

public CodaHaleMetricsModule.Config requestMetricGroups(java.util.Map<java.lang.String,java.lang.String> requestMetricGroups)

Configure the request metric groups

Parameters:

requestMetricGroups - the request metric groups

Returns:

this

getJmx

public java.util.Optional<CodaHaleMetricsModule.Config.Jmx> getJmx()

Get the settings for the JMX metrics publisher.

Returns:

the jmx publisher settings

jmx

public CodaHaleMetricsModule.Config jmx()

Returns:

this

See Also:

jmx(ratpack.func.Action)

jmx

public CodaHaleMetricsModule.Config jmx(Action<? super CodaHaleMetricsModule.Config.Jmx> configure)

Configure the JMX metrics publisher.

Parameters:

configure - the configuration for the publisher

Returns:

this

getConsole

public java.util.Optional<CodaHaleMetricsModule.Config.Console> getConsole()

Get the settings for the console metrics publisher.

Returns:

the console publisher settings

console

public CodaHaleMetricsModule.Config console()

Returns:

this

See Also:

console(ratpack.func.Action)

console

public CodaHaleMetricsModule.Config console(Action<? super CodaHaleMetricsModule.Config.Console> configure)

Configure the console metrics publisher.

Parameters:

configure - the configuration for the publisher

Returns:

this

getSlf4j

public java.util.Optional<CodaHaleMetricsModule.Config.Slf4j> getSlf4j()

Get the settings for the Slf4j Logger metrics publisher.

Returns:

the slf4j publisher settings

slf4j

public CodaHaleMetricsModule.Config slf4j()

Returns:

this

See Also:

slf4j(ratpack.func.Action)

slf4j

public CodaHaleMetricsModule.Config slf4j(Action<? super CodaHaleMetricsModule.Config.Slf4j> configure)

Configure the Slf4j logger metrics publisher.

Parameters:

configure - the configuration for the publisher

Returns:

this

getWebSocket

public java.util.Optional<CodaHaleMetricsModule.Config.WebSocket> getWebSocket()

Get the settings for the websockets metrics broadcaster.

Returns:

the websockets broadcaster settings

webSocket

public CodaHaleMetricsModule.Config webSocket()

Returns:

this

See Also:

webSocket(ratpack.func.Action)

webSocket

public CodaHaleMetricsModule.Config webSocket(Action<? super CodaHaleMetricsModule.Config.WebSocket> configure)

Configure the websockets metrics broadcaster.

Parameters:

configure - the configuration for the broadcaster

Returns:

this

getCsv

public java.util.Optional<CodaHaleMetricsModule.Config.Csv> getCsv()

Get the settings for the csv metrics publisher.

Returns:

the csv publisher settings

csv

public CodaHaleMetricsModule.Config csv(Action<? super CodaHaleMetricsModule.Config.Csv> configure)

Configure the csv metrics publisher.

Parameters:

configure - the configuration for the publisher

Returns:

this

getGraphite

public java.util.Optional<Graphite> getGraphite()

Get the settings for the Graphite metrics publisher.

Returns:

the Graphite publisher settings

graphite

public CodaHaleMetricsModule.Config graphite(Action<? super Graphite> configure)

Configure the Graphite metrics publisher.

Parameters:

configure - the configuration for the publisher

Returns:

this