dropbox/securitybot

Exposed metrics?

Open

#4 opened on Feb 22, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (127 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (993 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

First of all thanks for publishing this, it looks useful and I'd like to give it a try soon.

Is there currently any way of external monitoring, e.g. using Prometheus? It'd be useful for making sure that securitybot runs fine from an ops perspective, but also potentially for further processing of alerts, and metrics derived from alerts.

Contributor guide

Research direction
Investigate adding a Prometheus metrics endpoint using the prometheus client Python library. Check if securitybot already exposes an HTTP server, then add metrics such as request counts, alert counts, and health status. Provide configuration options for users to enable metrics.
Tech stack
pythonprometheus
Domain
observability
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
PythonPrometheus basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65