USAGE:
/usr/bin/envoy [--stats-tag <string>] ... [--enable-core-dump]
[--socket-mode <string>] [--socket-path <string>]
[--disable-extensions <string>] [--cpuset-threads]
[--enable-mutex-tracing] [--disable-hot-restart] [--mode
<string>] [--parent-shutdown-time-s <uint32_t>]
[--drain-strategy <string>] [--drain-time-s <uint32_t>]
[--file-flush-interval-msec <uint32_t>] [--service-zone
<string>] [--service-node <string>] [--service-cluster
<string>] [--hot-restart-version] [--restart-epoch
<uint32_t>] [--log-path <string>]
[--enable-fine-grain-logging] [--log-format-escaped]
[--log-format <string>] [--component-log-level <string>]
[-l <string>] [--local-address-ip-version <string>]
[--admin-address-path <string>]
[--ignore-unknown-dynamic-fields]
[--reject-unknown-dynamic-fields]
[--allow-unknown-static-fields] [--allow-unknown-fields]
[--config-yaml <string>] [-c <string>] [--concurrency
<uint32_t>] [--base-id-path <string>]
[--use-dynamic-base-id] [--base-id <uint32_t>] [--]
[--version] [-h]
Where:
--stats-tag <string> (accepted multiple times)
This flag provides a universal tag for all stats generated by Envoy.
The format is ``tag:value``. Only alphanumeric values are allowed for
tag names. For tag values all characters are permitted except for '.'
(dot). This flag can be repeated multiple times to set multiple
universal tags. Multiple values for the same tag name are not
allowed.
--enable-core-dump
Enable core dumps
--socket-mode <string>
Socket file permission
--socket-path <string>
Path to hot restart socket file
--disable-extensions <string>
Comma-separated list of extensions to disable
--cpuset-threads
Get the default # of worker threads from cpuset size
--enable-mutex-tracing
Enable mutex contention tracing functionality
--disable-hot-restart
Disable hot restart functionality
--mode <string>
One of 'serve' (default; validate configs and then serve traffic
normally) or 'validate' (validate configs and exit).
--parent-shutdown-time-s <uint32_t>
Hot restart parent shutdown time in seconds
--drain-strategy <string>
Hot restart drain sequence behaviour, one of 'gradual' (default) or
'immediate'.
--drain-time-s <uint32_t>
Hot restart and LDS removal drain time in seconds
--file-flush-interval-msec <uint32_t>
Interval for log flushing in msec
--service-zone <string>
Zone name
--service-node <string>
Node name
--service-cluster <string>
Cluster name
--hot-restart-version
Hot restart compatibility version
--restart-epoch <uint32_t>
Hot restart epoch #
--log-path <string>
Path to logfile
--enable-fine-grain-logging
Logger mode: enable file level log control (Fine-Grain Logger) or not
--log-format-escaped
Escape c-style escape sequences in the application logs
--log-format <string>
Log message format in spdlog syntax (see
https://github.com/gabime/spdlog/wiki/3.-Custom-formatting)
Default is "[%Y-%m-%d %T.%e][%t][%l][%n] [%g:%#] %v"
--component-log-level <string>
Comma-separated list of component log levels. For example
upstream:debug,config:trace
-l <string>, --log-level <string>
Log levels: [trace][debug][info][warning
|warn][error][critical][off]
Default is [info]
--local-address-ip-version <string>
The local IP address version (v4 or v6).
--admin-address-path <string>
Admin address path
--ignore-unknown-dynamic-fields
Ignore unknown fields in dynamic configuration
--reject-unknown-dynamic-fields
Reject unknown fields in dynamic configuration
--allow-unknown-static-fields
Allow unknown fields in static configuration
--allow-unknown-fields
Allow unknown fields in static configuration (DEPRECATED)
--config-yaml <string>
Inline YAML configuration, merges with the contents of --config-path
-c <string>, --config-path <string>
Path to configuration file
--concurrency <uint32_t>
# of worker threads to run
--base-id-path <string>
Path to which the base ID is written
--use-dynamic-base-id
The server chooses a base ID dynamically. Supersedes a static base ID.
May not be used when the restart epoch is non-zero.
--base-id <uint32_t>
Base ID so that multiple envoys can run on the same host if needed
--, --ignore_rest
Ignores the rest of the labeled arguments following this flag.
--version
Displays version information and exits.
-h, --help
Displays usage information and exits.
envoy
Options (38)
| Option | Description | Source |
|---|---|---|
--stats-tag string | (accepted multiple times) This flag provides a universal tag for all stats generated by Envoy. | help |
--enable-core-dump | Enable core dumps | help |
--socket-mode string | Socket file permission | help |
--socket-path string | Path to hot restart socket file | help |
--disable-extensions string | Comma-separated list of extensions to disable | help |
--cpuset-threads | Get the default # of worker threads from cpuset size | help |
--enable-mutex-tracing | Enable mutex contention tracing functionality | help |
--disable-hot-restart | Disable hot restart functionality | help |
--mode string | One of 'serve' (default; | help |
--parent-shutdown-time-s uint32_t | Hot restart parent shutdown time in seconds | help |
--drain-strategy string | Hot restart drain sequence behaviour, one of 'gradual' (default) or 'immediate'. | help |
--drain-time-s uint32_t | Hot restart and LDS removal drain time in seconds | help |
--file-flush-interval-msec uint32_t | Interval for log flushing in msec | help |
--service-zone string | Zone name | help |
--service-node string | Node name | help |
--service-cluster string | Cluster name | help |
--hot-restart-version | Hot restart compatibility version | help |
--restart-epoch uint32_t | Hot restart epoch # | help |
--log-path string | Path to logfile | help |
--enable-fine-grain-logging | Logger mode: enable file level log control (Fine-Grain Logger) or not | help |
--log-format-escaped | Escape c-style escape sequences in the application logs | help |
--log-format string | Log message format in spdlog syntax (see https://github.com/gabime/spdlog/wiki/3.-Custom-formatting) | help |
--component-log-level string | Comma-separated list of component log levels. | help |
-l string | --log-level <string> Log levels: [trace][debug][info][warning |warn][error][critical][off] | help |
--local-address-ip-version string | The local IP address version (v4 or v6). | help |
--admin-address-path string | Admin address path | help |
--ignore-unknown-dynamic-fields | Ignore unknown fields in dynamic configuration | help |
--reject-unknown-dynamic-fields | Reject unknown fields in dynamic configuration | help |
--allow-unknown-static-fields | Allow unknown fields in static configuration | help |
--allow-unknown-fields | Allow unknown fields in static configuration (DEPRECATED) | help |
--config-yaml string | Inline YAML configuration, merges with the contents of --config-path | help |
-c string | --config-path <string> Path to configuration file | help |
--concurrency uint32_t | # of worker threads to run | help |
--base-id-path string | Path to which the base ID is written | help |
--use-dynamic-base-id | The server chooses a base ID dynamically. | help |
--base-id uint32_t | Base ID so that multiple envoys can run on the same host if needed | help |
--version | Displays version information and exits. | help |
-h | --help Displays usage information and exits. | help |