org.avaje.metric.elastic

Class ElasticReporterConfig

java.lang.Object

org.avaje.metric.elastic.ElasticReporterConfig

public class ElasticReporterConfig
extends Object

Configuration for pushing metrics to ElasticSearch.

Constructor Summary

Constructors

Constructor and Description
ElasticReporterConfig()

Method Summary

Modifier and Type	Method and Description
ElasticReporterConfig	addTag(String key, String value) Add a name value pair to include in each metric entry.
okhttp3.OkHttpClient	getClient() Return the client to use (If null one will be created).
int	getConnectTimeout() Return the connect timeout in seconds.
String	getIndexPrefix() Return the index name prefix (defaults to "metric-").
String	getIndexType() Return the index type (defaults to "metric").
String	getNameField() Return the name of the field that holds the metric name (defaults to "name").
int	getReadTimeout() Return the read timeout in seconds.
Map<String,String>	getTags() Return all the tags.
String	getTemplateName() Return the name of the elastic template (defaults to "metric-1").
String	getTimestampField() Return the name of the timestamp field (defaults to "ts").
String	getTypeField() Return the name of the metric type field (defaults to "type").
String	getUrl() Return the base url for the ElasticSearch instance.
int	getWriteTimeout() Return the write timeout in seconds.
ElasticReporterConfig	setClient(okhttp3.OkHttpClient client) Set the client to use (If not set one will be created).
ElasticReporterConfig	setConnectTimeout(int connectTimeout) Set the connect timeout in seconds.
ElasticReporterConfig	setIndexPrefix(String indexPrefix) Set the index name prefix (defaults to "metric-").
ElasticReporterConfig	setIndexType(String indexType) Set the index type.
ElasticReporterConfig	setNameField(String nameField) Set the name of the field that holds the metric name.
ElasticReporterConfig	setReadTimeout(int readTimeout) Set the read timeout in seconds.
ElasticReporterConfig	setTags(Map<String,String> tags)
void	setTemplateName(String templateName) Set the name of the Elastic template.
ElasticReporterConfig	setTimestampField(String timestampField) Set the name of the timestamp field.
ElasticReporterConfig	setTypeField(String typeField) Set the name of the metric type field (defaults to "type").
ElasticReporterConfig	setUrl(String url) Set the base url for the ElasticSearch instance.
ElasticReporterConfig	setWriteTimeout(int writeTimeout) Set the write timeout in seconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

ElasticReporterConfig

public ElasticReporterConfig()

Method Detail

getUrl

public String getUrl()

Return the base url for the ElasticSearch instance.

setUrl

public ElasticReporterConfig setUrl(String url)

Set the base url for the ElasticSearch instance.

getIndexType

public String getIndexType()

Return the index type (defaults to "metric").

setIndexType

public ElasticReporterConfig setIndexType(String indexType)

Set the index type.

getIndexPrefix

public String getIndexPrefix()

Return the index name prefix (defaults to "metric-").

setIndexPrefix

public ElasticReporterConfig setIndexPrefix(String indexPrefix)

Set the index name prefix (defaults to "metric-").

addTag

public ElasticReporterConfig addTag(String key,
                                    String value)

Add a name value pair to include in each metric entry.

getTags

public Map<String,String> getTags()

Return all the tags.

setTags

public ElasticReporterConfig setTags(Map<String,String> tags)

getTimestampField

public String getTimestampField()

Return the name of the timestamp field (defaults to "ts").

setTimestampField

public ElasticReporterConfig setTimestampField(String timestampField)

Set the name of the timestamp field.

getTypeField

public String getTypeField()

Return the name of the metric type field (defaults to "type").

setTypeField

public ElasticReporterConfig setTypeField(String typeField)

Set the name of the metric type field (defaults to "type").

getNameField

public String getNameField()

Return the name of the field that holds the metric name (defaults to "name").

setNameField

public ElasticReporterConfig setNameField(String nameField)

Set the name of the field that holds the metric name.

getTemplateName

public String getTemplateName()

Return the name of the elastic template (defaults to "metric-1").

setTemplateName

public void setTemplateName(String templateName)

Set the name of the Elastic template.

Set this to null means the template will not be checked and set on startup.

When changing this value you may want to add a template as a resource under the elastic-template path such that it is checked and set if it does not exist in ElasticSearch.

getConnectTimeout

public int getConnectTimeout()

Return the connect timeout in seconds.

setConnectTimeout

public ElasticReporterConfig setConnectTimeout(int connectTimeout)

Set the connect timeout in seconds.

getReadTimeout

public int getReadTimeout()

Return the read timeout in seconds.

setReadTimeout

public ElasticReporterConfig setReadTimeout(int readTimeout)

Set the read timeout in seconds.

getWriteTimeout

public int getWriteTimeout()

Return the write timeout in seconds.

setWriteTimeout

public ElasticReporterConfig setWriteTimeout(int writeTimeout)

Set the write timeout in seconds.

getClient

public okhttp3.OkHttpClient getClient()

Return the client to use (If null one will be created).

setClient

public ElasticReporterConfig setClient(okhttp3.OkHttpClient client)

Set the client to use (If not set one will be created).