Support Gauge in Stats AccessLogger by TAOXUY · Pull Request #42226 · envoyproxy/envoy

TAOXUY · 2025-11-24T20:32:26Z

Description
This PR adds support for Gauges in the Stats AccessLogger.

Changes
Gauge Operations: Added support for three operations: SET, PAIRED_ADD, and PAIRED_SUBTRACT.

Configuration: Updated the stats.proto to include the new Gauge configuration options.

Risk Level
Low. The changes are focused on extending the Stats AccessLogger functionality and include specific handling to maintain backward compatibility for existing counter/histogram eviction logic.

Testing
Unit Tests: Added to verify the new gauge operations and eviction logic.

Integration Tests: Added to ensure end-to-end functionality within the access logging pipeline.

Documentation & Release Notes
Docs: Updated Protobuf comments to reflect new operations and memory overhead considerations.

Release Notes: Updated to include this new feature.

repokitteh-read-only · 2025-11-24T20:32:36Z

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to (api/envoy/|docs/root/api-docs/).
envoyproxy/api-shepherds assignee is @mattklein123
CC @envoyproxy/api-watchers: FYI only for changes made to (api/envoy/|docs/root/api-docs/).

🐱

Caused by: #42226 was opened by TAOXUY.

see: more, trace.

TAOXUY · 2025-11-24T20:33:20Z

@kyessenov

mattklein123

/wait

ggreenway

/wait

Signed-off-by: Xuyang Tao <taoxuy@google.com>

TAOXUY · 2026-02-11T01:08:17Z

All comments are resolved. PTAL

Signed-off-by: Xuyang Tao <taoxuy@google.com>

Change-Id: Ib8485b0d970f05dc9e4f93b01f8dfd81c54662dd Commit Message: Add ability to log connection starts in TCP proxy. This coupled with envoyproxy#42226 should provide "almost" exact active connection gauge. (The problematic edge case is when a prior filter stops iteration in `onNewConnection` or a disconnect happens prior to reaching `tcp_proxy` - that requires unusual config). Risk Level: low Testing: added Docs Changes: yes Release Notes: yes --------- Signed-off-by: Kuat Yessenov <kuat@google.com>

Signed-off-by: Xuyang Tao <taoxuy@google.com>

TAOXUY · 2026-02-11T17:39:28Z

All comments are resolved. PTAL

ggreenway · 2026-02-11T17:53:22Z

