Package io.micrometer.core.instrument.push

Interface PushRegistryConfig

All Superinterfaces:
MeterRegistryConfig
All Known Subinterfaces:
LoggingRegistryConfig, StepRegistryConfig
public interface PushRegistryConfig
extends MeterRegistryConfig
Common configuration settings for any registry that pushes aggregated metrics on a regular interval.

  • Method Summary

    Modifier and Type Method Description
    default int batchSize()  
    default java.time.Duration connectTimeout()
    Deprecated.
    Connect timeout and read timeout have different meanings depending on the HTTP client.
    default boolean enabled()  
    default int numThreads()
    Deprecated.
    since 1.1.13 because this configuration is not used
    default java.time.Duration readTimeout()
    Deprecated.
    Connect timeout and read timeout have different meanings depending on the HTTP client.
    default java.time.Duration step()  
    default Validated<?> validate()
    Validate configuration.
    static Validated<?> validate​(PushRegistryConfig config)
    Validate a provided configuration.

    Methods inherited from interface io.micrometer.core.instrument.config.MeterRegistryConfig

    get, prefix, requireValid

  • Method Details

    • step

      default java.time.Duration step()
      Returns:
      The step size (reporting frequency) to use. The default is 1 minute.

    • enabled

      default boolean enabled()
      Returns:
      true if publishing is enabled. Default is true.

    • numThreads

      @Deprecated default int numThreads()
      Deprecated.
      since 1.1.13 because this configuration is not used
      Return the number of threads to use with the scheduler.

      Note that this configuration is NOT supported.

      Returns:
      The number of threads to use with the scheduler. The default is 2 threads.

    • connectTimeout

      @Deprecated default java.time.Duration connectTimeout()
      Deprecated.
      Connect timeout and read timeout have different meanings depending on the HTTP client. Configure timeout options on your HttpSender of choice instead.
      Returns:
      The connection timeout for requests to the backend. The default is 1 second.

    • readTimeout

      @Deprecated default java.time.Duration readTimeout()
      Deprecated.
      Connect timeout and read timeout have different meanings depending on the HTTP client. Configure timeout options on your HttpSender of choice instead.
      Returns:
      The read timeout for requests to the backend. The default is 10 seconds.

    • batchSize

      default int batchSize()
      Returns:
      The number of measurements per request to use for the backend. If more measurements are found, then multiple requests will be made. The default is 10,000.

    • validate

      default Validated<?> validate()
      Description copied from interface: MeterRegistryConfig
      Validate configuration.
      Specified by:
      validate in interface MeterRegistryConfig
      Returns:
      validation result

    • validate

      static Validated<?> validate​(PushRegistryConfig config)
      Validate a provided configuration.
      Parameters:
      config - configuration to validate
      Returns:
      validation result
      Since:
      1.5.0