public final class Watchdog extends com.google.protobuf.GeneratedMessageV3 implements WatchdogOrBuilder
Envoy process watchdog configuration. When configured, this monitors for nonresponsive threads and kills the process after the configured thresholds. See the :ref:`watchdog documentation <operations_performance_watchdog>` for more information. [#next-free-field: 8]Protobuf type
envoy.config.bootstrap.v3.Watchdog| Modifier and Type | Class and Description |
|---|---|
static class |
Watchdog.Builder
Envoy process watchdog configuration.
|
static class |
Watchdog.WatchdogAction
Protobuf type
envoy.config.bootstrap.v3.Watchdog.WatchdogAction |
static interface |
Watchdog.WatchdogActionOrBuilder |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
ACTIONS_FIELD_NUMBER |
static int |
KILL_TIMEOUT_FIELD_NUMBER |
static int |
MAX_KILL_TIMEOUT_JITTER_FIELD_NUMBER |
static int |
MEGAMISS_TIMEOUT_FIELD_NUMBER |
static int |
MISS_TIMEOUT_FIELD_NUMBER |
static int |
MULTIKILL_THRESHOLD_FIELD_NUMBER |
static int |
MULTIKILL_TIMEOUT_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
Watchdog.WatchdogAction |
getActions(int index)
Register actions that will fire on given WatchDog events.
|
int |
getActionsCount()
Register actions that will fire on given WatchDog events.
|
List<Watchdog.WatchdogAction> |
getActionsList()
Register actions that will fire on given WatchDog events.
|
Watchdog.WatchdogActionOrBuilder |
getActionsOrBuilder(int index)
Register actions that will fire on given WatchDog events.
|
List<? extends Watchdog.WatchdogActionOrBuilder> |
getActionsOrBuilderList()
Register actions that will fire on given WatchDog events.
|
static Watchdog |
getDefaultInstance() |
Watchdog |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Duration |
getKillTimeout()
If a watched thread has been nonresponsive for this duration, assume a
programming error and kill the entire Envoy process.
|
com.google.protobuf.DurationOrBuilder |
getKillTimeoutOrBuilder()
If a watched thread has been nonresponsive for this duration, assume a
programming error and kill the entire Envoy process.
|
com.google.protobuf.Duration |
getMaxKillTimeoutJitter()
Defines the maximum jitter used to adjust the *kill_timeout* if *kill_timeout* is
enabled.
|
com.google.protobuf.DurationOrBuilder |
getMaxKillTimeoutJitterOrBuilder()
Defines the maximum jitter used to adjust the *kill_timeout* if *kill_timeout* is
enabled.
|
com.google.protobuf.Duration |
getMegamissTimeout()
The duration after which Envoy counts a nonresponsive thread in the
*watchdog_mega_miss* statistic.
|
com.google.protobuf.DurationOrBuilder |
getMegamissTimeoutOrBuilder()
The duration after which Envoy counts a nonresponsive thread in the
*watchdog_mega_miss* statistic.
|
com.google.protobuf.Duration |
getMissTimeout()
The duration after which Envoy counts a nonresponsive thread in the
*watchdog_miss* statistic.
|
com.google.protobuf.DurationOrBuilder |
getMissTimeoutOrBuilder()
The duration after which Envoy counts a nonresponsive thread in the
*watchdog_miss* statistic.
|
Percent |
getMultikillThreshold()
Sets the threshold for *multikill_timeout* in terms of the percentage of
nonresponsive threads required for the *multikill_timeout*.
|
PercentOrBuilder |
getMultikillThresholdOrBuilder()
Sets the threshold for *multikill_timeout* in terms of the percentage of
nonresponsive threads required for the *multikill_timeout*.
|
com.google.protobuf.Duration |
getMultikillTimeout()
If max(2, ceil(registered_threads * Fraction(*multikill_threshold*)))
threads have been nonresponsive for at least this duration kill the entire
Envoy process.
|
com.google.protobuf.DurationOrBuilder |
getMultikillTimeoutOrBuilder()
If max(2, ceil(registered_threads * Fraction(*multikill_threshold*)))
threads have been nonresponsive for at least this duration kill the entire
Envoy process.
|
com.google.protobuf.Parser<Watchdog> |
getParserForType() |
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
boolean |
hasKillTimeout()
If a watched thread has been nonresponsive for this duration, assume a
programming error and kill the entire Envoy process.
|
boolean |
hasMaxKillTimeoutJitter()
Defines the maximum jitter used to adjust the *kill_timeout* if *kill_timeout* is
enabled.
|
boolean |
hasMegamissTimeout()
The duration after which Envoy counts a nonresponsive thread in the
*watchdog_mega_miss* statistic.
|
boolean |
hasMissTimeout()
The duration after which Envoy counts a nonresponsive thread in the
*watchdog_miss* statistic.
|
boolean |
hasMultikillThreshold()
Sets the threshold for *multikill_timeout* in terms of the percentage of
nonresponsive threads required for the *multikill_timeout*.
|
boolean |
hasMultikillTimeout()
If max(2, ceil(registered_threads * Fraction(*multikill_threshold*)))
threads have been nonresponsive for at least this duration kill the entire
Envoy process.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Watchdog.Builder |
newBuilder() |
static Watchdog.Builder |
newBuilder(Watchdog prototype) |
Watchdog.Builder |
newBuilderForType() |
protected Watchdog.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Watchdog |
parseDelimitedFrom(InputStream input) |
static Watchdog |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Watchdog |
parseFrom(byte[] data) |
static Watchdog |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Watchdog |
parseFrom(ByteBuffer data) |
static Watchdog |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Watchdog |
parseFrom(com.google.protobuf.ByteString data) |
static Watchdog |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Watchdog |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Watchdog |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Watchdog |
parseFrom(InputStream input) |
static Watchdog |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Watchdog> |
parser() |
Watchdog.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int ACTIONS_FIELD_NUMBER
public static final int MISS_TIMEOUT_FIELD_NUMBER
public static final int MEGAMISS_TIMEOUT_FIELD_NUMBER
public static final int KILL_TIMEOUT_FIELD_NUMBER
public static final int MAX_KILL_TIMEOUT_JITTER_FIELD_NUMBER
public static final int MULTIKILL_TIMEOUT_FIELD_NUMBER
public static final int MULTIKILL_THRESHOLD_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public List<Watchdog.WatchdogAction> getActionsList()
Register actions that will fire on given WatchDog events. See *WatchDogAction* for priority of events.
repeated .envoy.config.bootstrap.v3.Watchdog.WatchdogAction actions = 7;getActionsList in interface WatchdogOrBuilderpublic List<? extends Watchdog.WatchdogActionOrBuilder> getActionsOrBuilderList()
Register actions that will fire on given WatchDog events. See *WatchDogAction* for priority of events.
repeated .envoy.config.bootstrap.v3.Watchdog.WatchdogAction actions = 7;getActionsOrBuilderList in interface WatchdogOrBuilderpublic int getActionsCount()
Register actions that will fire on given WatchDog events. See *WatchDogAction* for priority of events.
repeated .envoy.config.bootstrap.v3.Watchdog.WatchdogAction actions = 7;getActionsCount in interface WatchdogOrBuilderpublic Watchdog.WatchdogAction getActions(int index)
Register actions that will fire on given WatchDog events. See *WatchDogAction* for priority of events.
repeated .envoy.config.bootstrap.v3.Watchdog.WatchdogAction actions = 7;getActions in interface WatchdogOrBuilderpublic Watchdog.WatchdogActionOrBuilder getActionsOrBuilder(int index)
Register actions that will fire on given WatchDog events. See *WatchDogAction* for priority of events.
repeated .envoy.config.bootstrap.v3.Watchdog.WatchdogAction actions = 7;getActionsOrBuilder in interface WatchdogOrBuilderpublic boolean hasMissTimeout()
The duration after which Envoy counts a nonresponsive thread in the *watchdog_miss* statistic. If not specified the default is 200ms.
.google.protobuf.Duration miss_timeout = 1;hasMissTimeout in interface WatchdogOrBuilderpublic com.google.protobuf.Duration getMissTimeout()
The duration after which Envoy counts a nonresponsive thread in the *watchdog_miss* statistic. If not specified the default is 200ms.
.google.protobuf.Duration miss_timeout = 1;getMissTimeout in interface WatchdogOrBuilderpublic com.google.protobuf.DurationOrBuilder getMissTimeoutOrBuilder()
The duration after which Envoy counts a nonresponsive thread in the *watchdog_miss* statistic. If not specified the default is 200ms.
.google.protobuf.Duration miss_timeout = 1;getMissTimeoutOrBuilder in interface WatchdogOrBuilderpublic boolean hasMegamissTimeout()
The duration after which Envoy counts a nonresponsive thread in the *watchdog_mega_miss* statistic. If not specified the default is 1000ms.
.google.protobuf.Duration megamiss_timeout = 2;hasMegamissTimeout in interface WatchdogOrBuilderpublic com.google.protobuf.Duration getMegamissTimeout()
The duration after which Envoy counts a nonresponsive thread in the *watchdog_mega_miss* statistic. If not specified the default is 1000ms.
.google.protobuf.Duration megamiss_timeout = 2;getMegamissTimeout in interface WatchdogOrBuilderpublic com.google.protobuf.DurationOrBuilder getMegamissTimeoutOrBuilder()
The duration after which Envoy counts a nonresponsive thread in the *watchdog_mega_miss* statistic. If not specified the default is 1000ms.
.google.protobuf.Duration megamiss_timeout = 2;getMegamissTimeoutOrBuilder in interface WatchdogOrBuilderpublic boolean hasKillTimeout()
If a watched thread has been nonresponsive for this duration, assume a programming error and kill the entire Envoy process. Set to 0 to disable kill behavior. If not specified the default is 0 (disabled).
.google.protobuf.Duration kill_timeout = 3;hasKillTimeout in interface WatchdogOrBuilderpublic com.google.protobuf.Duration getKillTimeout()
If a watched thread has been nonresponsive for this duration, assume a programming error and kill the entire Envoy process. Set to 0 to disable kill behavior. If not specified the default is 0 (disabled).
.google.protobuf.Duration kill_timeout = 3;getKillTimeout in interface WatchdogOrBuilderpublic com.google.protobuf.DurationOrBuilder getKillTimeoutOrBuilder()
If a watched thread has been nonresponsive for this duration, assume a programming error and kill the entire Envoy process. Set to 0 to disable kill behavior. If not specified the default is 0 (disabled).
.google.protobuf.Duration kill_timeout = 3;getKillTimeoutOrBuilder in interface WatchdogOrBuilderpublic boolean hasMaxKillTimeoutJitter()
Defines the maximum jitter used to adjust the *kill_timeout* if *kill_timeout* is enabled. Enabling this feature would help to reduce risk of synchronized watchdog kill events across proxies due to external triggers. Set to 0 to disable. If not specified the default is 0 (disabled).
.google.protobuf.Duration max_kill_timeout_jitter = 6 [(.validate.rules) = { ... }hasMaxKillTimeoutJitter in interface WatchdogOrBuilderpublic com.google.protobuf.Duration getMaxKillTimeoutJitter()
Defines the maximum jitter used to adjust the *kill_timeout* if *kill_timeout* is enabled. Enabling this feature would help to reduce risk of synchronized watchdog kill events across proxies due to external triggers. Set to 0 to disable. If not specified the default is 0 (disabled).
.google.protobuf.Duration max_kill_timeout_jitter = 6 [(.validate.rules) = { ... }getMaxKillTimeoutJitter in interface WatchdogOrBuilderpublic com.google.protobuf.DurationOrBuilder getMaxKillTimeoutJitterOrBuilder()
Defines the maximum jitter used to adjust the *kill_timeout* if *kill_timeout* is enabled. Enabling this feature would help to reduce risk of synchronized watchdog kill events across proxies due to external triggers. Set to 0 to disable. If not specified the default is 0 (disabled).
.google.protobuf.Duration max_kill_timeout_jitter = 6 [(.validate.rules) = { ... }getMaxKillTimeoutJitterOrBuilder in interface WatchdogOrBuilderpublic boolean hasMultikillTimeout()
If max(2, ceil(registered_threads * Fraction(*multikill_threshold*))) threads have been nonresponsive for at least this duration kill the entire Envoy process. Set to 0 to disable this behavior. If not specified the default is 0 (disabled).
.google.protobuf.Duration multikill_timeout = 4;hasMultikillTimeout in interface WatchdogOrBuilderpublic com.google.protobuf.Duration getMultikillTimeout()
If max(2, ceil(registered_threads * Fraction(*multikill_threshold*))) threads have been nonresponsive for at least this duration kill the entire Envoy process. Set to 0 to disable this behavior. If not specified the default is 0 (disabled).
.google.protobuf.Duration multikill_timeout = 4;getMultikillTimeout in interface WatchdogOrBuilderpublic com.google.protobuf.DurationOrBuilder getMultikillTimeoutOrBuilder()
If max(2, ceil(registered_threads * Fraction(*multikill_threshold*))) threads have been nonresponsive for at least this duration kill the entire Envoy process. Set to 0 to disable this behavior. If not specified the default is 0 (disabled).
.google.protobuf.Duration multikill_timeout = 4;getMultikillTimeoutOrBuilder in interface WatchdogOrBuilderpublic boolean hasMultikillThreshold()
Sets the threshold for *multikill_timeout* in terms of the percentage of nonresponsive threads required for the *multikill_timeout*. If not specified the default is 0.
.envoy.type.v3.Percent multikill_threshold = 5;hasMultikillThreshold in interface WatchdogOrBuilderpublic Percent getMultikillThreshold()
Sets the threshold for *multikill_timeout* in terms of the percentage of nonresponsive threads required for the *multikill_timeout*. If not specified the default is 0.
.envoy.type.v3.Percent multikill_threshold = 5;getMultikillThreshold in interface WatchdogOrBuilderpublic PercentOrBuilder getMultikillThresholdOrBuilder()
Sets the threshold for *multikill_timeout* in terms of the percentage of nonresponsive threads required for the *multikill_timeout*. If not specified the default is 0.
.envoy.type.v3.Percent multikill_threshold = 5;getMultikillThresholdOrBuilder in interface WatchdogOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Watchdog parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Watchdog parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Watchdog parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Watchdog parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Watchdog parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Watchdog parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Watchdog parseFrom(InputStream input) throws IOException
IOExceptionpublic static Watchdog parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Watchdog parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Watchdog parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Watchdog parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Watchdog parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Watchdog.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Watchdog.Builder newBuilder()
public static Watchdog.Builder newBuilder(Watchdog prototype)
public Watchdog.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Watchdog.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Watchdog getDefaultInstance()
public static com.google.protobuf.Parser<Watchdog> parser()
public com.google.protobuf.Parser<Watchdog> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Watchdog getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2018–2021 The Envoy Project. All rights reserved.