Package io.micrometer.newrelic
Interface NewRelicConfig
- All Superinterfaces:
io.micrometer.core.instrument.config.MeterRegistryConfig
,io.micrometer.core.instrument.push.PushRegistryConfig
,io.micrometer.core.instrument.step.StepRegistryConfig
public interface NewRelicConfig
extends io.micrometer.core.instrument.step.StepRegistryConfig
Configuration for
NewRelicMeterRegistry
.- Since:
- 1.0.0
-
Method Summary
Modifier and TypeMethodDescriptiondefault String
default String
apiKey()
default ClientProviderType
When this isINSIGHTS_AGENT
, the New Relic metrics will be published with theNewRelicInsightsAgentClientProvider
which delegates to the Java agent.default String
This configuration property will only be used ifmeterNameEventTypeEnabled()
isfalse
.default boolean
When this isfalse
, the New Relic eventType value will be set toeventType()
.default String
prefix()
default String
uri()
default io.micrometer.core.instrument.config.validate.Validated
<?> validate()
default io.micrometer.core.instrument.config.validate.Validated
<?> Methods inherited from interface io.micrometer.core.instrument.config.MeterRegistryConfig
get, requireValid
Methods inherited from interface io.micrometer.core.instrument.push.PushRegistryConfig
batchSize, connectTimeout, enabled, numThreads, readTimeout, step
-
Method Details
-
prefix
- Specified by:
prefix
in interfaceio.micrometer.core.instrument.config.MeterRegistryConfig
-
meterNameEventTypeEnabled
default boolean meterNameEventTypeEnabled()When this isfalse
, the New Relic eventType value will be set toeventType()
. Otherwise, the meter name will be used. Defaults tofalse
.- Returns:
- whether to use meter names as the New Relic eventType value
-
eventType
This configuration property will only be used ifmeterNameEventTypeEnabled()
isfalse
. Default value isMicrometerSample
.- Returns:
- static eventType value to send to New Relic for all metrics.
-
clientProviderType
When this isINSIGHTS_AGENT
, the New Relic metrics will be published with theNewRelicInsightsAgentClientProvider
which delegates to the Java agent. Defaults toINSIGHTS_API
for publishing with theNewRelicInsightsApiClientProvider
to the Insights REST API.- Returns:
- the ClientProviderType to use
-
apiKey
-
accountId
-
uri
- Returns:
- The URI for the New Relic insights API. The default is
https://insights-collector.newrelic.com
. If you need to pass through a proxy, you can change this value.
-
validate
default io.micrometer.core.instrument.config.validate.Validated<?> validate()- Specified by:
validate
in interfaceio.micrometer.core.instrument.config.MeterRegistryConfig
- Specified by:
validate
in interfaceio.micrometer.core.instrument.push.PushRegistryConfig
-
validateForInsightsApi
default io.micrometer.core.instrument.config.validate.Validated<?> validateForInsightsApi()
-