zalando/zally

Adding Prometheus metrics to Zally server

Open

#1,161 opened on Jul 1, 2020

View on GitHubContributor guide
 (5 comments) (0 reactions) (0 assignees)Kotlin (156 forks)auto 404
area: serverhelp wanted

Repository metrics

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

Description

Hi there, for our own dev stack we wanted to scrape metrics into our grafana dashboards showing historical information on Violations for each individual API.

The idea is that we poll the ApiReview table for available reviews, and based on the name of the API schema we expose any present violations to the /prometheus endpoint so it can be scraped.

I have already written the code needed to expose the prometheus endpoint as well as some code to expose violation metrics.

Contributor guide

Research direction
Review the existing code for Prometheus metrics integration and ensure it properly exposes violation metrics at the /prometheus endpoint. Test the endpoint and verify scraping works with Grafana.
Tech stack
kotlin
Domain
backend
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.
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.
Clear
Prerequisites
KotlinPrometheus
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75