envoyproxy / envoyproxy/envoy

Metrics names in envoyproxy documentation

Open
#23,888 7 comments 0 reactions 1 assignee Claimed by @phlax View on GitHub
area/docs area/stats enhancement help wanted question
Dominant language
C++
Stars
28.9k
Forks
5.6k
Avg merge
1d 20h
Merged PRs (30d)
437

Description

*Metrics names in envoyproxy documentation*

*Description*:

I am currently investigating usage of envoyproxy metrics/statistics together with prometheus and Istio.
Envoyproxy has hundreds of metrics (statistics) but the names in the documentation are different to the once that are scraped by prometheus. In prometheus the metrics contain in addition to the documented statistics names different prefixes and other identifiers, like envoy_listener_manager_, envoy_cluster_manager_, envoy_cluster_, envoy_cluster_manager_cds_, envoy_cluster_http2_, (and more ...).
In the documentation I cannot find the information which prefixes are used for which metrics/statistics.

Is a list of prefixes in the documentation available?
Can the used prefixes be added to the statistics sections, like
https://www.envoyproxy.io/docs/envoy/latest/configuration/listeners/stats.html?highlight=stat_prefix#listener-manager

Statistics Name
Metrics Name

listener_added
envoy_listener_manager_listener_added

listener_modified
envoy_listener_manager_listener_modified

listener_removed
envoy_listener_manager_listener_removed

listener_stopped
envoy_listener_manager_listener_stopped

listener_create_success
envoy_listener_manager_listener_create_success

[optional *Relevant Links*:]
>Any extra documentation required to understand the issue.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.