Package io.micrometer.graphite

Interface GraphiteConfig

All Superinterfaces:
io.micrometer.core.instrument.dropwizard.DropwizardConfig, io.micrometer.core.instrument.config.MeterRegistryConfig
public interface GraphiteConfig
extends io.micrometer.core.instrument.dropwizard.DropwizardConfig
Configuration for GraphiteMeterRegistry.

  • Field Summary

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

  • Method Summary

    Modifier and Type Method Description
    default java.util.concurrent.TimeUnit durationUnits()  
    default boolean enabled()  
    java.lang.String get​(java.lang.String key)
    Get the value associated with a key.
    default boolean graphiteTagsEnabled()  
    default java.lang.String host()  
    default int port()  
    default java.lang.String prefix()  
    default GraphiteProtocol protocol()  
    default java.util.concurrent.TimeUnit rateUnits()  
    default java.lang.String[] tagsAsPrefix()  
    default io.micrometer.core.instrument.config.validate.Validated<?> validate()  

    Methods inherited from interface io.micrometer.core.instrument.dropwizard.DropwizardConfig

    step

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

    requireValid

  • Field Details

  • Method Details

    • get

      @Nullable java.lang.String get​(java.lang.String key)
      Get the value associated with a key.
      Specified by:
      get in interface io.micrometer.core.instrument.config.MeterRegistryConfig
      Parameters:
      key - Key to lookup in the config.
      Returns:
      Value for the key or null if no key is present.

    • prefix

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

    • graphiteTagsEnabled

      default boolean graphiteTagsEnabled()
      Returns:
      Whether Graphite tags should be used, as opposed to a hierarchical naming convention. Defaults to true if no values are present for tagsAsPrefix().
      Since:
      1.4.0
      See Also:
      Graphite Tag Support

    • tagsAsPrefix

      default java.lang.String[] tagsAsPrefix()
      Returns:
      For the hierarchical naming convention, turn the specified tag keys into part of the metric prefix. Ignored if graphiteTagsEnabled() is true.

    • rateUnits

      default java.util.concurrent.TimeUnit rateUnits()

    • durationUnits

      default java.util.concurrent.TimeUnit durationUnits()

    • host

      default java.lang.String host()

    • port

      default int port()

    • enabled

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

    • protocol

      default GraphiteProtocol protocol()
      Returns:
      Protocol to use while shipping data to Graphite.

    • validate

      default io.micrometer.core.instrument.config.validate.Validated<?> validate()
      Specified by:
      validate in interface io.micrometer.core.instrument.dropwizard.DropwizardConfig
      Specified by:
      validate in interface io.micrometer.core.instrument.config.MeterRegistryConfig