Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: cluster stats #18

Merged
merged 2 commits into from
Aug 17, 2016
Merged

docs: cluster stats #18

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f080799
docs: cluster stats
mattklein123 Aug 16, 2016
ba1111e
fix
mattklein123 Aug 17, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs: cluster stats
  • Loading branch information
@mattklein123
mattklein123 committed Aug 16, 2016
commit f0807996f8da1f9ae3b84f02fa676494de443838
23 changes: 19 additions & 4 deletions docs/configuration/cluster_manager/cluster_stats.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ If health check is configured, the cluster has an additional statistics tree roo
:header: Name, Type, Description
:widths: 1, 1, 2

attempt, Counter, Total number of health checks
attempt, Counter, Number of health checks
success, Counter, Number of successful health checks
failure, Counter, Number of failed health checks
timeout, Counter, Number of timed out health checks
Expand All @@ -78,17 +78,32 @@ Dynamic HTTP statistics

If HTTP is used, dynamic HTTP response code statistics are also available. These are emitted by
various internal systems as well as some filters such as the :ref:`router filter
<config_http_filters_router>` and :ref:`rate limit filter <config_http_filters_rate_limit>`.
<config_http_filters_router>` and :ref:`rate limit filter <config_http_filters_rate_limit>`. They
are rooted at *cluster.<name>.* and contain the following statistics:

.. csv-table::
:header: Name, Type, Description
:widths: 1, 1, 2

stat1, Counter, Description
upstream_rq_<\*xx>, Counter, "Aggregate HTTP response codes (e.g., 2xx, 3xx, etc.)"
upstream_rq<\*>, Counter, "Specific HTTP response codes (e.g., 201, 302, etc.)"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why no _ before the <*>? I would then think the stat is upstream_rq201 instead of upstream_rq_201

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo, will fix

upstream_rq_time, Timer, Request time milliseconds
canary.upstream_rq_<\*xx>, Counter, Upstream canary aggregate HTTP response codes
canary.upstream_rq<\*>, Counter, Upstream canary specific HTTP response codes
canary.upstream_rq_time, Timer, Upstream canary request time milliseconds
internal.upstream_rq_<\*xx>, Counter, Internal origin aggregate HTTP response codes
internal.upstream_rq<\*>, Counter, Internal origin specific HTTP response codes
internal.upstream_rq_time, Timer, Internal origin request time milliseconds
external.upstream_rq_<\*xx>, Counter, External origin aggregate HTTP response codes
external.upstream_rq<\*>, Counter, External origin specific HTTP response codes
external.upstream_rq_time, Timer, External origin request time milliseconds

.. _config_cluster_manager_cluster_stats_alt_tree:

Alternate tree dynamic HTTP statistics
--------------------------------------

FIXFIX
If alternate tree statistics are configured, they will be present in the
*cluster.<name>.<alt name>.* namespace. The statistics produced are the same as documented in
the dynamic HTTP statistics section :ref:`above
<config_cluster_manager_cluster_stats_dynamic_http>`.
12 changes: 11 additions & 1 deletion docs/configuration/http_conn_man/stats.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,14 @@ statistics:
Per user agent statistics
-------------------------

FIXFIX
Additional per user agent statistics are rooted at *http.<stat_prefix>.user_agent.<user_agent>.*
Currently Envoy matches user agent for both iOS (*ios*) and Android (*android*) and produces
the following statistics:

.. csv-table::
:header: Name, Type, Description
:widths: 1, 1, 2

downstream_cx_total, Counter, Total connections
downstream_cx_destroy_remote_active_rq, Counter, Total connections destroyed remotely with 1+ active requests
downstream_rq_total, Counter, Total requests
15 changes: 15 additions & 0 deletions docs/configuration/http_filters/router_filter.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,9 @@ responses.
Statistics
----------

The router outputs many statistics in the cluster namespace (depending on the cluster specified in
the chosen route). See :ref:`here <config_cluster_manager_cluster_stats>` for more information.

The router filter outputs statistics in the *http.<stat_prefix>.* namespace. The :ref:`stat
prefix <config_http_conn_man_stat_prefix>` comes from the owning HTTP connection manager.

Expand All @@ -158,6 +161,18 @@ prefix <config_http_conn_man_stat_prefix>` comes from the owning HTTP connection
rq_redirect, Counter, Total requests that resulted in a redirect response
rq_total, Counter, Total routed requests

Virtual cluster statistics are output in the
*vhost.<virtual host name>.vcluster.<virtual cluster name>.* namespace and include the following
statistics:

.. csv-table::
:header: Name, Type, Description
:widths: 1, 1, 2

upstream_rq_<\*xx>, Counter, "Aggregate HTTP response codes (e.g., 2xx, 3xx, etc.)"
upstream_rq<\*>, Counter, "Specific HTTP response codes (e.g., 201, 302, etc.)"
upstream_rq_time, Timer, Request time milliseconds

Runtime
-------

Expand Down