Package org.apache.cassandra.db.guardrails

Class MaxThreshold

java.lang.Object

org.apache.cassandra.db.guardrails.Guardrail

org.apache.cassandra.db.guardrails.Threshold

org.apache.cassandra.db.guardrails.MaxThreshold

Direct Known Subclasses:

PercentageThreshold

public class MaxThreshold
extends Threshold

MaxThreshold for maximum guardrails, the value is checked to see if it is greater than the warn and fail thresholds.

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
MaxThreshold(java.lang.String name, java.lang.String reason, java.util.function.ToLongFunction<ClientState> warnThreshold, java.util.function.ToLongFunction<ClientState> failThreshold, org.apache.cassandra.db.guardrails.Threshold.ErrorMessageProvider messageProvider)	Creates a new threshold guardrail.

Method Summary

Modifier and Type	Method	Description
protected boolean	compare(long value, long threshold)
protected long	failValue(ClientState state)
protected long	warnValue(ClientState state)

Methods inherited from class org.apache.cassandra.db.guardrails.Threshold

enabled, errMsg, 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 Detail

MaxThreshold

public MaxThreshold(java.lang.String name,
                    @Nullable
                    java.lang.String reason,
                    java.util.function.ToLongFunction<ClientState> warnThreshold,
                    java.util.function.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 Detail

compare

protected boolean compare(long value,
                          long threshold)

Specified by:

compare in class Threshold

failValue

protected long failValue(ClientState state)

Specified by:

failValue in class Threshold

warnValue

protected long warnValue(ClientState state)

Specified by:

warnValue in class Threshold