envoyproxy/envoy

Tracing context and access logging integration

Open

#16,962 opened on Jun 14, 2021

View on GitHub
 (5 comments) (3 reactions) (1 assignee)C++ (5,373 forks)batch import
enhancementhelp wanted

Repository metrics

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

Description

In this PR, we propose the ability to integrate metadata associated with HTTP tracing (e.g. Trace ID) with access logging. For example, suppose a request generates a trace context like the following

{
  "trace_id": "xxx",
  "spans": [.
    {
      "span_id": "yyyy",
      ...
    }
  ]
  ...
}

By providing such a context to a dedicated access logging filter (this filter must be provided optimized for the tracing provider), the following log message is generated, for example.

{"trace_id": "xxx", "message":"..."}

The specific context of this function is explained in detail at here.

cc. @wu-sheng

[optional Relevant Links:]

https://github.com/SkyAPM/cpp2sky/issues/75

Contributor guide

Research direction
Implement a dedicated access logging filter that integrates with the tracing provider to include trace context in access logs. Refer to the linked issue (SkyAPM/cpp2sky#75) for details on the expected behavior.
Tech stack
cpp
Domain
backend
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.
1-2 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.
Clear
Prerequisites
C++Envoy
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25