Package io.micrometer.elastic
Interface ElasticConfig
-
- All Superinterfaces:
io.micrometer.core.instrument.config.MeterRegistryConfig
,io.micrometer.core.instrument.push.PushRegistryConfig
,io.micrometer.core.instrument.step.StepRegistryConfig
public interface ElasticConfig extends io.micrometer.core.instrument.step.StepRegistryConfig
Configuration forElasticMeterRegistry
.- Since:
- 1.1.0
-
-
Field Summary
Fields Modifier and Type Field Description static ElasticConfig
DEFAULT
Accept configuration defaults
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default boolean
autoCreateIndex()
Whether to create the index automatically if it doesn't exist.java.lang.String
get(java.lang.String key)
Get the value associated with a key.default java.lang.String
host()
The host to send metrics to.default java.lang.String
index()
The index name to write metrics to.default java.lang.String
indexDateFormat()
The index date format used for rolling indices.default java.lang.String
indexDateSeparator()
The separator between the index name and the date part.default java.lang.String
password()
The Basic Authentication password.default java.lang.String
pipeline()
The ingest pipeline name.default java.lang.String
prefix()
Property prefix to prepend to configuration names.default java.lang.String
timestampFieldName()
The name of the timestamp field.default java.lang.String
userName()
The Basic Authentication username.
-
-
-
Field Detail
-
DEFAULT
static final ElasticConfig DEFAULT
Accept configuration defaults
-
-
Method Detail
-
get
java.lang.String get(java.lang.String key)
Get the value associated with a key.- Specified by:
get
in interfaceio.micrometer.core.instrument.config.MeterRegistryConfig
- Parameters:
key
- Key to look up in the config.- Returns:
- Value for the key or null if no key is present.
-
prefix
default java.lang.String prefix()
Property prefix to prepend to configuration names.- Specified by:
prefix
in interfaceio.micrometer.core.instrument.config.MeterRegistryConfig
- Returns:
- property prefix
-
host
default java.lang.String host()
The host to send metrics to.- Returns:
- host
-
index
default java.lang.String index()
The index name to write metrics to. Default is: "metrics"- Returns:
- index name
-
indexDateFormat
default java.lang.String indexDateFormat()
The index date format used for rolling indices. This is appended to the index name, separated by theindexDateSeparator()
. Default is: "yyyy-MM"- Returns:
- date format for index
-
timestampFieldName
default java.lang.String timestampFieldName()
The name of the timestamp field. Default is: "@timestamp"- Returns:
- field name for timestamp
-
autoCreateIndex
default boolean autoCreateIndex()
Whether to create the index automatically if it doesn't exist. Default is:true
- Returns:
- whether to create the index automatically
-
userName
default java.lang.String userName()
The Basic Authentication username. Default is: "" (= do not perform Basic Authentication)- Returns:
- username for Basic Authentication
-
password
default java.lang.String password()
The Basic Authentication password. Default is: "" (= do not perform Basic Authentication)- Returns:
- password for Basic Authentication
-
pipeline
default java.lang.String pipeline()
The ingest pipeline name. Default is: "" (= do not pre-process events)- Returns:
- ingest pipeline name
- Since:
- 1.2.0
-
indexDateSeparator
default java.lang.String indexDateSeparator()
The separator between the index name and the date part. Default is: "-"- Returns:
- index name separator
- Since:
- 1.2.0
-
-