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 final 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 String
    password()
     
    default String
    prefix()
    Property prefix to prepend to configuration names.
    default String
    uri()
    The URI to send the metrics to.
    default 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 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 String uri()
      The URI to send the metrics to.
      Returns:
      uri

    • userName

      @Nullable default 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 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