org.hawkular.metrics.dropwizard

Class HawkularReporterBuilder

java.lang.Object

org.hawkular.metrics.dropwizard.HawkularReporterBuilder

public class HawkularReporterBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
HawkularReporterBuilder(com.codahale.metrics.MetricRegistry registry, String tenant) Create a new builder for an HawkularReporter

Method Summary

Modifier and Type	Method and Description
HawkularReporterBuilder	addGlobalTag(String key, String value) Set a global tag.
HawkularReporterBuilder	addHeader(String key, String value) Add a custom header to Hawkular HTTP connections
HawkularReporterBuilder	addMetricTag(String metric, String key, String value) Set a tag on a given metric name
HawkularReporterBuilder	addRegexTag(Pattern pattern, String key, String value) Set a tag on metrics matching this regex
HawkularReporterBuilder	basicAuth(String username, String password) Set username and password for basic HTTP authentication
HawkularReporterBuilder	bearerToken(String token) Set the bearer token for the Authorization header in Hawkular HTTP connections.
HawkularReporter	build() Build the HawkularReporter
HawkularReporterBuilder	convertDurationsTo(TimeUnit durationUnit) Set dropwizard duration conversion
HawkularReporterBuilder	convertRatesTo(TimeUnit rateUnit) Set dropwizard rates conversion
HawkularReporterBuilder	disableTagComposition() Disable auto-tagging composed metrics.
HawkularReporterBuilder	failoverCacheDuration(long milliseconds) Set the failover cache duration (in milliseconds) This cache is used to store post attempts in memory when the hawkular server cannot be reached Default duration is 10 minutes
HawkularReporterBuilder	failoverCacheDurationInHours(long hours) Set the failover cache duration, in hours This cache is used to store post attempts in memory when the hawkular server cannot be reached Default duration is 10 minutes
HawkularReporterBuilder	failoverCacheDurationInMinutes(long minutes) Set the failover cache duration, in minutes This cache is used to store post attempts in memory when the hawkular server cannot be reached Default duration is 10 minutes
HawkularReporterBuilder	failoverCacheMaxSize(int reqs) Set the failover cache maximum size, in number of requests This cache is used to store post attempts in memory when the hawkular server cannot be reached By default this parameter is unset, which means there's no maximum
HawkularReporterBuilder	filter(com.codahale.metrics.MetricFilter filter) Configure a special MetricFilter, which defines what metrics are reported
HawkularReporterBuilder	globalTags(Map<String,String> tags) Set all global tags at once.
HawkularReporterBuilder	metricComposition(Map<String,Collection<String>> conversions) Set all metrics composition at once.
HawkularReporterBuilder	perMetricTags(Map<String,Map<String,String>> tags) Set all per-metric tags at once.
HawkularReporterBuilder	prefixedWith(String prefix) Configure a prefix for each metric name.
HawkularReporterBuilder	setMetricComposition(String metric, Collection<String> parts) Set composing parts for a given metric name
HawkularReporterBuilder	setRegexMetricComposition(Pattern pattern, Collection<String> parts) Set composing parts for metrics matching this regex
HawkularReporterBuilder	uri(String uri) Set the URI for the Hawkular connection.
HawkularReporterBuilder	useHttpClient(Function<String,HawkularHttpClient> httpClientProvider) Use a custom HawkularHttpClient
HawkularReporterBuilder	withNullableConfig(HawkularReporterConfig config) This is a shortcut function to use with automatically populated pojos such as coming from yaml config

Methods inherited from class java.lang.Object

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

Constructor Detail

HawkularReporterBuilder

public HawkularReporterBuilder(com.codahale.metrics.MetricRegistry registry,
                               String tenant)

Create a new builder for an HawkularReporter

Parameters:

registry - the Dropwizard Metrics registry

tenant - the Hawkular tenant ID

Method Detail

withNullableConfig

public HawkularReporterBuilder withNullableConfig(HawkularReporterConfig config)

This is a shortcut function to use with automatically populated pojos such as coming from yaml config

uri

public HawkularReporterBuilder uri(String uri)

Set the URI for the Hawkular connection. Default URI is http://localhost:8080

Parameters:

uri - base uri - do not include Hawkular Metrics path (/hawkular/metrics)

basicAuth

public HawkularReporterBuilder basicAuth(String username,
                                         String password)

Set username and password for basic HTTP authentication

Parameters:

username - basic auth. username

password - basic auth. password

bearerToken

public HawkularReporterBuilder bearerToken(String token)

Set the bearer token for the Authorization header in Hawkular HTTP connections. Can be used, for instance, for OpenShift connections

