Package com.tnsai.quality.slo

Record Class SLODefinition

java.lang.Object
java.lang.Record
com.tnsai.quality.slo.SLODefinition
public record SLODefinition(String id, String name, SLOScope scope, SLOType type, Target target, Duration window, Optional<BurnRateConfig> burnRate) extends Record
Declarative definition of one Service Level Objective (issue #92).

Combines what to measure (SLOType + Target), where to measure it (SLOScope), how long to look back (window), and how aggressively to alert on burn rate (Optional<BurnRateConfig>). The SLOEvaluator consumes one of these to compute current SLOState.

Definitions are immutable — reload by replacing the SLORegistry entry rather than mutating in place.

Since:
0.5.0 (issue #92)

  • Constructor Details

    • SLODefinition

      public SLODefinition(String id, String name, SLOScope scope, SLOType type, Target target, Duration window, Optional<BurnRateConfig> burnRate)
      Creates an instance of a SLODefinition record class.
      Parameters:
      id - the value for the id record component
      name - the value for the name record component
      scope - the value for the scope record component
      type - the value for the type record component
      target - the value for the target record component
      window - the value for the window record component
      burnRate - the value for the burnRate record component

    • SLODefinition

      public SLODefinition(String id, String name, SLOScope scope, SLOType type, Target target, Duration window)
      Convenience: definition without burn-rate alerting.

  • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • id

      public String id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • scope

      public SLOScope scope()
      Returns the value of the scope record component.
      Returns:
      the value of the scope record component

    • type

      public SLOType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • target

      public Target target()
      Returns the value of the target record component.
      Returns:
      the value of the target record component

    • window

      public Duration window()
      Returns the value of the window record component.
      Returns:
      the value of the window record component

    • burnRate

      public Optional<BurnRateConfig> burnRate()
      Returns the value of the burnRate record component.
      Returns:
      the value of the burnRate record component