go-kit/kit

Using prometheus collector MustRegister in New{Counter,Gauge} and possible panic

Open

#937 opened on Nov 14, 2019

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Go (27,422 stars) (2,446 forks)batch import
bughelp wantednewbie friendly

Description

Thanks for the wonderful product! I think it would be fair to point the limitations of calling New in the documentation, since calling New again calls panic.

Contributor guide

Tech stack
go
Domain
backenddocumentation
Issue type
documentation
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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GoPrometheus basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Examine the prometheus package in go kit, specifically the NewCounter, NewGauge, and MustRegister functions. Add documentation clarifying that calling New methods again may cause panic if MustRegister was already used. Refer to the issue comments for further context.