juspay/hyperswitch

feat(metrics): add Vector Throughput & health (via prometheus)

Open

#5,030 opened on Jun 18, 2024

View on GitHub
 (4 comments) (0 reactions) (2 assignees)Rust (42,690 stars) (4,676 forks)batch import
A-infraC-featuregood first issue

Description

Add a dashboard to monitor vector throughput usage and log loss. The dashboard should show throughput for the following pipes

Throughput

  1. stdout -> loki
  2. stdout -> opensearch
  3. kafka -> loki
  4. Kafka -> transform -> opensearch These flows should include incoming events / outgoing events & dropped events as a time series chart

kafka source should contain consumer lag metrics as well

Health (this would be primarily powered by these metrics)

  • CPU usage of vector
  • Memory usage of vector
  • buffer size
  • errors happening in transforms
  • utilization of each component

Ideally we can take most of the components from a openly available data source by modifying some components to make it geared towards our setup

Contributor guide

Tech stack
rustprometheus
Domain
observabilitybackend
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.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic Rust knowledgePrometheus familiarity
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
The issue requires creating a dashboard for Vector throughput and health metrics using Prometheus. Start by examining the Vector source configuration files, likely in the repository's configuration or deployment directory, to understand how internal metrics are exposed. Look at existing dashboards or metrics integrations for patterns. The issue references specific metrics like component utilization and error rates; investigate how to query these from Prometheus. Since assignees are already present, consider coordinating with them or reviewing any linked branches.