[ZK filter] Add per-opcode decoder error metrics (envoyproxy#31138)

Signed-off-by: Zhewei Hu <zhu@pinterest.com>

api/envoy/extensions/filters/network/zookeeper_proxy/v3/zookeeper_proxy.proto

@@ -19,7 +19,7 @@ option (udpa.annotations.file_status).package_version_status = ACTIVE;
 // ZooKeeper Proxy :ref:`configuration overview <config_network_filters_zookeeper_proxy>`.
 // [#extension: envoy.filters.network.zookeeper_proxy]
 
-// [#next-free-field: 9]
+// [#next-free-field: 10]
 message ZooKeeperProxy {
   option (udpa.annotations.versioning).previous_message_type =
       "envoy.config.filter.network.zookeeper_proxy.v1alpha1.ZooKeeperProxy";
@@ -65,6 +65,9 @@ message ZooKeeperProxy {
 
   // Whether to emit per opcode response bytes metrics. If not set, it defaults to false.
   bool enable_per_opcode_response_bytes_metrics = 8;
+
+  // Whether to emit per opcode decoder error metrics. If not set, it defaults to false.
+  bool enable_per_opcode_decoder_error_metrics = 9;
 }
 
 message LatencyThresholdOverride {

changelogs/current.yaml

@@ -221,5 +221,9 @@ new_features:
     <envoy_v3_api_field_extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.access_log_options>`
     to allow recording an access log entry periodically for the UDP session, and allow recording an access
     log entry on the connection tunnel created successfully to upstream when UDP tunneling is configured.
+- area: zookeeper
+  change: |
+    Added support for emitting per opcode decoder error metrics via :ref:`enable_per_opcode_decoder_error_metrics
+    <envoy_v3_api_field_extensions.filters.network.zookeeper_proxy.v3.ZooKeeperProxy.enable_per_opcode_decoder_error_metrics>`.
 
 deprecated:

docs/root/configuration/listeners/network_filters/_include/zookeeper-filter-proxy.yaml

@@ -13,6 +13,7 @@ static_resources:
           stat_prefix: zookeeper
           enable_per_opcode_request_bytes_metrics: true
           enable_per_opcode_response_bytes_metrics: true
+          enable_per_opcode_decoder_error_metrics: true
           enable_latency_threshold_metrics: true
           default_latency_threshold: "0.1s"
           latency_threshold_overrides:

docs/root/configuration/listeners/network_filters/zookeeper_proxy_filter.rst

@@ -41,13 +41,43 @@ Every configured ZooKeeper proxy filter has statistics rooted at *<stat_prefix>.
 
 *_resp_bytes* are per-opcode metrics and will only be emitted when :ref:`enable_per_opcode_response_bytes_metrics <envoy_v3_api_field_extensions.filters.network.zookeeper_proxy.v3.ZooKeeperProxy.enable_per_opcode_response_bytes_metrics>` is set to ``true``.
 
+*_decoder_error* are per-opcode metrics and will only be emitted when :ref:`enable_per_opcode_decoder_error_metrics <envoy_v3_api_field_extensions.filters.network.zookeeper_proxy.v3.ZooKeeperProxy.enable_per_opcode_decoder_error_metrics>` is set to ``true``.
+
 The following counters are available:
 
 .. csv-table::
   :header: Name, Type, Description
   :widths: 1, 1, 2
 
   decoder_error, Counter, Number of times a message wasn't decoded
+  connect_decoder_error, Counter, Number of times a connect request message wasn't decoded
+  ping_decoder_error, Counter, Number of times a ping request message wasn't decoded
+  auth_decoder_error, Counter, Number of times a auth request message wasn't decoded
+  getdata_decoder_error, Counter, Number of times a getdata request message wasn't decoded
+  create_decoder_error, Counter, Number of times a create request message wasn't decoded
+  create2_decoder_error, Counter, Number of times a create2 request message wasn't decoded
+  createcontainer_decoder_error, Counter, Number of times a createcontainer request message wasn't decoded
+  createttl_decoder_error, Counter, Number of times a createttl request message wasn't decoded
+  setdata_decoder_error, Counter, Number of times a setdata request message wasn't decoded
+  getchildren_decoder_error, Counter, Number of times a getchildren request message wasn't decoded
+  getchildren2_decoder_error, Counter, Number of times a getchildren2 request message wasn't decoded
+  getephemerals_decoder_error, Counter, Number of times a getephemerals request message wasn't decoded
+  getallchildrennumber_decoder_error, Counter, Number of times a getallchildrennumber request message wasn't decoded
+  delete_decoder_error, Counter, Number of times a delete request message wasn't decoded
+  exists_decoder_error, Counter, Number of times a exists request message wasn't decoded
+  getacl_decoder_error, Counter, Number of times a getacl request message wasn't decoded
+  setacl_decoder_error, Counter, Number of times a setacl request message wasn't decoded
+  sync_decoder_error, Counter, Number of times a sync request message wasn't decoded
+  multi_decoder_error, Counter, Number of times a multi request message wasn't decoded
+  reconfig_decoder_error, Counter, Number of times a reconfig request message wasn't decoded
+  close_decoder_error, Counter, Number of times a close request message wasn't decoded
+  setauth_decoder_error, Counter, Number of times a setauth request message wasn't decoded
+  setwatches_decoder_error, Counter, Number of times a setwatches request message wasn't decoded
+  setwatches2_decoder_error, Counter, Number of times a setwatches2 request message wasn't decoded
+  addwatch_decoder_error, Counter, Number of times a addwatch request message wasn't decoded
+  checkwatches_decoder_error, Counter, Number of times a checkwatches request message wasn't decoded
+  removewatches_decoder_error, Counter, Number of times a removewatches request message wasn't decoded
+  check_decoder_error, Counter, Number of times a check request message wasn't decoded
   request_bytes, Counter, Number of bytes in decoded request messages
   connect_rq_bytes, Counter, Number of bytes in decoded connect request messages
   ping_rq_bytes, Counter, Number of bytes in decoded ping request messages

source/extensions/filters/network/zookeeper_proxy/config.cc

@@ -31,6 +31,8 @@ Network::FilterFactoryCb ZooKeeperConfigFactory::createFilterFactoryFromProtoTyp
       proto_config.enable_per_opcode_request_bytes_metrics();
   const bool enable_per_opcode_response_bytes_metrics =
       proto_config.enable_per_opcode_response_bytes_metrics();
+  const bool enable_per_opcode_decoder_error_metrics =
+      proto_config.enable_per_opcode_decoder_error_metrics();
   const bool enable_latency_threshold_metrics = proto_config.enable_latency_threshold_metrics();
   const std::chrono::milliseconds default_latency_threshold(
       PROTOBUF_GET_MS_OR_DEFAULT(proto_config, default_latency_threshold, 100));
@@ -49,8 +51,9 @@ Network::FilterFactoryCb ZooKeeperConfigFactory::createFilterFactoryFromProtoTyp
 
   ZooKeeperFilterConfigSharedPtr filter_config(std::make_shared<ZooKeeperFilterConfig>(
       stat_prefix, max_packet_bytes, enable_per_opcode_request_bytes_metrics,
-      enable_per_opcode_response_bytes_metrics, enable_latency_threshold_metrics,
-      default_latency_threshold, latency_threshold_overrides, context.scope()));
+      enable_per_opcode_response_bytes_metrics, enable_per_opcode_decoder_error_metrics,
+      enable_latency_threshold_metrics, default_latency_threshold, latency_threshold_overrides,
+      context.scope()));
   auto& time_source = context.getServerFactoryContext().mainThreadDispatcher().timeSource();
 
   return [filter_config, &time_source](Network::FilterManager& filter_manager) -> void {