////
This file is generated! See scripts/mage/docs_collector.go
////

:modulename: envoyproxy

[[metricbeat-module-envoyproxy]]
== Envoyproxy module

This is the envoyproxy module.

The default metricset is `server`.

[float]
=== Compatibility

The envoyproxy module is tested with Envoy 1.7.0 and 1.12.0.


[float]
=== Example configuration

The Envoyproxy module supports the standard configuration options that are described
in <<configuration-metricbeat>>. Here is an example configuration:

[source,yaml]
----
metricbeat.modules:
- module: envoyproxy
  metricsets: ["server"]
  period: 10s
  hosts: ["localhost:9901"]
----

This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets

The following metricsets are available:

* <<metricbeat-metricset-envoyproxy-server,server>>

include::envoyproxy/server.asciidoc[]

