Package io.envoyproxy.envoy.config.bootstrap.v2

Class Watchdog

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, WatchdogOrBuilder, Serializable
    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.
    Protobuf type envoy.config.bootstrap.v2.Watchdog
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Watchdog.Builder
      Envoy process watchdog configuration.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        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

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      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 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.
      com.google.protobuf.Duration getMultikillTimeout()
      If at least two watched threads have been nonresponsive for at least this duration assume a true deadlock and kill the entire Envoy process.
      com.google.protobuf.DurationOrBuilder getMultikillTimeoutOrBuilder()
      If at least two watched threads have been nonresponsive for at least this duration assume a true deadlock and 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 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 hasMultikillTimeout()
      If at least two watched threads have been nonresponsive for at least this duration assume a true deadlock and 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​(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 Watchdog parseFrom​(ByteBuffer data)  
      static Watchdog parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Watchdog> parser()  
      Watchdog.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, 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, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

    • Field Detail

      • MISS_TIMEOUT_FIELD_NUMBER

        public static final int MISS_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MEGAMISS_TIMEOUT_FIELD_NUMBER

        public static final int MEGAMISS_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • KILL_TIMEOUT_FIELD_NUMBER

        public static final int KILL_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MULTIKILL_TIMEOUT_FIELD_NUMBER

        public static final int MULTIKILL_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasMissTimeout

        public 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;
        Specified by:
        hasMissTimeout in interface WatchdogOrBuilder
        Returns:
        Whether the missTimeout field is set.

      • getMissTimeout

        public 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;
        Specified by:
        getMissTimeout in interface WatchdogOrBuilder
        Returns:
        The missTimeout.

      • getMissTimeoutOrBuilder

        public 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;
        Specified by:
        getMissTimeoutOrBuilder in interface WatchdogOrBuilder

      • hasMegamissTimeout

        public 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;
        Specified by:
        hasMegamissTimeout in interface WatchdogOrBuilder
        Returns:
        Whether the megamissTimeout field is set.

      • getMegamissTimeout

        public 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;
        Specified by:
        getMegamissTimeout in interface WatchdogOrBuilder
        Returns:
        The megamissTimeout.

      • getMegamissTimeoutOrBuilder

        public 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;
        Specified by:
        getMegamissTimeoutOrBuilder in interface WatchdogOrBuilder

      • hasKillTimeout

        public 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;
        Specified by:
        hasKillTimeout in interface WatchdogOrBuilder
        Returns:
        Whether the killTimeout field is set.

      • getKillTimeout

        public 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;
        Specified by:
        getKillTimeout in interface WatchdogOrBuilder
        Returns:
        The killTimeout.

      • getKillTimeoutOrBuilder

        public 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;
        Specified by:
        getKillTimeoutOrBuilder in interface WatchdogOrBuilder

      • hasMultikillTimeout

        public boolean hasMultikillTimeout()
         If at least two watched threads have been nonresponsive for at least this
 duration assume a true deadlock and 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;
        Specified by:
        hasMultikillTimeout in interface WatchdogOrBuilder
        Returns:
        Whether the multikillTimeout field is set.

      • getMultikillTimeout

        public com.google.protobuf.Duration getMultikillTimeout()
         If at least two watched threads have been nonresponsive for at least this
 duration assume a true deadlock and 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;
        Specified by:
        getMultikillTimeout in interface WatchdogOrBuilder
        Returns:
        The multikillTimeout.

      • getMultikillTimeoutOrBuilder

        public com.google.protobuf.DurationOrBuilder getMultikillTimeoutOrBuilder()
         If at least two watched threads have been nonresponsive for at least this
 duration assume a true deadlock and 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;
        Specified by:
        getMultikillTimeoutOrBuilder in interface WatchdogOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Watchdog parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Watchdog parseFrom​(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Watchdog parseFrom​(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Watchdog parseFrom​(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Watchdog parseFrom​(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Watchdog parseFrom​(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Watchdog parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Watchdog.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Watchdog.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Watchdog.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Watchdog getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Watchdog> parser()

      • getParserForType

        public com.google.protobuf.Parser<Watchdog> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Watchdog getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder