envoyproxy/envoy

improve grpc error stats

Open

#5,720 opened on Jan 25, 2019

View on GitHub
 (14 comments) (1 reaction) (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

Title: Improve gRPC error stats

Description: Right now it appears that even gRPC responses with errors count toward the various 200/2xx stats counters, probably because the HTTP code itself will be 200.

The rq_success_ and rq_error_ stats take into account gRPC errors, but only if the gRPC error falls in the 5xx range:

      absl::optional<Grpc::Status::GrpcStatus> grpc_status = Grpc::Common::getGrpcStatus(headers);
      if (grpc_status &&
          !Http::CodeUtility::is5xx(Grpc::Utility::grpcToHttpStatus(grpc_status.value()))) {
        upstream_request_->upstream_host_->stats().rq_success_.inc();
      } else {
        upstream_request_->upstream_host_->stats().rq_error_.inc();
      }

It would be nice to add options to Envoy to:

  1. count gRPC codes toward the existing http-style stats and/or
  2. emit new metrics for gRPC codes (i.e. 0-16)

Contributor guide

Research direction
Investigate how gRPC status codes are currently mapped to HTTP stats in Envoy's upstream request stats. Look at the code snippets in the issue and understand the logic for rq success and rq error . Consider adding new metrics for gRPC status codes or integrating them into existing HTTP stats counters.
Tech stack
cpp
Domain
backendinfrastructurecloud
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
C++gRPCEnvoy internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40