+                           Stats::Gauge::ImportMode) -> Stats::Gauge& {
+        EXPECT_TRUE(tags.has_value());
+        if (tags) {
+          EXPECT_EQ(tags->get().size(), saved_tags.size());


Please check that both the name, and the values of the tags, are identical. They need to be in the same order. If any of the parameters are different, you'll get a different stat, and that means this code didn't work.

TAOXUY · 2026-02-05T05:57:22Z


 private:
-  absl::flat_hash_set<Stats::Gauge*> inflight_gauges_;
+  absl::flat_hash_map<Stats::Gauge*, uint64_t> inflight_gauges_;


Though refcount can help with gauge liveness, we don't want eviction as we want the previous value be kept.

TAOXUY · 2026-02-05T19:37:11Z

 //   stat sinks by sending too many unique metrics.
-
+//
+//   It is required to use a delta stat sink (e.g. OpenTelemetry) because this


Allow ScopeStatsLimitSettings make sense

Let's make the default as: delta counter/histogram and accumulated gauge

And we can extend in the following PR to support : accumulated counter/histogram

I will add TODO and update the comment if that sounds good to u.

TAOXUY · 2026-02-06T18:32:47Z

+      // iv). If the PAIRED_ADD operation was executed, the
+      // PAIRED_SUBTRACT will happen when the stream/connection is closed, even
+      // if the configured log type didn't happen.
+      enum OperationType {


I am fine with either. One thing is maybe PAIRED_ADD and PAIRD_SUBTRACT is more open to be evolved to support non-paired one.

@wbpcode WDYT?

TAOXUY · 2026-02-10T23:28:37Z

+      // iv). If the PAIRED_ADD operation was executed, the
+      // PAIRED_SUBTRACT will happen when the stream/connection is closed, even
+      // if the configured log type didn't happen.
+      enum OperationType {


TAOXUY · 2026-02-11T00:59:05Z

  void initialize(const envoy::extensions::access_loggers::stats::v3::Config& config) {
+    // The gauge is a member of store_, so we need to increment the ref count to prevent it from
+    // being deleted when the shared_ptr in AccessLogState is destroyed.
+    store_.gauge_.incRefCount();


Signed-off-by: Xuyang Tao <taoxuy@google.com>

TAOXUY · 2026-02-11T19:48:05Z

@ggreenway all comments are resolved

TAOXUY · 2026-02-11T20:04:05Z

/retest

Signed-off-by: Xuyang Tao <taoxuy@google.com>

ggreenway · 2026-02-11T20:55:06Z

@wbpcode can you do a final API signoff?

wbpcode · 2026-02-12T02:09:12Z

+    message PairedAddSubtract {
+      // The access log type to trigger the add operation.
+      data.accesslog.v3.AccessLogType add_log_type = 1
+          [(validate.rules).enum = {defined_only: true}];
+
+      // The access log type to trigger the subtract operation.
+      data.accesslog.v3.AccessLogType sub_log_type = 2
+          [(validate.rules).enum = {defined_only: true}];


is that possible in the future that multiple log type will map to single operation?

I think it is feasible.

For Gauge PairedAddSubtract, you can still defined multiple gauges with the same config except log type pairs.

Dismiss request change from Matt because the context is out of time.

**Description** This PR adds support for Gauges in the Stats AccessLogger. **Changes** Gauge Operations: Added support for three operations: SET, PAIRED_ADD, and PAIRED_SUBTRACT. Configuration: Updated the [stats.proto](https://www.google.com/search?q=https://github.com/envoyproxy/envoy/pull/42226/files%23diff-4581f1e9c20a6e6259d646736480c54178308378619379854721789781878345) to include the new Gauge configuration options. **Risk Level** Low. The changes are focused on extending the Stats AccessLogger functionality and include specific handling to maintain backward compatibility for existing counter/histogram eviction logic. **Testing** Unit Tests: Added to verify the new gauge operations and eviction logic. Integration Tests: Added to ensure end-to-end functionality within the access logging pipeline. **Documentation & Release Notes** Docs: Updated Protobuf comments to reflect new operations and memory overhead considerations. **Release Notes**: Updated to include this new feature. --------- Signed-off-by: Xuyang Tao <taoxuy@google.com> Signed-off-by: nick <nickshokri@google.com>

Change-Id: Ib8485b0d970f05dc9e4f93b01f8dfd81c54662dd Commit Message: Add ability to log connection starts in TCP proxy. This coupled with envoyproxy#42226 should provide "almost" exact active connection gauge. (The problematic edge case is when a prior filter stops iteration in `onNewConnection` or a disconnect happens prior to reaching `tcp_proxy` - that requires unusual config). Risk Level: low Testing: added Docs Changes: yes Release Notes: yes --------- Signed-off-by: Kuat Yessenov <kuat@google.com> Signed-off-by: Gustavo <grnmeira@gmail.com>

**Description** This PR adds support for Gauges in the Stats AccessLogger. **Changes** Gauge Operations: Added support for three operations: SET, PAIRED_ADD, and PAIRED_SUBTRACT. Configuration: Updated the [stats.proto](https://www.google.com/search?q=https://github.com/envoyproxy/envoy/pull/42226/files%23diff-4581f1e9c20a6e6259d646736480c54178308378619379854721789781878345) to include the new Gauge configuration options. **Risk Level** Low. The changes are focused on extending the Stats AccessLogger functionality and include specific handling to maintain backward compatibility for existing counter/histogram eviction logic. **Testing** Unit Tests: Added to verify the new gauge operations and eviction logic. Integration Tests: Added to ensure end-to-end functionality within the access logging pipeline. **Documentation & Release Notes** Docs: Updated Protobuf comments to reflect new operations and memory overhead considerations. **Release Notes**: Updated to include this new feature. --------- Signed-off-by: Xuyang Tao <taoxuy@google.com>

TAOXUY requested review from ggreenway, kyessenov and wbpcode as code owners November 24, 2025 20:32

repokitteh-read-only Bot added the api label Nov 24, 2025

repokitteh-read-only Bot assigned mattklein123 Nov 24, 2025

TAOXUY changed the title ~~AccessLogger: support Gauge in access_loggers.stats~~ Support Gauge in access_loggers.stats Nov 24, 2025

mattklein123 previously requested changes Nov 27, 2025

View reviewed changes

Comment thread api/envoy/extensions/access_loggers/stats/v3/stats.proto Outdated

repokitteh-read-only Bot added the waiting label Nov 27, 2025

ggreenway requested changes Dec 1, 2025

View reviewed changes

Comment thread api/envoy/extensions/access_loggers/stats/v3/stats.proto Outdated

Comment thread changelogs/current.yaml Outdated

repokitteh-read-only Bot removed the waiting label Dec 1, 2025

ggreenway reviewed Dec 1, 2025

View reviewed changes

Comment thread api/envoy/extensions/access_loggers/stats/v3/stats.proto Outdated

mattklein123 assigned ggreenway Dec 8, 2025

TAOXUY changed the title ~~Support Gauge in access_loggers.stats~~ [WIP]Support Gauge in access_loggers.stats Dec 8, 2025

ggreenway added the waiting label Dec 11, 2025

TAOXUY mentioned this pull request Dec 18, 2025

accesslog: support stat-level AccessLogFilter in stats AccessLog #42676

Closed

TAOXUY added 5 commits December 22, 2025 19:01

support gauges

764fcec

Signed-off-by: Xuyang Tao <taoxuy@google.com>

fix comment

22340f5

Signed-off-by: Xuyang Tao <taoxuy@google.com>

nit

7f3dd5a

Signed-off-by: Xuyang Tao <taoxuy@google.com>

nit

46a9b7f

Signed-off-by: Xuyang Tao <taoxuy@google.com>

remove log type

182adc7

Signed-off-by: Xuyang Tao <taoxuy@google.com>

TAOXUY force-pushed the gauge branch from 5fedcdd to 182adc7 Compare December 22, 2025 19:11

repokitteh-read-only Bot removed the waiting label Dec 22, 2025

TAOXUY changed the title ~~[WIP]Support Gauge in access_loggers.stats~~ Support Gauge in access_loggers.stats Dec 22, 2025

TAOXUY changed the title ~~Support Gauge in access_loggers.stats~~ Support Gauge in Stats AccessLogger Dec 22, 2025

fix

70c18fb

Signed-off-by: Xuyang Tao <taoxuy@google.com>

ravenblackx requested review from ggreenway and mattklein123 December 26, 2025 16:06

mattklein123 removed their assignment Dec 31, 2025

repokitteh-read-only Bot removed the waiting label Feb 11, 2026

TAOXUY added 2 commits February 11, 2026 01:27

fix

98dffb5

Signed-off-by: Xuyang Tao <taoxuy@google.com>

fix doc

6d98895

Signed-off-by: Xuyang Tao <taoxuy@google.com>

ggreenway requested changes Feb 11, 2026

View reviewed changes

Comment thread source/extensions/access_loggers/stats/stats.cc

Comment thread test/extensions/access_loggers/stats/stats_test.cc

Comment thread source/extensions/access_loggers/stats/stats.cc

fix

07988d0

Signed-off-by: Xuyang Tao <taoxuy@google.com>

ggreenway requested changes Feb 11, 2026

View reviewed changes

ggreenway added the waiting label Feb 11, 2026

TAOXUY commented Feb 11, 2026

View reviewed changes

fix test

54c9ff5

Signed-off-by: Xuyang Tao <taoxuy@google.com>

fix test

1851f13

Signed-off-by: Xuyang Tao <taoxuy@google.com>

repokitteh-read-only Bot removed the waiting label Feb 11, 2026

ggreenway approved these changes Feb 11, 2026

View reviewed changes

wbpcode approved these changes Feb 12, 2026

View reviewed changes

repokitteh-read-only Bot removed the api label Feb 12, 2026

wbpcode requested changes Feb 12, 2026

View reviewed changes

wbpcode approved these changes Feb 12, 2026

View reviewed changes

wbpcode merged commit 7d05933 into envoyproxy:main Feb 12, 2026
28 checks passed

Copilot AI mentioned this pull request Apr 28, 2026

test/access_loggers/stats: replace tcmalloc consumedBytes assertions with sizeof structural bounds #44708

Closed

Conversation

TAOXUY commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

repokitteh-read-only Bot commented Nov 24, 2025

Uh oh!

TAOXUY commented Nov 24, 2025

Uh oh!

mattklein123 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ggreenway left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TAOXUY commented Feb 11, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TAOXUY commented Feb 11, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TAOXUY commented Feb 11, 2026

Uh oh!

TAOXUY commented Feb 11, 2026

Uh oh!

ggreenway commented Feb 11, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

TAOXUY commented Nov 24, 2025 •

edited

Loading