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 Details

    • prefix

      default String prefix()
      Specified by:
      prefix in interface io.micrometer.core.instrument.config.MeterRegistryConfig

    • meterNameEventTypeEnabled

      default boolean meterNameEventTypeEnabled()
      When this is false, the New Relic eventType value will be set to eventType(). Otherwise, the meter name will be used. Defaults to false.
      Returns:
      whether to use meter names as the New Relic eventType value

    • eventType

      default String eventType()
      This configuration property will only be used if meterNameEventTypeEnabled() is false. Default value is MicrometerSample.
      Returns:
      static eventType value to send to New Relic for all metrics.

    • clientProviderType

      default ClientProviderType clientProviderType()
      When this is INSIGHTS_AGENT, the New Relic metrics will be published with the NewRelicInsightsAgentClientProvider which delegates to the Java agent. Defaults to INSIGHTS_API for publishing with the NewRelicInsightsApiClientProvider to the Insights REST API.
      Returns:
      the ClientProviderType to use

    • apiKey

      @Nullable default String apiKey()

    • accountId

      @Nullable default String accountId()

    • uri

      default String 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 interface io.micrometer.core.instrument.config.MeterRegistryConfig
      Specified by:
      validate in interface io.micrometer.core.instrument.push.PushRegistryConfig

    • validateForInsightsApi

      default io.micrometer.core.instrument.config.validate.Validated<?> validateForInsightsApi()