Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

field envoy.config.listener.v3.FilterChain.name unexpected marked as WIP #21800

Closed
howardjohn opened this issue Jun 21, 2022 · 3 comments · Fixed by #21841
Closed

field envoy.config.listener.v3.FilterChain.name unexpected marked as WIP #21800

howardjohn opened this issue Jun 21, 2022 · 3 comments · Fixed by #21841
Labels

Comments

@howardjohn
Copy link
Contributor

If you are reporting any crash or any potential security issue, do not
open an issue in this repo. Please report the issue via emailing
envoy-security@googlegroups.com where the issue will be triaged appropriately.

Title: field envoy.config.listener.v3.FilterChain.name unexpected marked as WIP

Description:

 field 'envoy.config.listener.v3.FilterChain.name' is marked as work-in-progress. API features marked as work-in-progress are not considered stable, are not covered by the threat model, are not supported by the security team, and are subject to breaking changes. Do not use this feature without understanding each of the previous points.

is now logged. I believe this is incorrect.

The name field has been around for a long time and used in logging. The WIP nature of the field only applies when used in conjunction with the new filter_chain_matcher. It seems like we should just log on filter_chain_matcher usage, not name which already has valid non-WIP usages.

Repro steps:
Use the field

cc @kyessenov

@howardjohn howardjohn added bug triage Issue requires triage labels Jun 21, 2022
@ggreenway
Copy link
Contributor

ggreenway commented Jun 21, 2022

It looks like it was changed from #not-implemented-hide to work_in_progrss in #20110. From this report, it sounds like it was incorrectly marked #not-implemented-hide before because it was being used in logging. @kyessenov should we remove the work_in_progress flag on this field?

@ggreenway ggreenway removed the triage Issue requires triage label Jun 21, 2022
@kyessenov
Copy link
Contributor

Ack, I was going to do that, but feel free to go ahead.

@kyessenov
Copy link
Contributor

I'd suggest linking to the field from https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage, we'd probable detect that earlier if it was actually referenced in the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants