Package org.axonframework.extension.metrics.micrometer

Record Class MicrometerMetricsConfiguration

java.lang.Object
java.lang.Record
org.axonframework.extension.metrics.micrometer.MicrometerMetricsConfiguration
Record Components:
registry - the MeterRegistry which will record the metrics
useDimensions - when true, tags are added to measurements
public record MicrometerMetricsConfiguration(io.micrometer.core.instrument.MeterRegistry registry, boolean useDimensions) extends Record
Configuration container for the MetricsConfigurationEnhancer, containing the MeterRegistry and whether to add dimensionality to those measurements.

Should be registered with the ComponentRegistry to ensure other components can pick it up when required.

Since:
5.4.1
Author:
Steven van Beelen

  • Constructor Summary

    Constructors
    Constructor
    Description
    MicrometerMetricsConfiguration(io.micrometer.core.instrument.MeterRegistry registry, boolean useDimensions)
    Constructs a MicrometerMetricsConfiguration.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    io.micrometer.core.instrument.MeterRegistry
    registry()
    Returns the value of the registry record component.
    final String
    toString()
    Returns a string representation of this record class.
    boolean
    useDimensions()
    Returns the value of the useDimensions record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • MicrometerMetricsConfiguration

      public MicrometerMetricsConfiguration(io.micrometer.core.instrument.MeterRegistry registry, boolean useDimensions)
      Constructs a MicrometerMetricsConfiguration.
      Parameters:
      registry - the MeterRegistry which will record the metrics
      useDimensions - when true, tags are added to measurements

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • registry

      public io.micrometer.core.instrument.MeterRegistry registry()
      Returns the value of the registry record component.
      Returns:
      the value of the registry record component

    • useDimensions

      public boolean useDimensions()
      Returns the value of the useDimensions record component.
      Returns:
      the value of the useDimensions record component