CodaHaleMetricsModule.Config (ratpack-codahale-metrics 0.9.14 API)

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.WebSocket`

Field Summary

Fields
Modifier and Type Field and Description

static java.time.Duration DEFAULT_INTERVAL

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

Constructor Summary

Constructors
Constructor and Description

Config()

Constructors
Constructor and Description
`Config()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CodaHaleMetricsModule.Config`	`console()`
`CodaHaleMetricsModule.Config`	`console(ratpack.func.Action<? super CodaHaleMetricsModule.Config.Console> configure)` Configure the console metrics publisher.
`CodaHaleMetricsModule.Config`	`csv(ratpack.func.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<CodaHaleMetricsModule.Config.Jmx>`	`getJmx()` Get the settings for the JMX metrics publisher.
`java.util.Optional<CodaHaleMetricsModule.Config.WebSocket>`	`getWebSocket()` Get the settings for the websockets metrics broadcaster.
`boolean`	`isJvmMetrics()` The state of jvm metrics collection.
`CodaHaleMetricsModule.Config`	`jmx()`
`CodaHaleMetricsModule.Config`	`jmx(ratpack.func.Action<? super CodaHaleMetricsModule.Config.Jmx> configure)` Configure the JMX metrics publisher.
`CodaHaleMetricsModule.Config`	`jvmMetrics(boolean jvmMetrics)` The state of JVM metrics reporting.
`CodaHaleMetricsModule.Config`	`webSocket()`
`CodaHaleMetricsModule.Config`	`webSocket(ratpack.func.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
  - 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(ratpack.func.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(ratpack.func.Action<? super CodaHaleMetricsModule.Config.Console> configure)
```
    Configure the console 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(ratpack.func.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(ratpack.func.Action<? super CodaHaleMetricsModule.Config.Csv> configure)
```
    Configure the csv metrics publisher.
    
    Parameters:
    
    configure - the configuration for the publisher
    
    Returns:
    
    this

Class CodaHaleMetricsModule.Config

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_INTERVAL

Constructor Detail

Config

Method Detail

isJvmMetrics

jvmMetrics

getJmx

jmx

jmx

getConsole

console

console

getWebSocket

webSocket

webSocket

getCsv

csv