livepeer/go-livepeer

add a few simple prometheus metrics

Open

#1,369 opened on Feb 10, 2020

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Go (223 forks)auto 404
area: metricsgood first issuehelp wanted

Repository metrics

Stars
 (583 stars)
PR merge metrics
 (PR metrics pending)

Description

Please let me know if any of these already exist or if there are better ways to handle some of these situations.

  • livepeer_broadcaster_count — 1 if running with -broadcaster, 0 otherwise
  • livepeer_orchestrator_count — 1 if running with -orchestrator, 0 otherwise
  • livepeer_transcoder_count — 1 if running with -transcoder, 0 otherwise

These will let us sum the currently running counts of Bs, Os, and Ts without resorting to building the numbers from the local Kubernetes environment.

  • livepeer_gpu_count — If running as a -transcoder with GPUs, how many GPUs are we running with?
  • livepeer_gpu_nvidia_count — How many -nvidia GPUs are we using?
  • livepeer_gpu_vaapi_count — How many VAAPI GPUs are we using?

Contributor guide

Research direction
Examine the existing Prometheus metrics setup in the codebase, locate where metrics are registered (likely in the `monitoring` or `metrics` package), and add the new gauge metrics using `prometheus.NewGauge` with appropriate labels. Then update the corresponding startup logic to set the gauge values based on the configuration flags (e.g., ` broadcaster`). Follow the pattern of existing metrics and ensure the metrics are exposed via the HTTP server.
Tech stack
go
Domain
backendobservability
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
GoPrometheus
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80