Package io.envoyproxy.envoy.extensions.filters.network.zookeeper_proxy.v3

Interface ZooKeeperProxyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ZooKeeperProxy, ZooKeeperProxy.Builder
public interface ZooKeeperProxyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getStatPrefix

      String getStatPrefix()
       The human readable prefix to use when emitting :ref:`statistics
 <config_network_filters_zookeeper_proxy_stats>`.
      string stat_prefix = 1 [(.validate.rules) = { ... }
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      com.google.protobuf.ByteString getStatPrefixBytes()
       The human readable prefix to use when emitting :ref:`statistics
 <config_network_filters_zookeeper_proxy_stats>`.
      string stat_prefix = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for statPrefix.

    • getAccessLog

      String getAccessLog()
       [#not-implemented-hide:] The optional path to use for writing ZooKeeper access logs.
 If the access log field is empty, access logs will not be written.
      string access_log = 2;
      Returns:
      The accessLog.

    • getAccessLogBytes

      com.google.protobuf.ByteString getAccessLogBytes()
       [#not-implemented-hide:] The optional path to use for writing ZooKeeper access logs.
 If the access log field is empty, access logs will not be written.
      string access_log = 2;
      Returns:
      The bytes for accessLog.

    • hasMaxPacketBytes

      boolean hasMaxPacketBytes()
       Messages — requests, responses and events — that are bigger than this value will
 be ignored. If it is not set, the default value is 1Mb.

 The value here should match the jute.maxbuffer property in your cluster configuration:

 https://zookeeper.apache.org/doc/r3.4.10/zookeeperAdmin.html#Unsafe+Options

 if that is set. If it isn't, ZooKeeper's default is also 1Mb.
      .google.protobuf.UInt32Value max_packet_bytes = 3;
      Returns:
      Whether the maxPacketBytes field is set.

    • getMaxPacketBytes

      com.google.protobuf.UInt32Value getMaxPacketBytes()
       Messages — requests, responses and events — that are bigger than this value will
 be ignored. If it is not set, the default value is 1Mb.

 The value here should match the jute.maxbuffer property in your cluster configuration:

 https://zookeeper.apache.org/doc/r3.4.10/zookeeperAdmin.html#Unsafe+Options

 if that is set. If it isn't, ZooKeeper's default is also 1Mb.
      .google.protobuf.UInt32Value max_packet_bytes = 3;
      Returns:
      The maxPacketBytes.

    • getMaxPacketBytesOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getMaxPacketBytesOrBuilder()
       Messages — requests, responses and events — that are bigger than this value will
 be ignored. If it is not set, the default value is 1Mb.

 The value here should match the jute.maxbuffer property in your cluster configuration:

 https://zookeeper.apache.org/doc/r3.4.10/zookeeperAdmin.html#Unsafe+Options

 if that is set. If it isn't, ZooKeeper's default is also 1Mb.
      .google.protobuf.UInt32Value max_packet_bytes = 3;

    • getEnableLatencyThresholdMetrics

      boolean getEnableLatencyThresholdMetrics()
       Whether to emit latency threshold metrics. If not set, it defaults to false.
 If false, setting ``default_latency_threshold`` and ``latency_threshold_overrides`` will not have effect.
      bool enable_latency_threshold_metrics = 4;
      Returns:
      The enableLatencyThresholdMetrics.

    • hasDefaultLatencyThreshold

      boolean hasDefaultLatencyThreshold()
       The default latency threshold to decide the fast/slow responses and emit metrics (used for error budget calculation).

 https://sre.google/workbook/implementing-slos/

 If it is not set, the default value is 100 milliseconds.
      .google.protobuf.Duration default_latency_threshold = 5 [(.validate.rules) = { ... }
      Returns:
      Whether the defaultLatencyThreshold field is set.

    • getDefaultLatencyThreshold

      com.google.protobuf.Duration getDefaultLatencyThreshold()
       The default latency threshold to decide the fast/slow responses and emit metrics (used for error budget calculation).

 https://sre.google/workbook/implementing-slos/

 If it is not set, the default value is 100 milliseconds.
      .google.protobuf.Duration default_latency_threshold = 5 [(.validate.rules) = { ... }
      Returns:
      The defaultLatencyThreshold.

    • getDefaultLatencyThresholdOrBuilder

      com.google.protobuf.DurationOrBuilder getDefaultLatencyThresholdOrBuilder()
       The default latency threshold to decide the fast/slow responses and emit metrics (used for error budget calculation).

 https://sre.google/workbook/implementing-slos/

 If it is not set, the default value is 100 milliseconds.
      .google.protobuf.Duration default_latency_threshold = 5 [(.validate.rules) = { ... }

    • getLatencyThresholdOverridesList

      List<LatencyThresholdOverride> getLatencyThresholdOverridesList()
       List of latency threshold overrides for opcodes.
 If the threshold override of one opcode is not set, it will fallback to the default latency
 threshold.
 Specifying latency threshold overrides multiple times for one opcode is not allowed.
      repeated .envoy.extensions.filters.network.zookeeper_proxy.v3.LatencyThresholdOverride latency_threshold_overrides = 6;

    • getLatencyThresholdOverrides

      LatencyThresholdOverride getLatencyThresholdOverrides(int index)
       List of latency threshold overrides for opcodes.
 If the threshold override of one opcode is not set, it will fallback to the default latency
 threshold.
 Specifying latency threshold overrides multiple times for one opcode is not allowed.
      repeated .envoy.extensions.filters.network.zookeeper_proxy.v3.LatencyThresholdOverride latency_threshold_overrides = 6;

    • getLatencyThresholdOverridesCount

      int getLatencyThresholdOverridesCount()
       List of latency threshold overrides for opcodes.
 If the threshold override of one opcode is not set, it will fallback to the default latency
 threshold.
 Specifying latency threshold overrides multiple times for one opcode is not allowed.
      repeated .envoy.extensions.filters.network.zookeeper_proxy.v3.LatencyThresholdOverride latency_threshold_overrides = 6;

    • getLatencyThresholdOverridesOrBuilderList

      List<? extends LatencyThresholdOverrideOrBuilder> getLatencyThresholdOverridesOrBuilderList()
       List of latency threshold overrides for opcodes.
 If the threshold override of one opcode is not set, it will fallback to the default latency
 threshold.
 Specifying latency threshold overrides multiple times for one opcode is not allowed.
      repeated .envoy.extensions.filters.network.zookeeper_proxy.v3.LatencyThresholdOverride latency_threshold_overrides = 6;

    • getLatencyThresholdOverridesOrBuilder

      LatencyThresholdOverrideOrBuilder getLatencyThresholdOverridesOrBuilder(int index)
       List of latency threshold overrides for opcodes.
 If the threshold override of one opcode is not set, it will fallback to the default latency
 threshold.
 Specifying latency threshold overrides multiple times for one opcode is not allowed.
      repeated .envoy.extensions.filters.network.zookeeper_proxy.v3.LatencyThresholdOverride latency_threshold_overrides = 6;

    • getEnablePerOpcodeRequestBytesMetrics

      boolean getEnablePerOpcodeRequestBytesMetrics()
       Whether to emit per opcode request bytes metrics. If not set, it defaults to false.
      bool enable_per_opcode_request_bytes_metrics = 7;
      Returns:
      The enablePerOpcodeRequestBytesMetrics.

    • getEnablePerOpcodeResponseBytesMetrics

      boolean getEnablePerOpcodeResponseBytesMetrics()
       Whether to emit per opcode response bytes metrics. If not set, it defaults to false.
      bool enable_per_opcode_response_bytes_metrics = 8;
      Returns:
      The enablePerOpcodeResponseBytesMetrics.

    • getEnablePerOpcodeDecoderErrorMetrics

      boolean getEnablePerOpcodeDecoderErrorMetrics()
       Whether to emit per opcode decoder error metrics. If not set, it defaults to false.
      bool enable_per_opcode_decoder_error_metrics = 9;
      Returns:
      The enablePerOpcodeDecoderErrorMetrics.