Mongo proxy

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

config/filter/network/mongo_proxy/v2/mongo_proxy.proto

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.

Tip

This extension extends and can be used with the following extension category:

• envoy.filters.network

MongoDB configuration overview.

extensions.filters.network.mongo_proxy.v3.MongoProxy

[extensions.filters.network.mongo_proxy.v3.MongoProxy proto]

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

stat_prefix

(string, REQUIRED) The human readable prefix to use when emitting statistics.

access_log

(string) 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 runtime.

delay

(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.

emit_dynamic_metadata

(bool) Flag to specify whether dynamic metadata should be emitted. Defaults to false.

commands

(repeated string) 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.