envoyproxy/envoy

feature req: SQL codecs need to inject or parse trace headers from comments

Open

#11,718 opened on Jun 23, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)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

Having the ability to trace database calls is very useful. Imagine the following example flow:

app---(sql query)-->sidecar--->DB

if app sends SQL queries with the trace headers as SQL comments, then the sidecar can emit client-side trace spans, recording the DB call durations. [The more industrious lot can parse DB query logs to extract trace headers and emit server side spans?]

if app doesn't send the trace headers as comments, the sidecar can still inject them (it will be a broken trace, but a trace nevertheless).

I am not sure if mongodb supports comments - the same can be done for mongo as well.

Contributor guide

Research direction
Investigate how Envoy's SQL codecs parse SQL queries and add trace headers as comments; look at existing tracing implementations in Envoy and how to inject headers into query strings.
Tech stack
cpp
Domain
backendapinetworkingobservability
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
C++Envoytracing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30