Skip to content

Commit

Permalink
zh-translation: /configuration/listeners/stats.rst (envoyproxy#415)
Browse files Browse the repository at this point in the history
* zh-translation: /configuration/listeners/stats.rst

* zh-translation: /configuration/listeners/stats.rst, some minor fix according to feadback

* Fixed typo

* Fixed some more formats

* Translation adjustment
  • Loading branch information
hustshawn authored Dec 14, 2020
1 parent 303d70d commit 4d5a2dd
Showing 1 changed file with 52 additions and 58 deletions.
110 changes: 52 additions & 58 deletions docs/root/configuration/listeners/stats.rst
Original file line number Diff line number Diff line change
@@ -1,84 +1,78 @@
.. _config_listener_stats:

Statistics
统计
==========

Listener
监听器
--------

Every listener has a statistics tree rooted at *listener.<address>.* with the following statistics:

每个监听器都有一个以 *listener.<address>.* 为根的统计树,其中包含以下统计信息:

.. csv-table::
:header: Name, Type, Description
:header: 名称, 类型, 描述
:widths: 1, 1, 2

downstream_cx_total, Counter, Total connections
downstream_cx_destroy, Counter, Total destroyed connections
downstream_cx_active, Gauge, Total active connections
downstream_cx_length_ms, Histogram, Connection length milliseconds
downstream_cx_overflow, Counter, Total connections rejected due to enforcement of listener connection limit
downstream_pre_cx_timeout, Counter, Sockets that timed out during listener filter processing
downstream_pre_cx_active, Gauge, Sockets currently undergoing listener filter processing
global_cx_overflow, Counter, Total connections rejected due to enforecement of the global connection limit
no_filter_chain_match, Counter, Total connections that didn't match any filter chain
ssl.connection_error, Counter, Total TLS connection errors not including failed certificate verifications
ssl.handshake, Counter, Total successful TLS connection handshakes
ssl.session_reused, Counter, Total successful TLS session resumptions
ssl.no_certificate, Counter, Total successful TLS connections with no client certificate
ssl.fail_verify_no_cert, Counter, Total TLS connections that failed because of missing client certificate
ssl.fail_verify_error, Counter, Total TLS connections that failed CA verification
ssl.fail_verify_san, Counter, Total TLS connections that failed SAN verification
ssl.fail_verify_cert_hash, Counter, Total TLS connections that failed certificate pinning verification
ssl.ocsp_staple_failed, Counter, Total TLS connections that failed compliance with the OCSP policy
ssl.ocsp_staple_omitted, Counter, Total TLS connections that succeeded without stapling an OCSP response
ssl.ocsp_staple_responses, Counter, Total TLS connections where a valid OCSP response was available (irrespective of whether the client requested stapling)
ssl.ocsp_staple_requests, Counter, Total TLS connections where the client requested an OCSP staple
ssl.ciphers.<cipher>, Counter, Total successful TLS connections that used cipher <cipher>
ssl.curves.<curve>, Counter, Total successful TLS connections that used ECDHE curve <curve>
ssl.sigalgs.<sigalg>, Counter, Total successful TLS connections that used signature algorithm <sigalg>
ssl.versions.<version>, Counter, Total successful TLS connections that used protocol version <version>
downstream_cx_total, Counter, 连接总数
downstream_cx_destroy, Counter, 已销毁的连接总数
downstream_cx_active, Gauge, 活跃的连接总数
downstream_cx_length_ms, Histogram, 连接时长 (毫秒)
downstream_cx_overflow, Counter, 由于强制执行监听器连接限制而拒绝的连接总数
downstream_pre_cx_timeout, Counter, 在监听器过滤器处理过程中套接字的超时时间
downstream_pre_cx_active, Gauge, 当前正在接受监听器过滤器处理的套接字
global_cx_overflow, Counter, 由于强制全局连接限制而拒绝的连接总数
no_filter_chain_match, Counter, 与任何过滤器链都不匹配的连接总数
ssl.connection_error, Counter, TLS 连接错误总数,不包括证书认证失败
ssl.handshake, Counter, TLS 连接握手成功总数
ssl.session_reused, Counter, TLS 会话恢复成功总数
ssl.no_certificate, Counter, 不带客户端证书的 TLS 连接成功总数
ssl.fail_verify_no_cert, Counter, 因为缺少客户端证书而失败的 TLS 连接总数
ssl.fail_verify_error, Counter, CA 认证失败的 TLS 连接总数
ssl.fail_verify_san, Counter, SAN 认证失败的 TLS 连接总数
ssl.fail_verify_cert_hash, Counter, 认证 pinning 认证失败的 TLS 连接总数
ssl.ocsp_staple_failed, Counter, 未能符合 OCSP (Online Certificate Status Protocol) 策略的 TLS 连接总数
ssl.ocsp_staple_omitted, Counter, 未装订 OCSP 响应而成功完成的 TLS 连接总数
ssl.ocsp_staple_responses, Counter, 有效 OCSP 响应可用的 TLS 连接总数(无论客户端是否请求装订)
ssl.ocsp_staple_requests, Counter, 客户端请求 OCSP 装订的 TLS 连接总数
ssl.ciphers.<cipher>, Counter, 使用密码 <cipher> 的成功 TLS 连接总数
ssl.curves.<curve>, Counter, 使用 ECDHE 曲线 <curve> 的成功 TLS 连接总数
ssl.sigalgs.<sigalg>, Counter, 使用签名算法 <sigalg> 的成功 TLS 连接总数
ssl.versions.<version>, Counter, 使用协议版本 <version> 的成功 TLS 连接总数

.. _config_listener_stats_per_handler:

Per-handler Listener Stats
--------------------------
每个处理程序 (handler) 的监听器统计信息
--------------------------------------------

Every listener additionally has a statistics tree rooted at *listener.<address>.<handler>.* which
contains *per-handler* statistics. As described in the
:ref:`threading model <arch_overview_threading>` documentation, Envoy has a threading model which
includes the *main thread* as well as a number of *worker threads* which are controlled by the
:option:`--concurrency` option. Along these lines, *<handler>* is equal to *main_thread*,
*worker_0*, *worker_1*, etc. These statistics can be used to look for per-handler/worker imbalance
on either accepted or active connections.
每个监听器还有一个基于 *listener.<address>.<handler>.* 的统计树,它包含 *per-handler* 的统计信息。如 :ref:`线程模型 <arch_overview_threading>` 文档中所述,Envoy 的线程模型包括主线程以及由 --concurrency 选项控制的多个工作线程。按照这些原则,<handler> 等于 main_thread,worker_0,worker_1 等。这些统计信息可用于寻找接受或活动连接上每个处理程序/工作程序 (handler/worker) 的不平衡状况。

.. csv-table::
:header: Name, Type, Description
:header: 名称, 类型, 描述
:widths: 1, 1, 2

downstream_cx_total, Counter, Total connections on this handler.
downstream_cx_active, Gauge, Total active connections on this handler.
downstream_cx_total, Counter, 这个处理程序上的连接总数
downstream_cx_active, Gauge, 这个处理程序上活跃的连接总数

.. _config_listener_manager_stats:

Listener manager
----------------
监听器管理器
--------------------

The listener manager has a statistics tree rooted at *listener_manager.* with the following
statistics. Any ``:`` character in the stats name is replaced with ``_``.
监听管理器有一个以 *listener_manager.* 为根的统计树,其中包含以下统计信息:统计信息名称中的任何 ``:`` 字符均替换为 ``_``。

.. csv-table::
:header: Name, Type, Description
:header: 名称, 类型, 描述
:widths: 1, 1, 2

listener_added, Counter, Total listeners added (either via static config or LDS).
listener_modified, Counter, Total listeners modified (via LDS).
listener_removed, Counter, Total listeners removed (via LDS).
listener_stopped, Counter, Total listeners stopped.
listener_create_success, Counter, Total listener objects successfully added to workers.
listener_create_failure, Counter, Total failed listener object additions to workers.
listener_in_place_updated, Counter, Total listener objects created to execute filter chain update path.
total_filter_chains_draining, Gauge, Number of currently draining filter chains.
total_listeners_warming, Gauge, Number of currently warming listeners.
total_listeners_active, Gauge, Number of currently active listeners.
total_listeners_draining, Gauge, Number of currently draining listeners.
workers_started, Gauge, A boolean (1 if started and 0 otherwise) that indicates whether listeners have been initialized on workers.
listener_added, Counter, 添加的监听器总数(不管是通过静态配置还是 LDS)
listener_modified, Counter, 修改过的监听器总数(通过 LDS
listener_removed, Counter, 删除过的监听器总数(通过 LDS
listener_stopped, Counter, 停止的监听器总数
listener_create_success, Counter, 成功添加到 workers 的监听器对象总数
listener_create_failure, Counter, 添加到 workers 失败的监听器对象总数
listener_in_place_updated, Counter, 创建以执行过滤器链更新路径的监听器听器对象总数
total_filter_chains_draining, Gauge, 当前正在耗尽的过滤器链的数量
total_listeners_warming, Gauge, 当前预热的监听器数量
total_listeners_active, Gauge, 当前活动的监听器数量
total_listeners_draining, Gauge, 当前正在耗尽的监听器数量
workers_started, Gauge, 布尔值(如果已启动则为 1,否则为 0),指示是否已在 worker 上初始化监听器

0 comments on commit 4d5a2dd

Please sign in to comment.