io.github.aparnachaudhary.metrics

Class MongoDBReporter.Builder

java.lang.Object

io.github.aparnachaudhary.metrics.MongoDBReporter.Builder

Enclosing class:

MongoDBReporter

public static class MongoDBReporter.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
MongoDBReporter.Builder	additionalFields(Map<String,Object> additionalFields) Additional fields to be included for each metric
MongoDBReporter	build()
MongoDBReporter.Builder	convertDurationsTo(TimeUnit durationUnit) Convert all the durations to a certain TimeUnit, defaults to milliseconds
MongoDBReporter.Builder	convertRatesTo(TimeUnit rateUnit) Convert all the rates to a certain TimeUnit, defaults to seconds
MongoDBReporter.Builder	filter(com.codahale.metrics.MetricFilter filter) Allows to configure a special MetricFilter, which defines what metrics are reported
MongoDBReporter.Builder	mongoClientOptions(com.mongodb.MongoClientOptions mongoClientOptions)
MongoDBReporter.Builder	mongoCredentials(com.mongodb.MongoCredential[] mongoCredentials)
MongoDBReporter.Builder	prefixedWith(String prefix) Configure a prefix for each metric name.
MongoDBReporter.Builder	serverAddresses(com.mongodb.ServerAddress[] serverAddresses)
MongoDBReporter.Builder	withClock(com.codahale.metrics.Clock clock) Inject your custom definition of how time passes.
MongoDBReporter.Builder	withDatabaseName(String databaseName)

Methods inherited from class java.lang.Object

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

Method Detail

withClock

public MongoDBReporter.Builder withClock(com.codahale.metrics.Clock clock)

Inject your custom definition of how time passes. Usually the default clock is sufficient.

Parameters:

clock - clock

Returns:

Builder

prefixedWith

public MongoDBReporter.Builder prefixedWith(String prefix)

Configure a prefix for each metric name. Optional, but useful to identify originator of metric

Parameters:

prefix - prefix for metric name

Returns:

Builder

convertRatesTo

public MongoDBReporter.Builder convertRatesTo(TimeUnit rateUnit)

Convert all the rates to a certain TimeUnit, defaults to seconds

Parameters:

rateUnit - unit of rate

Returns:

Builder

convertDurationsTo

public MongoDBReporter.Builder convertDurationsTo(TimeUnit durationUnit)

Convert all the durations to a certain TimeUnit, defaults to milliseconds

Parameters:

durationUnit - unit of duration

Returns:

Builder

filter

public MongoDBReporter.Builder filter(com.codahale.metrics.MetricFilter filter)

Allows to configure a special MetricFilter, which defines what metrics are reported

Parameters:

filter - metrics filter

Returns:

Builder

withDatabaseName

public MongoDBReporter.Builder withDatabaseName(String databaseName)

serverAddresses

public MongoDBReporter.Builder serverAddresses(com.mongodb.ServerAddress[] serverAddresses)

mongoClientOptions

public MongoDBReporter.Builder mongoClientOptions(com.mongodb.MongoClientOptions mongoClientOptions)

mongoCredentials

public MongoDBReporter.Builder mongoCredentials(com.mongodb.MongoCredential[] mongoCredentials)

additionalFields

public MongoDBReporter.Builder additionalFields(Map<String,Object> additionalFields)

Additional fields to be included for each metric

Parameters:

additionalFields - custom fields for reporting

Returns:

Builder

build

public MongoDBReporter build()