Parameters:

token - the bearer token

addHeader

public HawkularReporterBuilder addHeader(String key,
                                         String value)

Add a custom header to Hawkular HTTP connections

Parameters:

key - header name

value - header value

prefixedWith

public HawkularReporterBuilder prefixedWith(String prefix)

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

filter

public HawkularReporterBuilder filter(com.codahale.metrics.MetricFilter filter)

Configure a special MetricFilter, which defines what metrics are reported

convertRatesTo

public HawkularReporterBuilder convertRatesTo(TimeUnit rateUnit)

Set dropwizard rates conversion

convertDurationsTo

public HawkularReporterBuilder convertDurationsTo(TimeUnit durationUnit)

Set dropwizard duration conversion

globalTags

public HawkularReporterBuilder globalTags(Map<String,String> tags)

Set all global tags at once. All metrics generated by this reporter instance will be tagged as such. It overrides any global tag that was already set.

Parameters:

tags - global tags

addGlobalTag

public HawkularReporterBuilder addGlobalTag(String key,
                                            String value)

Set a global tag. All metrics generated by this reporter instance will be tagged as such.

Parameters:

key - tag key

value - tag value

perMetricTags

public HawkularReporterBuilder perMetricTags(Map<String,Map<String,String>> tags)

Set all per-metric tags at once. It overrides any per-metric tag that was already set.

Parameters:

tags - per-metric tags

addMetricTag

public HawkularReporterBuilder addMetricTag(String metric,
                                            String key,
                                            String value)

Set a tag on a given metric name

Parameters:

metric - the metric name

key - tag key

value - tag value

addRegexTag

public HawkularReporterBuilder addRegexTag(Pattern pattern,
                                           String key,
                                           String value)

Set a tag on metrics matching this regex

Parameters:

pattern - the regex pattern

key - tag key

value - tag value

disableTagComposition

public HawkularReporterBuilder disableTagComposition()

Disable auto-tagging composed metrics. By default, it is enabled.
When enabled, some metric types such as Meters or Timers will automatically generate additional information as tags. For instance, a Meter metric will generate a tag "meter:5minrt" on its 5-minutes-rate component.

metricComposition

public HawkularReporterBuilder metricComposition(Map<String,Collection<String>> conversions)

Set all metrics composition at once. It overrides any per-metric composition that was already set.

Parameters:

conversions - per-metric composition

setMetricComposition

public HawkularReporterBuilder setMetricComposition(String metric,
                                                    Collection<String> parts)

Set composing parts for a given metric name

Parameters:

metric - the metric name

parts - metric composed parts (such as "1minrt", "mean", "99perc", etc. - see project documentation)

setRegexMetricComposition

public HawkularReporterBuilder setRegexMetricComposition(Pattern pattern,
                                                         Collection<String> parts)

Set composing parts for metrics matching this regex

Parameters:

pattern - the regex pattern

parts - metric composed parts (such as "1minrt", "mean", "99perc", etc. - see project documentation)

failoverCacheDuration

public HawkularReporterBuilder failoverCacheDuration(long milliseconds)

Set the failover cache duration (in milliseconds)
This cache is used to store post attempts in memory when the hawkular server cannot be reached
Default duration is 10 minutes

Parameters:

milliseconds - number of milliseconds before eviction

failoverCacheDurationInMinutes

public HawkularReporterBuilder failoverCacheDurationInMinutes(long minutes)

Set the failover cache duration, in minutes
This cache is used to store post attempts in memory when the hawkular server cannot be reached
Default duration is 10 minutes

Parameters:

minutes - number of minutes before eviction

failoverCacheDurationInHours

public HawkularReporterBuilder failoverCacheDurationInHours(long hours)

Set the failover cache duration, in hours
This cache is used to store post attempts in memory when the hawkular server cannot be reached
Default duration is 10 minutes

Parameters:

hours - number of hours before eviction

failoverCacheMaxSize

public HawkularReporterBuilder failoverCacheMaxSize(int reqs)

Set the failover cache maximum size, in number of requests
This cache is used to store post attempts in memory when the hawkular server cannot be reached
By default this parameter is unset, which means there's no maximum

Parameters:

reqs - max number of requests to store

useHttpClient

public HawkularReporterBuilder useHttpClient(Function<String,HawkularHttpClient> httpClientProvider)

Use a custom HawkularHttpClient

Parameters:

httpClientProvider - function that provides a custom HawkularHttpClient from input URI as String

build

public HawkularReporter build()

Build the HawkularReporter