Package io.micrometer.opentsdb

Interface OpenTSDBConfig

All Superinterfaces:
io.micrometer.core.instrument.config.MeterRegistryConfig, io.micrometer.core.instrument.push.PushRegistryConfig
public interface OpenTSDBConfig
extends io.micrometer.core.instrument.push.PushRegistryConfig
Configuration for OpenTSDBMeterRegistry.
Since:
1.4.0

  • Field Summary

    Fields
    Modifier and Type Field Description
    static OpenTSDBConfig DEFAULT
    Accept configuration defaults

  • Method Summary

    Modifier and Type Method Description
    default OpenTSDBFlavor flavor()
    OpenTSDB can be used as a metrics sink to different backends.
    default java.lang.String password()  
    default java.lang.String prefix()
    Property prefix to prepend to configuration names.
    default java.lang.String uri()
    The URI to send the metrics to.
    default java.lang.String userName()  
    default io.micrometer.core.instrument.config.validate.Validated<?> validate()  

    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

      static final OpenTSDBConfig DEFAULT
      Accept configuration defaults

  • Method Details

    • prefix

      default java.lang.String prefix()
      Property prefix to prepend to configuration names.
      Specified by:
      prefix in interface io.micrometer.core.instrument.config.MeterRegistryConfig
      Returns:
      property prefix

    • uri

      default java.lang.String uri()
      The URI to send the metrics to.
      Returns:
      uri

    • userName

      @Nullable default java.lang.String userName()
      Returns:
      Authenticate requests with this user. By default is null, and the registry will not attempt to present credentials to OpenTSDB.

    • password

      @Nullable default java.lang.String password()
      Returns:
      Authenticate requests with this password. By default is null, and the registry will not attempt to present credentials to OpenTSDB.

    • flavor

      @Nullable default OpenTSDBFlavor flavor()
      OpenTSDB can be used as a metrics sink to different backends. The registry can react to different flavors to ship metrics differently to guarantee the highest fidelity at their ultimate destination.
      Returns:
      A flavor that influences the style of metrics shipped to OpenTSDB.

    • 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