-
Notifications
You must be signed in to change notification settings - Fork 4.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f2e82e3
commit 7533c01
Showing
12 changed files
with
197 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
.. _arch_overview_threading: | ||
|
||
Threading model | ||
=============== | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,62 @@ | ||
Command line options | ||
==================== | ||
|
||
Envoy is driven both by a JSON configuration file as well as a set of command line options. The | ||
following are the command line options that Envoy supports. | ||
|
||
.. option:: -c <path string>, --config-path <path string> | ||
|
||
FIXFIX | ||
*(required)* The path to the :ref:`JSON configuration file <config>`. | ||
|
||
.. option:: --base-id <integer> | ||
|
||
FIXFIX | ||
*(optional)* The base ID to use when allocating shared memory regions. Envoy uses shared memory | ||
regions during :ref:`hot restart <arch_overview_hot_restart>`. Most users will never have to | ||
set this option. However, if Envoy needs to be run multiple times on the same machine, each | ||
running Envoy will need a unique base ID so that the shared memory regions do not conflict. | ||
|
||
.. option:: --concurrency <integer> | ||
|
||
FIXFIX | ||
*(optional)* The number of :ref:`worker threads <arch_overview_threading>` to run. If not | ||
specified defaults to the number of hardware threads on the machine. | ||
|
||
.. option:: -l <integer>, --log-level <integer> | ||
|
||
FIXFIX | ||
*(optional)* The logging level. Defaults to *NOTICE*. Non developers should never set this option. | ||
|
||
.. option:: --restart-epoch <integer> | ||
|
||
FIXFIX | ||
*(optional)* The :ref:`hot restart <arch_overview_hot_restart>` epoch. (The number of times | ||
Envoy has been hot restarted instead of a fresh start). Defaults to 0 for the first start. This | ||
option tells Envoy whether to attempt to create the shared memory region needed for hot restart, | ||
or whether to open an existing one. It should be incremented every time a hot restart takes place. | ||
The :ref:`hot restart wrapper <operations_hot_restarter>` sets the *RESTART_EPOCH* environment | ||
variable which should be passed to this option in most cases. | ||
|
||
.. option:: --hot-restart-version | ||
|
||
FIXFIX | ||
*(optional)* Outputs an opaque hot restart compatibility version for the binary. This can be | ||
matched against the output of the :http:get:`/hot_restart_version` admin endpoint to determine | ||
whether the new binary and the running binary are hot restart compatible. | ||
|
||
.. option:: --service-cluster <string> | ||
|
||
FIXFIX | ||
*(optional)* Defines the local service cluster name where Envoy is running. Though optional, | ||
it should be set if any of the following features are used: :ref:`statsd | ||
<arch_overview_statistics>`, :ref:`health check cluster verification | ||
<config_cluster_manager_cluster_hc_service_name>`, :ref:`runtime override directory | ||
<config_runtime_override_subdirectory>`, :ref:`user agent addition | ||
<config_http_conn_man_add_user_agent>`, :ref:`HTTP global rate limiting | ||
<config_http_filters_rate_limit>`, and :ref:`HTTP tracing <arch_overview_tracing>`. | ||
|
||
.. option:: --service-node <string> | ||
|
||
FIXFIX | ||
*(optional)* Defines the local service node name where Envoy is running. Though optional, | ||
it should be set if any of the following features are used: :ref:`statsd | ||
<arch_overview_statistics>`, and :ref:`HTTP tracing <arch_overview_tracing>`. | ||
|
||
.. option:: --service-zone <string> | ||
|
||
FIXFIX | ||
*(optional)* Defines the local service zone where Envoy is running. Though optional, it should | ||
be set if discovery service routing is used and the discovery service exposes :ref:`zone data | ||
<config_cluster_manager_sds_api_host_az>`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,13 @@ | ||
.. _operations_stats: | ||
|
||
Statistics overview | ||
=================== | ||
|
||
Envoy outputs numerous statistics which depend on how the server is configured. They can be seen | ||
locally via the :http:get:`/stats` command and are typically sent to a :ref:`statsd cluster | ||
<arch_overview_statistics>`. The statistics that are output are documented in the relevant | ||
sections of the :ref:`configuration guide <config>`. Some of the more important statistics that will | ||
almost always be used can be found in the following sections: | ||
|
||
* :ref:`HTTP connection manager <config_http_conn_man_stats>` | ||
* :ref:`Upstream cluster <config_cluster_manager_cluster_stats>` |