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.

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: reorganize configuration tree #8027

Merged
merged 1 commit into from
Aug 23, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions docs/root/configuration/advanced/advanced.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Advanced
========

.. toctree::
:maxdepth: 2

well_known_dynamic_metadata
25 changes: 8 additions & 17 deletions docs/root/configuration/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,12 @@ Configuration reference

overview/v2_overview
listeners/listeners
listener_filters/listener_filters
network_filters/network_filters
http_conn_man/http_conn_man
http_filters/http_filters
thrift_filters/thrift_filters
dubbo_filters/dubbo_filters
cluster_manager/cluster_manager
health_checkers/health_checkers
access_log
rate_limit
runtime
statistics
xds_subscription_stats
tools/router_check
overload_manager/overload_manager
secret
well_known_dynamic_metadata
http/http
upstream/upstream
observability/observability
security/security
operations/operations
other_features/other_features
other_protocols/other_protocols
advanced/advanced
best_practices/best_practices
8 changes: 8 additions & 0 deletions docs/root/configuration/http/http.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
HTTP
====

.. toctree::
:maxdepth: 2

http_conn_man/http_conn_man
http_filters/http_filters
2 changes: 2 additions & 0 deletions docs/root/configuration/listeners/listeners.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,6 @@ Listeners

overview
stats
listener_filters/listener_filters
network_filters/network_filters
lds
8 changes: 8 additions & 0 deletions docs/root/configuration/observability/observability.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Observability
=============

.. toctree::
:maxdepth: 2

statistics
access_log
9 changes: 9 additions & 0 deletions docs/root/configuration/operations/operations.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Operations
==========

.. toctree::
:maxdepth: 2

runtime
overload_manager/overload_manager
tools/router_check
7 changes: 7 additions & 0 deletions docs/root/configuration/other_features/other_features.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Other features
==============

.. toctree::
:maxdepth: 2

rate_limit
8 changes: 8 additions & 0 deletions docs/root/configuration/other_protocols/other_protocols.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Other protocols
===============

.. toctree::
:maxdepth: 2

thrift_filters/thrift_filters
dubbo_filters/dubbo_filters
24 changes: 24 additions & 0 deletions docs/root/configuration/overview/v2_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -599,6 +599,30 @@ Management Server has a statistics tree rooted at *control_plane.* with the foll
rate_limit_enforced, Counter, Total number of times rate limit was enforced for management server requests
pending_requests, Gauge, Total number of pending requests when the rate limit was enforced

.. _subscription_statistics:

xDS subscription statistics
---------------------------

Envoy discovers its various dynamic resources via discovery
services referred to as *xDS*. Resources are requested via :ref:`subscriptions <xds_protocol>`,
by specifying a filesystem path to watch, initiating gRPC streams or polling a REST-JSON URL.

The following statistics are generated for all subscriptions.

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

config_reload, Counter, Total API fetches that resulted in a config reload due to a different config
init_fetch_timeout, Counter, Total :ref:`initial fetch timeouts <envoy_api_field_core.ConfigSource.initial_fetch_timeout>`
update_attempt, Counter, Total API fetches attempted
update_success, Counter, Total API fetches completed successfully
update_failure, Counter, Total API fetches that failed because of network errors
update_rejected, Counter, Total API fetches that failed because of schema/validation errors
version, Gauge, Hash of the contents from the last successful API fetch
control_plane.connected_state, Gauge, A boolean (1 for connected and 0 for disconnected) that indicates the current connection state with management server

.. _config_overview_v2_status:

Status
Expand Down
7 changes: 7 additions & 0 deletions docs/root/configuration/security/security.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Security
========

.. toctree::
:maxdepth: 2

secret
8 changes: 8 additions & 0 deletions docs/root/configuration/upstream/upstream.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Upstream clusters
=================

.. toctree::
:maxdepth: 2

cluster_manager/cluster_manager
health_checkers/health_checkers
23 changes: 0 additions & 23 deletions docs/root/configuration/xds_subscription_stats.rst

This file was deleted.