Package io.micrometer.core.instrument.config

Interface MeterFilter

All Known Implementing Classes:
OnlyOnceLoggingDenyMeterFilter
public interface MeterFilter
As requests are made of a MeterRegistry to create new metrics, allow for filtering out the metric altogether, transforming its ID (name or tags) in some way, and transforming its configuration.

All new metrics should pass through each MeterFilter in the order in which they were added.

  • Method Details

    • commonTags

      static MeterFilter commonTags(Iterable<Tag> tags)
      Add common tags that are applied to every meter created afterward. The common tags will not override tag values from a meter ID. They will also not override previously configured common tag MeterFilters that have the same tag key.
      Parameters:
      tags - Common tags.
      Returns:
      A common tag filter.

    • renameTag

      static MeterFilter renameTag(String meterNamePrefix, String fromTagKey, String toTagKey)
      Rename a tag key for every metric beginning with a given prefix.
      Parameters:
      meterNamePrefix - Apply filter to metrics that begin with this name.
      fromTagKey - Rename tags matching this key.
      toTagKey - Rename to this key.
      Returns:
      A tag-renaming filter.

    • ignoreTags

      static MeterFilter ignoreTags(String... tagKeys)
      Suppress tags with given tag keys.
      Parameters:
      tagKeys - Keys of tags that should be suppressed.
      Returns:
      A tag-suppressing filter.

    • replaceTagValues

      static MeterFilter replaceTagValues(String tagKey, Function<String,String> replacement, String... exceptions)
      Replace tag values according to the provided mapping for all matching tag keys. This can be used to reduce the total cardinality of a tag by mapping some portion of tag values to something else.
      Parameters:
      tagKey - The tag key for which replacements should be made
      replacement - The value to replace with
      exceptions - All matching tags with this value to retain its original value
      Returns:
      A filter that replaces tag values.

    • denyUnless

      static MeterFilter denyUnless(Predicate<Meter.Id> iff)
      Can be used to build a whitelist of metrics matching certain criteria. Opposite of deny(Predicate).
      Parameters:
      iff - When a meter id matches, allow its inclusion, otherwise deny.
      Returns:
      A meter filter that whitelists metrics matching a predicate.

    • accept

      static MeterFilter accept(Predicate<Meter.Id> iff)
      When the given predicate is true, the meter should be present in published metrics.
      Parameters:
      iff - When a meter id matches, guarantee its inclusion in published metrics.
      Returns:
      A filter that guarantees the inclusion of matching meters.

    • deny

      static MeterFilter deny(Predicate<Meter.Id> iff)
      When the given predicate is true, the meter should NOT be present in published metrics. Opposite of denyUnless(Predicate).
      Parameters:
      iff - When a meter id matches, guarantee its exclusion in published metrics.
      Returns:
      A filter that guarantees the exclusion of matching meters.

    • accept

      static MeterFilter accept()
      Include a meter in published metrics. Can be used as a subordinate action on another filter like maximumAllowableTags(java.lang.String, java.lang.String, int, io.micrometer.core.instrument.config.MeterFilter).
      Returns:
      A filter that guarantees the inclusion of all meters.

    • deny

      static MeterFilter deny()
      Reject a meter in published metrics. Can be used as a subordinate action on another filter like maximumAllowableTags(java.lang.String, java.lang.String, int, io.micrometer.core.instrument.config.MeterFilter).
      Returns:
      A filter that guarantees the exclusion of all meters.

    • maximumAllowableMetrics

      static MeterFilter maximumAllowableMetrics(int maximumTimeSeries)
      Useful for cost-control in monitoring systems which charge directly or indirectly by the total number of time series you generate.

      While this filter doesn't discriminate between your most critical and less useful metrics in deciding what to drop (all the metrics you intend to use should fit below this threshold), it can effectively cap your risk of an accidentally high-cardinality metric costing too much.

      Parameters:
      maximumTimeSeries - The total number of unique name/tag permutations allowed before filtering kicks in.
      Returns:
      A filter that globally limits the number of unique name and tag combinations.

    • maximumAllowableTags

      static MeterFilter maximumAllowableTags(String meterNamePrefix, String tagKey, int maximumTagValues, MeterFilter onMaxReached)
      Places an upper bound on the number of tags produced by matching metrics.
      Parameters:
      meterNamePrefix - Apply filter to metrics that begin with this name.
      tagKey - The tag to place an upper bound on.
      maximumTagValues - The total number of tag values that are allowable.
      onMaxReached - After the maximum number of tag values have been seen, apply this filter.
      Returns:
      A meter filter that limits the number of tags produced by matching metrics.

    • denyNameStartsWith

      static MeterFilter denyNameStartsWith(String prefix)
      Meters that start with the provided name prefix should NOT be present in published metrics.
      Parameters:
      prefix - When a meter name starts with the prefix, guarantee its exclusion in published metrics.
      Returns:
      A filter that guarantees the exclusion of matching meters.

    • acceptNameStartsWith

      static MeterFilter acceptNameStartsWith(String prefix)
      Meters that start with the provided name should be present in published metrics.
      Parameters:
      prefix - When a meter name starts with the prefix, guarantee its inclusion in published metrics.
      Returns:
      A filter that guarantees the inclusion of matching meters.
      Since:
      1.2.0

    • maxExpected

      static MeterFilter maxExpected(String prefix, Duration max)
      Set a maximum expected value on any Timer whose name begins with the given prefix.
      Parameters:
      prefix - Apply the maximum only to timers whose name begins with this prefix.
      max - The maximum expected value of the timer.
      Returns:
      A filter that applies a maximum expected value to a timer.

    • maxExpected

      @Deprecated static MeterFilter maxExpected(String prefix, long max)
      Deprecated.
      Use maxExpected(String, double) instead since 1.4.0.
      Set a maximum expected value on any DistributionSummary whose name begins with the given prefix.
      Parameters:
      prefix - Apply the maximum only to distribution summaries whose name begins with this prefix.
      max - The maximum expected value of the distribution summary.
      Returns:
      A filter that applies a maximum expected value to a distribution summary.

    • maxExpected

      static MeterFilter maxExpected(String prefix, double max)
      Set a maximum expected value on any DistributionSummary whose name begins with the given prefix.
      Parameters:
      prefix - Apply the maximum only to distribution summaries whose name begins with this prefix.
      max - The maximum expected value of the distribution summary.
      Returns:
      A filter that applies a maximum expected value to a distribution summary.
      Since:
      1.4.0

    • minExpected

      static MeterFilter minExpected(String prefix, Duration min)
      Set a minimum expected value on any Timer whose name begins with the given prefix.
      Parameters:
      prefix - Apply the minimum only to timers whose name begins with this prefix.
      min - The minimum expected value of the timer.
      Returns:
      A filter that applies a minimum expected value to a timer.

    • minExpected

      @Deprecated static MeterFilter minExpected(String prefix, long min)
      Deprecated.
      Use minExpected(String, double) instead since 1.4.0.
      Set a minimum expected value on any DistributionSummary whose name begins with the given prefix.
      Parameters:
      prefix - Apply the minimum only to distribution summaries whose name begins with this prefix.
      min - The minimum expected value of the distribution summary.
      Returns:
      A filter that applies a minimum expected value to a distribution summary.

    • minExpected

      static MeterFilter minExpected(String prefix, double min)
      Set a minimum expected value on any DistributionSummary whose name begins with the given prefix.
      Parameters:
      prefix - Apply the minimum only to distribution summaries whose name begins with this prefix.
      min - The minimum expected value of the distribution summary.
      Returns:
      A filter that applies a minimum expected value to a distribution summary.
      Since:
      1.4.0

    • accept

      default MeterFilterReply accept(Meter.Id id)
      Parameters:
      id - Id with map(io.micrometer.core.instrument.Meter.Id) transformations applied.
      Returns:
      After all transformations, should a real meter be registered for this id, or should it be no-op'd.

    • map

      default Meter.Id map(Meter.Id id)
      Transform the Meter Id when registering a Meter with a MeterRegistry that has this MeterFilter configured. Note that implementations should only depend on the Id parameter and static (at runtime) values. That is, this should not be used to implement dynamic tagging, such as tagging based on a request object that will potentially be different each time metrics are to be recorded on a Meter. For such dynamic use cases, the dynamic tagging should be handled as part of the instrumentation, creating abstractions as necessary for end-users to customize the tagging behavior.
      Parameters:
      id - Id to transform.
      Returns:
      the transformed Id

    • configure

      @Nullable default DistributionStatisticConfig configure(Meter.Id id, DistributionStatisticConfig config)
      This is only called when filtering new timers and distribution summaries (i.e. those meter types that use DistributionStatisticConfig).
      Parameters:
      id - Id with map(io.micrometer.core.instrument.Meter.Id) transformations applied.
      config - A histogram configuration guaranteed to be non-null.
      Returns:
      Overrides to any part of the histogram config, when applicable.