envoyproxy/envoy

Formally deprecate `*_METADATA` access log command operators

Open

#33,004 opened on Mar 20, 2024

View on GitHub
 (5 comments) (0 reactions) (1 assignee)C++ (5,373 forks)batch import
area/access_logenhancementhelp wantedstale

Repository metrics

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

Description

Title: Formally deprecate *_METADATA access log command operators

Description: The documentation for the command operators for access log formatting DYNAMIC_METADATA and CLUSTER_METADATA has indicated that these will be deprecated in favor of the METADATA formatter since the latter was implemented. We should actually deprecate these and make plans for their removal.

Relevant Links: https://github.com/envoyproxy/envoy/pull/17457/files#diff-a5eb61dd3a95c605846ebaba934b7334bc18f96fbf9ebf7593a90948c92f19c5

Contributor guide

Research direction
Mark the `DYNAMIC METADATA` and `CLUSTER METADATA` command operators as deprecated in the source code, update documentation to reflect deprecation, and add deprecation warnings in the logs. Ensure backward compatibility warnings are addressed.
Tech stack
cpp
Domain
backendinfrastructurenetworking
Issue type
Chore
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++Envoy proxy internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60