PercentageThreshold (apache-cassandra API)

java.lang.Object

org.apache.cassandra.db.guardrails.Guardrail

org.apache.cassandra.db.guardrails.Threshold

org.apache.cassandra.db.guardrails.MaxThreshold

org.apache.cassandra.db.guardrails.PercentageThreshold

public class PercentageThreshold extends MaxThreshold

A Threshold guardrail whose values represent a percentage

This works exactly as a Threshold, but provides slightly more convenient error messages for percentage

Field Summary

Fields inherited from class org.apache.cassandra.db.guardrails.Threshold
failThreshold, messageProvider, warnThreshold

Fields inherited from class org.apache.cassandra.db.guardrails.Guardrail
logger, name, reason, REDACTED
Constructor Summary

Constructors

Constructor

Description

PercentageThreshold(String name, String reason, ToLongFunction<ClientState> warnThreshold, ToLongFunction<ClientState> failThreshold, org.apache.cassandra.db.guardrails.Threshold.ErrorMessageProvider messageProvider)

Creates a new threshold guardrail.
Method Summary

Modifier and Type

Method

Description

protected String

errMsg(boolean isWarning, String what, long value, long thresholdValue)

Methods inherited from class org.apache.cassandra.db.guardrails.MaxThreshold
compare, failValue, warnValue

Methods inherited from class org.apache.cassandra.db.guardrails.Threshold
enabled, failsOn, guard, triggersOn, warnsOn

Methods inherited from class org.apache.cassandra.db.guardrails.Guardrail
enabled, fail, fail, warn, warn

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- PercentageThreshold
  
  public PercentageThreshold(String name, @Nullable String reason, ToLongFunction<ClientState> warnThreshold, ToLongFunction<ClientState> failThreshold, org.apache.cassandra.db.guardrails.Threshold.ErrorMessageProvider messageProvider)
  
  Creates a new threshold guardrail.
  
  Parameters:
  
  name - the identifying name of the guardrail
  
  reason - the optional description of the reason for guarding the operation
  
  warnThreshold - a ClientState-based provider of the value above which a warning should be triggered.
  
  failThreshold - a ClientState-based provider of the value above which the operation should be aborted.
  
  messageProvider - a function to generate the warning or error message if the guardrail is triggered
Method Details
- errMsg
  
  protected String errMsg(boolean isWarning, String what, long value, long thresholdValue)
  
  Overrides:
  
  errMsg in class Threshold