Package io.micrometer.wavefront

Interface WavefrontConfig

All Superinterfaces:
io.micrometer.core.instrument.config.MeterRegistryConfig, io.micrometer.core.instrument.push.PushRegistryConfig
public interface WavefrontConfig
extends io.micrometer.core.instrument.push.PushRegistryConfig
Configuration for WavefrontMeterRegistry.
Since:
1.0.0

  • Field Summary

    Fields
    Modifier and Type Field Description
    static WavefrontConfig DEFAULT_DIRECT
    Publishes directly to the Wavefront API, not passing through a sidecar.
    static WavefrontConfig DEFAULT_PROXY
    Publishes to a wavefront sidecar running out of process.

  • Method Summary

    Modifier and Type Method Description
    default java.lang.String apiToken()
    Required when publishing directly to the Wavefront API host, otherwise does nothing.
    default int distributionPort()
    Deprecated.
    since 1.5.0 this is no longer used as a single proxy port can handle all wavefront formats.
    default java.lang.String globalPrefix()
    Wavefront metrics are grouped hierarchically by name in the UI.
    default java.lang.String prefix()  
    default boolean reportDayDistribution()  
    default boolean reportHourDistribution()  
    default boolean reportMinuteDistribution()  
    default java.lang.String source()  
    default java.lang.String uri()  
    default io.micrometer.core.instrument.config.validate.Validated<?> validate()  
    default io.micrometer.core.instrument.config.validate.Validated<?> validateSenderConfiguration()  

    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

  • Field Details

    • DEFAULT_PROXY

      static final WavefrontConfig DEFAULT_PROXY
      Publishes to a wavefront sidecar running out of process.

    • DEFAULT_DIRECT

      static final WavefrontConfig DEFAULT_DIRECT
      Publishes directly to the Wavefront API, not passing through a sidecar.

  • Method Details

    • prefix

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

    • uri

      default java.lang.String uri()
      Returns:
      The URI to publish metrics to. The URI could represent a Wavefront sidecar or the Wavefront API host. This host could also represent an internal proxy set up in your environment that forwards metrics data to the Wavefront API host.

      If publishing metrics to a Wavefront proxy (as described in https://docs.wavefront.com/proxies_installing.html), the host must be in the proxy://HOST:PORT format.

    • distributionPort

      @Deprecated default int distributionPort()
      Deprecated.
      since 1.5.0 this is no longer used as a single proxy port can handle all wavefront formats.
      Get distribution port.
      Returns:
      distribution port

    • source

      default java.lang.String source()
      Returns:
      Unique identifier for the app instance that is publishing metrics to Wavefront. Defaults to the local host name.

    • apiToken

      @Nullable default java.lang.String apiToken()
      Required when publishing directly to the Wavefront API host, otherwise does nothing.
      Returns:
      The Wavefront API token.

    • reportMinuteDistribution

      default boolean reportMinuteDistribution()
      Returns:
      true to report histogram distributions aggregated into minute intervals. Default is true.
      Since:
      1.2.0

    • reportHourDistribution

      default boolean reportHourDistribution()
      Returns:
      true to report histogram distributions aggregated into hour intervals. Default is false.
      Since:
      1.2.0

    • reportDayDistribution

      default boolean reportDayDistribution()
      Returns:
      true to report histogram distributions aggregated into day intervals. Default is false.
      Since:
      1.2.0

    • globalPrefix

      @Nullable default java.lang.String globalPrefix()
      Wavefront metrics are grouped hierarchically by name in the UI. Setting a global prefix separates metrics originating from this app's whitebox instrumentation from those originating from other Wavefront integrations.
      Returns:
      A prefix to add to every metric.

    • 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

    • validateSenderConfiguration

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