envoyproxy/envoy

Add CustomTag (metadata) access logger formatters

Open

#14,885 opened on Jan 31, 2021

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

Repository metrics

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

Description

Title: Add CustomTag.Metadata access logger formatters.

Description: Existing access log formatters only support DYNAMIC_METADATA, but it would be helpful if they could also access request/route/cluster/host metadata (see CustomTag.MetadataKind).

[optional Relevant Links:] Existing formatters - https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage CustomTags (used in Tracing) - https://www.envoyproxy.io/docs/envoy/latest/api-v3/type/tracing/v3/custom_tag.proto#envoy-v3-api-msg-type-tracing-v3-customtag-metadata

@omriz @htuch

Contributor guide

Research direction
Study existing DYNAMIC METADATA formatters in access log, then extend them to support request, route, cluster, and host metadata kinds as defined in CustomTag.MetadataKind.
Tech stack
cpp
Domain
backendnetworking
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
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.
Mostly clear
Prerequisites
C++Envoy internalsaccess logging
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40