envoyproxy/envoy

Expose x-envoy-upstream-service-time as a metric

Open

#37,129 opened on Nov 13, 2024

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

Repository metrics

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

Description

Title: Expose x-envoy-upstream-service-time as a metric

Description:

I want to be able to attribute latency to each portion of my network. Whilst I have tracing data which may enable me to do this, it would be much easier if I had access to the data from the X-Envoy-Upstream-Service-Time header available as a metric. I have not been able to determine a way to calculate this with the existing exposed metrics.

[optional Relevant Links:]

https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-upstream-service-time

Contributor guide

Research direction
Examine how existing metrics are defined and exposed in the router filter, particularly from upstream response headers. Look at the implementation of the router filter in source/common/router/ and how metrics are registered via Stats::Scope and StatNames. Understand the X Envoy Upstream Service Time header handling and follow the pattern to create a new histogram metric.
Tech stack
cpp
Domain
backendobservability
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.
Fresh
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.
40