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.

    • Field Detail

      • DEFAULT

        static final InfluxConfig DEFAULT
        Accept configuration defaults

    • Method Detail

      • prefix

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

      • db

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

      • consistency

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

      • 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 Influx.

      • 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 Influx.

      • retentionPolicy

        @Nullable
default java.lang.String retentionPolicy()
        Returns:
        Influx writes to the DEFAULT retention policy if one is not specified.

      • retentionDuration

        @Nullable
default java.lang.String retentionDuration()
        Returns:
        Time period for which influx should retain data in the current database (e.g. 2h, 52w).

      • retentionReplicationFactor

        @Nullable
default java.lang.Integer retentionReplicationFactor()
        Returns:
        How many copies of the data are stored in the cluster. Must be 1 for a single node instance.

      • retentionShardDuration

        @Nullable
default java.lang.String retentionShardDuration()
        Returns:
        The time range covered by a shard group (e.g. 2h, 52w).

      • uri

        default java.lang.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()
        Returns:
        true if Micrometer should check if db() exists before attempting to publish metrics to it, creating it if it does not exist.