fr.gouv.vitam.common.metrics

Class VitamElasticsearchReporter.Builder

java.lang.Object

fr.gouv.vitam.common.metrics.VitamElasticsearchReporter.Builder

Enclosing class:

VitamElasticsearchReporter

public static class VitamElasticsearchReporter.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
VitamElasticsearchReporter.Builder	additionalFields(Map<String,Object> additionalFields) Additional fields to be included for each metric
VitamElasticsearchReporter	build()
VitamElasticsearchReporter.Builder	bulkSize(int bulkSize) The bulk size per request, defaults to 2500 (as metrics are quite small)
VitamElasticsearchReporter.Builder	convertDurationsTo(TimeUnit durationUnit) Convert all the durations to a certain timeunit, defaults to milliseconds
VitamElasticsearchReporter.Builder	convertRatesTo(TimeUnit rateUnit) Convert all the rates to a certain timeunit, defaults to seconds
VitamElasticsearchReporter.Builder	filter(com.codahale.metrics.MetricFilter filter) Allows to configure a special MetricFilter, which defines what metrics are reported
VitamElasticsearchReporter.Builder	hosts(String... hosts) Configure an array of hosts to send data to.
VitamElasticsearchReporter.Builder	index(String index) The index name to index in
VitamElasticsearchReporter.Builder	indexDateFormat(String indexDateFormat) The index date format used for rolling indices This is appended to the index name, split by a '-'
VitamElasticsearchReporter.Builder	percolationFilter(com.codahale.metrics.MetricFilter percolationFilter) A metrics filter to define the metrics which should be used for percolation/notification
VitamElasticsearchReporter.Builder	percolationNotifier(org.elasticsearch.metrics.percolation.Notifier notifier) An instance of the notifier implemention which should be executed in case of a matching percolation
VitamElasticsearchReporter.Builder	prefixedWith(String prefix) Configure a prefix for each metric name.
VitamElasticsearchReporter.Builder	timeout(int timeout) The timeout to wait for until a connection attempt is and the next host is tried
VitamElasticsearchReporter.Builder	timestampFieldname(String fieldName) Configure the name of the timestamp field, defaults to '@timestamp'
VitamElasticsearchReporter.Builder	withClock(com.codahale.metrics.Clock clock) Inject your custom definition of how time passes.

Methods inherited from class java.lang.Object

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

Method Detail

withClock

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

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

prefixedWith

public VitamElasticsearchReporter.Builder prefixedWith(String prefix)

Configure a prefix for each metric name. Optional, but useful to identify single hosts

convertRatesTo

public VitamElasticsearchReporter.Builder convertRatesTo(TimeUnit rateUnit)

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

convertDurationsTo

public VitamElasticsearchReporter.Builder convertDurationsTo(TimeUnit durationUnit)

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

filter

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

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

hosts

public VitamElasticsearchReporter.Builder hosts(String... hosts)

Configure an array of hosts to send data to. Note: Data is always sent to only one host, but this makes sure, that even if a part of your elasticsearch cluster is not running, reporting still happens A host must be in the format hostname:port The port must be the HTTP port of your elasticsearch instance

timeout

public VitamElasticsearchReporter.Builder timeout(int timeout)

The timeout to wait for until a connection attempt is and the next host is tried

index

public VitamElasticsearchReporter.Builder index(String index)

The index name to index in

indexDateFormat

public VitamElasticsearchReporter.Builder indexDateFormat(String indexDateFormat)

The index date format used for rolling indices This is appended to the index name, split by a '-'

bulkSize

public VitamElasticsearchReporter.Builder bulkSize(int bulkSize)

The bulk size per request, defaults to 2500 (as metrics are quite small)

percolationFilter

public VitamElasticsearchReporter.Builder percolationFilter(com.codahale.metrics.MetricFilter percolationFilter)

A metrics filter to define the metrics which should be used for percolation/notification

percolationNotifier

public VitamElasticsearchReporter.Builder percolationNotifier(org.elasticsearch.metrics.percolation.Notifier notifier)

An instance of the notifier implemention which should be executed in case of a matching percolation

timestampFieldname

public VitamElasticsearchReporter.Builder timestampFieldname(String fieldName)

Configure the name of the timestamp field, defaults to '@timestamp'

additionalFields

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

Additional fields to be included for each metric

Parameters:

additionalFields -

Returns:

build

public VitamElasticsearchReporter build()
                                 throws IOException

Throws:

IOException