Package org.forgerock.monitoring.api.instrument

Interface MeterRegistry.Config

  • All Known Implementing Classes:
    AbstractMeterRegistry.ConfigImpl
    Enclosing interface:
    MeterRegistry
    public static interface MeterRegistry.Config
    Access to configuration options for this registry. ForgeRock changes. - Switched to interface

    • Method Detail

      • commonTags

        default MeterRegistry.Config commonTags​(Iterable<Tag> tags)
        Append a list of common tags to apply to all metrics reported to the monitoring system.
        Parameters:
        tags - Tags to add to every metric.
        Returns:
        This configuration instance.

      • commonTags

        default MeterRegistry.Config commonTags​(String... tags)
        Append a list of common tags to apply to all metrics reported to the monitoring system. Must be an even number of arguments representing key/value pairs of tags.
        Parameters:
        tags - MUST be an even number of arguments representing key/value pairs of tags.
        Returns:
        This configuration instance.

      • meterFilter

        MeterRegistry.Config meterFilter​(MeterFilter filter)
        Add a meter filter to the registry. Filters are applied in the order in which they are added.
        Parameters:
        filter - The filter to add to the registry.
        Returns:
        This configuration instance.

      • onMeterAdded

        MeterRegistry.Config onMeterAdded​(Consumer<Meter> meter)
        Register an event listener for each meter added to the registry.
        Parameters:
        meter - The meter that has just been added
        Returns:
        This configuration instance.

      • namingConvention

        MeterRegistry.Config namingConvention​(NamingConvention convention)
        Use the provided naming convention, overriding the default for your monitoring system.
        Parameters:
        convention - The naming convention to use.
        Returns:
        This configuration instance.

      • namingConvention

        NamingConvention namingConvention()
        Returns the associated Naming Convention.
        Returns:
        The naming convention currently in use on this registry.

      • clock

        Clock clock()
        Returns the Clock used to measure durations of Timers.
        Returns:
        The clock used to measure durations of timers and long task timers (and sometimes influences publishing behavior).

      • pauseDetector

        MeterRegistry.Config pauseDetector​(PauseDetector detector)
        Sets the default pause detector to use for all timers in this registry.
        Parameters:
        detector - The pause detector to use.
        Returns:
        This configuration instance.
        See Also:
        "io.micrometer.core.instrument.histogram.pause.NoPauseDetector", "io.micrometer.core.instrument.histogram.pause.ClockDriftPauseDetector"

      • pauseDetector

        PauseDetector pauseDetector()
        Returns the associated Pause Detector.
        Returns:
        The pause detector that is currently in effect.