envoyproxy/envoy

event emission: implement generic event reporting gRPC client

Open

#10,966 opened on Apr 27, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/observabilityarea/service discoverydesign proposalhelp wanted

Repository metrics

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

Description

#10407 added proto definitions for a generic event reporting service. This issue tracks implementation details.

  1. Using a bidi stream where Envoy updates the emission stream based on responses from the sink gRPC service allows for in-band flexibility. Both for:
  • The types of events that Envoy emits, e.g, filter to only health check events.
  • The shape of the events emitted, e.g, configure the metrics events to report counters as deltas.
  1. The base implementation should account for generic logic, such as:
  • Stream establishment, and callbacks for custom logic over messages in the stream
  • Handling versioning of in-band config updates so that the server-side gRPC service is aware of the configuration of the data stream -- useful when the shape of the data can change via in-band config updates.

Relates to https://github.com/envoyproxy/envoy/issues/8970 and https://github.com/envoyproxy/envoy/issues/10968

Contributor guide

Research direction
Examine Envoy's existing gRPC client implementations (e.g., for access log, ratelimit) and the proto definitions from #10407. Understand the bidi stream pattern and in band config update mechanism.
Tech stack
cppgrpc
Domain
backendapinetworking
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
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.
Clear
Prerequisites
C++gRPCEnvoy internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
10