envoyproxy/envoy

Add custom stat through configuration

Open

#37,523 opened on Dec 5, 2024

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

Repository metrics

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

Description

Title: Add a custom, static stat to Envoy’s stat output through configuration

Description: I want to be able to add a stat (metric) to envoy through configuration. For example a configuration of stat name 'foo' with fixed_value '1' would then be output a gauge like foo 1

          "stats_config": {
              "stats_tags": [
                  {
                      "tag_name": "environment",
                      "fixed_value": "prod"
                  }
              ],
# proposed new config key:
              "static_stats": [
                {
                   "stat_name": "foo",
                   "fixed_value": 1,
                }
              ]
          },

Above is an idea on where to put it, adjust the StatsConfig object https://www.envoyproxy.io/docs/envoy/v1.32.1/api-v3/config/metrics/v3/stats.proto.html#config-metrics-v3-statsconfig

Contributor guide

Research direction
Study the StatsConfig protobuf definition and the existing stats tags implementation, then add a new repeated field for static stats in the protobuf, and implement the logic to emit a gauge with the configured name and value.
Tech stack
None
Domain
backend
Issue type
Feature
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++ProtobufEnvoy architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60