envoyproxy/envoy

proposal: interval reporting for network access loggers

Open

#10,936 opened on Apr 24, 2020

View on GitHub
 (3 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

Network access loggers can be attached to listeners and tcp_proxies. They report once the connection is closed. This is a problem for long-running, stalled, and slow connections, since there is no telemetry until it's over, which complicates debugging of connection handling issues.

This proposal is to add an option, e.g. interval_duration: 10s, to invoke the access loggers log() function repeatedly (and immediately on the connection establishment). This means some data might not be populated in StreamInfo, so the access log needs to distinguish between missing and not-yet-populated states.

The alternative is to push down the functionality into the access log extension itself. For that to be possible:

  1. We would need ability to set up timers from FactoryContext.
  2. The latter point stands: we should be able to distinguish between missing and not yet defined.

Contributor guide

Research direction
Implement interval reporting for network access loggers by adding an 'interval duration' option. Modify the access log's log() function to be called repeatedly via a timer, and ensure StreamInfo distinguishes missing vs not yet populated states.
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.
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++Networking
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40