Add new facility for introducing breaking changes to the dataplane - #47396
Open
yanavlasov wants to merge 5 commits into
Open
yanavlasov wants to merge 5 commits into
yanavlasov wants to merge 5 commits into
Conversation
Signed-off-by: Yan Avlasov <yavlasov@google.com>
yanavlasov
force-pushed
the
breaking-changes-tracker
branch
from
September 14, 2026 15:58
d021774 to
b7eb07d
Compare
Signed-off-by: Yan Avlasov <yavlasov@google.com>
yanavlasov
marked this pull request as ready for review
September 14, 2026 16:03
ggreenway
reviewed
Sep 14, 2026
|
|
||
| "Breaking change" is a code change that may have observable impact on existing production traffic. | ||
| When introducing a breaking change in Envoy, it desirable to surface in observability potential impact of | ||
| enabling the chanmge. Operators can assess the impact via access logs and metrics before older behaviors |
Member
There was a problem hiding this comment.
Suggested change
| enabling the chanmge. Operators can assess the impact via access logs and metrics before older behaviors | |
| enabling the change. Operators can assess the impact via access logs and metrics before older behaviors |
ggreenway
reviewed
Sep 14, 2026
| layers: | ||
| - name: static_layer | ||
| static_layer: | ||
| envoy.reloadable_features.breaking_change_observability_enabled: true |
Member
There was a problem hiding this comment.
It seems like this should be configuration, not a runtime flag
Contributor
Author
There was a problem hiding this comment.
Are you suggesting a new configuration element? I piggybacked on runtime since it already integration with all means of plumbing overrides. Static, RTDS and command line.
| std::optional<std::string> BreakingChangesTracker::serializeAsString() const { | ||
| // The likely case is that there are 0 defects. Sometimes there will be 1. | ||
| // Very rarely, there will be 2. | ||
| absl::InlinedVector<absl::string_view, 1> defects; |
Member
There was a problem hiding this comment.
I don't like the name defects; it implies something is wrong. Maybe changes?
| ----------------------------- | ||
|
|
||
| "Breaking change" is a code change that may have observable impact on existing production traffic. | ||
| When introducing a breaking change in Envoy, it desirable to surface in observability potential impact of |
Member
There was a problem hiding this comment.
How long will we make this observable? The same time period as the existing runtime flag policy?
Contributor
Author
There was a problem hiding this comment.
Added note on deprecation policy.
Signed-off-by: Yan Avlasov <yavlasov@google.com>
Signed-off-by: Yan Avlasov <yavlasov@google.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added the
BreakingChangesTrackerclass to track and observe breaking changes in Envoy.Operators can enable observability for breaking changes via the
envoy.reloadable_features.breaking_change_observability_enabledruntime flag and log observedbreaking changes in access logs using
%FILTER_STATE(envoy.breaking_changes_tracker:PLAIN)%.Risk Level: low
Testing: unit tests
Docs Changes: yes
Release Notes: yes
Platform Specific Features: no
Part of #47277