.. _envoy_v3_api_file_envoy/extensions/filters/network/mongo_proxy/v3/mongo_proxy.proto:

Mongo proxy
===========

.. _extension_envoy.filters.network.mongo_proxy:


This extension may be referenced by the qualified name *envoy.filters.network.mongo_proxy*

.. note::
  

  This extension is not hardened and should only be used in deployments where both the downstream and upstream are trusted.

MongoDB :ref:`configuration overview <config_network_filters_mongo_proxy>`.

.. _envoy_v3_api_msg_extensions.filters.network.mongo_proxy.v3.MongoProxy:

extensions.filters.network.mongo_proxy.v3.MongoProxy
----------------------------------------------------

`[extensions.filters.network.mongo_proxy.v3.MongoProxy proto] <https://github.com/envoyproxy/envoy/blob/v1.17.4/api/envoy/extensions/filters/network/mongo_proxy/v3/mongo_proxy.proto#L20>`_


.. code-block:: json

  {
    "stat_prefix": "...",
    "access_log": "...",
    "delay": "{...}",
    "emit_dynamic_metadata": "...",
    "commands": []
  }

.. _envoy_v3_api_field_extensions.filters.network.mongo_proxy.v3.MongoProxy.stat_prefix:

stat_prefix
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) The human readable prefix to use when emitting :ref:`statistics
  <config_network_filters_mongo_proxy_stats>`.
  
  
.. _envoy_v3_api_field_extensions.filters.network.mongo_proxy.v3.MongoProxy.access_log:

access_log
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) The optional path to use for writing Mongo access logs. If not access log
  path is specified no access logs will be written. Note that access log is
  also gated :ref:`runtime <config_network_filters_mongo_proxy_runtime>`.
  
  
.. _envoy_v3_api_field_extensions.filters.network.mongo_proxy.v3.MongoProxy.delay:

delay
  (:ref:`extensions.filters.common.fault.v3.FaultDelay <envoy_v3_api_msg_extensions.filters.common.fault.v3.FaultDelay>`) Inject a fixed delay before proxying a Mongo operation. Delays are
  applied to the following MongoDB operations: Query, Insert, GetMore,
  and KillCursors. Once an active delay is in progress, all incoming
  data up until the timer event fires will be a part of the delay.
  
  
.. _envoy_v3_api_field_extensions.filters.network.mongo_proxy.v3.MongoProxy.emit_dynamic_metadata:

emit_dynamic_metadata
  (`bool <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Flag to specify whether :ref:`dynamic metadata
  <config_network_filters_mongo_proxy_dynamic_metadata>` should be emitted. Defaults to false.
  
  
.. _envoy_v3_api_field_extensions.filters.network.mongo_proxy.v3.MongoProxy.commands:

commands
  (**repeated** `string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) List of commands to emit metrics for. Defaults to "delete", "insert", and "update".
  Note that metrics will not be emitted for "find" commands, since those are considered
  queries, and metrics for those are emitted under a dedicated "query" namespace.