envoyproxy/envoy

Request for improved details surrounding Envoy stats and metrics documentation

Open

#14,865 opened on Jan 29, 2021

View on GitHub
 (2 comments) (3 reactions) (0 assignees)C++ (5,373 forks)batch import
area/docshelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

Description

Title: Request for improved details surrounding stats and metrics documentation

Description: When customers are debugging issues such as connection resets failures (Contour/Envoy) deployment there have been requests for more in depth descriptions for metrics and statistics that are available in Envoy and documented on the Envoy page.

One example of this is the “upstream_cx_destroy_with_active_rq” metric. It is defined as "Total connections destroyed with 1+ active request". Also found an older issue where a similar request was made, specific to this metric, https://github.com/envoyproxy/envoy/issues/6455

A second example is the "upstream cx_open" stat, but it is not clear how connections are managed, when are they closed when are the reused, etc.

This request is general but provides two examples.

[optional Relevant Links:] https://www.envoyproxy.io/docs/envoy/latest/configuration/upstream/cluster_manager/cluster_stats https://www.envoyproxy.io/docs/envoy/v1.15.0/configuration/http/http_conn_man/stats#config-http-conn-man-stats

Contributor guide

Research direction
Locate the specific stat definitions in the Envoy documentation (e.g., upstream cx destroy with active rq) and enhance descriptions with details on when they occur and how to interpret them.
Tech stack
cpp
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
documentationenvoy
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80