Package io.micrometer.influx

Interface InfluxConfig

All Superinterfaces:
io.micrometer.core.instrument.config.MeterRegistryConfig, io.micrometer.core.instrument.push.PushRegistryConfig, io.micrometer.core.instrument.step.StepRegistryConfig
public interface InfluxConfig extends io.micrometer.core.instrument.step.StepRegistryConfig
Configuration for InfluxMeterRegistry. Since Micrometer 1.7, InfluxDB v2 and v1 are supported.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final InfluxConfig
    DEFAULT
    Accept configuration defaults

  • Method Summary

    Modifier and Type
    Method
    Description
    default InfluxApiVersion
    apiVersion()
    Specifies the API version used to send metrics.
    default boolean
    autoCreateDb()
    Auto-creating the database is only supported with InfluxDB v1.
    default String
    bucket()
    Specifies the destination bucket for writes.
    default boolean
    compressed()
     
    default InfluxConsistency
    consistency()
    Must be one of 'any', 'one', 'quorum', or 'all'.
    default String
    db()
     
    default String
    org()
    Specifies the destination organization for writes.
    default String
    password()
    Authentication by 'userName' and 'password' is not supported for InfluxDB v2.
    default String
    prefix()
     
    default String
    retentionDuration()
    This retention configuration will only be used with InfluxDB v1.
    default String
    retentionPolicy()
    This retention configuration will only be used with InfluxDB v1.
    default Integer
    retentionReplicationFactor()
    This retention configuration will only be used with InfluxDB v1.
    default String
    retentionShardDuration()
    This retention configuration will only be used with InfluxDB v1.
    default String
    token()
    Authentication token for the InfluxDB API.
    default String
    uri()
     
    default String
    userName()
    Authentication by 'userName' and 'password' is not supported for InfluxDB v2.
    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 InfluxConfig DEFAULT
      Accept configuration defaults

  • Method Details

    • prefix

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

    • db

      default String db()
      Returns:
      The db to send metrics to. Defaults to "mydb".

    • consistency

      default InfluxConsistency consistency()
      Must be one of 'any', 'one', 'quorum', or 'all'. Only available for InfluxEnterprise clusters.
      Returns:
      Sets the write consistency for each point. The default is 'one'.

    • userName

      @Nullable default String userName()
      Authentication by 'userName' and 'password' is not supported for InfluxDB v2.
      Returns:
      Authenticate requests with this user. By default is null, and the registry will not attempt to present credentials to Influx.

    • password

      @Nullable default String password()
      Authentication by 'userName' and 'password' is not supported for InfluxDB v2.
      Returns:
      Authenticate requests with this password. By default is null, and the registry will not attempt to present credentials to Influx.

    • retentionPolicy

      @Nullable default String retentionPolicy()
      This retention configuration will only be used with InfluxDB v1.
      Returns:
      Influx writes to the DEFAULT retention policy if one is not specified.

    • retentionDuration

      @Nullable default String retentionDuration()
      This retention configuration will only be used with InfluxDB v1.
      Returns:
      Time period for which influx should retain data in the current database (e.g. 2h, 52w).

    • retentionReplicationFactor

      @Nullable default Integer retentionReplicationFactor()
      This retention configuration will only be used with InfluxDB v1.
      Returns:
      How many copies of the data are stored in the cluster. Must be 1 for a single node instance.

    • retentionShardDuration

      @Nullable default String retentionShardDuration()
      This retention configuration will only be used with InfluxDB v1.
      Returns:
      The time range covered by a shard group (e.g. 2h, 52w).

    • uri

      default String uri()
      Returns:
      The URI for the Influx backend. The default is http://localhost:8086.

    • compressed

      default boolean compressed()
      Returns:
      true if metrics publish batches should be GZIP compressed, false otherwise.

    • autoCreateDb

      default boolean autoCreateDb()
      Auto-creating the database is only supported with InfluxDB v1.
      Returns:
      true if Micrometer should check if db() exists before attempting to publish metrics to it, creating it if it does not exist.

    • apiVersion

      default InfluxApiVersion apiVersion()
      Specifies the API version used to send metrics. Use 'v1' or 'v2' based on the version of your InfluxDB. Defaults to 'v1' unless an org() is configured. If an org() is configured, defaults to 'v2'.
      Returns:
      The API version used to send metrics.
      Since:
      1.7

    • org

      @Nullable default String org()
      Specifies the destination organization for writes. Takes either the ID or Name interchangeably. This is only used with InfluxDB v2.
      Returns:
      The destination organization for writes.
      Since:
      1.7
      See Also:

    • bucket

      default String bucket()
      Specifies the destination bucket for writes. Takes either the ID or Name interchangeably. This is only used with InfluxDB v2.
      Returns:
      The destination bucket (or db) for writes.
      Since:
      1.7
      See Also:

    • token

      @Nullable default String token()
      Authentication token for the InfluxDB API. This takes precedence over userName/password if configured.
      Returns:
      Authentication token to authorize API requests.
      Since:
      1.7
      See Also:

    • 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