open-telemetry/opentelemetry-collector

Add gRPC health check

Open

#3,040 opened on Apr 28, 2021

View on GitHub
 (17 comments) (24 reactions) (0 assignees)Go (2,146 forks)auto 404
collector-telemetryhelp wanted

Repository metrics

Stars
 (7,237 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem? Please describe. If you want to deploy the OpenTelemetry Collector in gateway-mode behind an AWS Application Load Balancer (ALB) to support gRPC (e.g. OTLP) then ALB requires a gRPC health check. Today, we have a health check extension, however it only support HTTP.

Describe the solution you'd like Either extend the health check extension or add health check endpoints to gRPC receivers.

Describe alternatives you've considered Switch from gRPC to HTTP for receiving data

Contributor guide

Research direction
Investigate the standard gRPC health checking protocol (grpc.health.v1) and explore how to implement a health check endpoint in the OpenTelemetry Collector's gRPC receivers or extend the existing health check extension to support gRPC. Look at similar implementations in other projects.
Tech stack
go
Domain
backendapiinfrastructure
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GogRPC
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40