dotnet / dotnet/yarp

[Feature Request] Add Telemetry consumption library for YARP health check

Open
#1,622 5 comments 3 reactions 0 assignees View on GitHub
Type: Idea
Dominant language
C#
Stars
9.6k
Forks
933
Avg merge
12d 18h
Merged PRs (30d)
2

Description

# Feature Request

Support a YARP telemetry library, so we can get the health state of YARP Cluster/Destination. And report useful telemetry to monitor the health of Clusters/Destinations.

# Why it is useful?

It would help us to monitor and checks the health status of target clusters/destinations. Since YARP already support health checks and have the health state, it would be a huge value and upgrade to provide a way to easily report health state.
1. It would help the host service owner to monitor, and easily debug based on the health state telemetry of target cluster.
2. And would help the client (target clusters) to monitor their service health.

For example, we are a Microsoft team building a gateway with YARP and there are many clients team service onboarded. With this telemetry, we can then build useful alerts and dashboards to check client team's health.

# Current gap
Currently YARP only expose `HealthStates` in `IDestinationHealthUpdater`, we would have to use some hacky way to make a wrapper of `IDestinationHealthUpdater` and inject our own code to emit telemetry in `SetActive` method.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.