Would it be nice to document `Registry`, `Collector` and metric classes?

Offen

#803 erstellt am 30.4.2022 1 Kommentar 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 5/5
Geschätzter Aufwand: Über eine Woche
Anfängerfreundlichkeit: 35/100

Issue-Typ: Dokumentation
Klarheit: Muss geklärt werden
Aktivitätsstatus: Veraltet
Tech-Stack: python
Bereich: documentation

Rechercherichtung

Beginne mit der Durchsicht der README und der Quellbereiche, die die globale REGISTRY, Registry, Collector, Metrikklassen und die Serveranwendung enthalten. Kläre vor dem Schreiben den von der Community bevorzugten Umfang und das Format der API-Referenz. Als abgeschlossen gilt die Aufgabe, wenn die vereinbarte Referenz erklärt, wie Registries und Collectors Metrikklassen mit der Serveranwendung verbinden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Hi guys. Thanks for providing this great library for making monitoring fun and easy in python. It's my Day 1 with this package. The README provided a very quick introduction but I was also puzzled at the following question:

Seems we defined some metric classes, but not assigned to any other things. The web server was started but it seemed magical that the server somehow knows the metric class objects.

This puzzle was gone after I checked out the source codes (which is very fun to read, thanks!) and realized that there's a global REGISTRY object. The server app takes a registry object which is by default the global REGISTRY, and each Collector object, in the __init__ method, also accepts a registry object, which by default is also REGISTRY.

I think it would be nice if there could be some API reference sections/pages. I'd be glad to contribute such a section, but would like to hear any comment from the community, like the necessity, proposed format, etc.

Cheers!

Vorherrschende Sprache: Python
Sterne: 4.4k
Forks: 876
Ø Merge: 8 T. 4 Std.
Gemergte PRs (30 T.): 1

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus prometheus/client_python

OpenMetrics content negotiation: `escaping=underscores` causes name mismatch between `HELP/TYPE` metadata and sample lines for metrics with colons Offen

bug

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100

prometheus/client_python#1177 · 1 Kommentar · Erstellt am 15.5.2026
Support OpenMetrics 2.0 exposition format Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100

prometheus/client_python#1210 · Erstellt am 23.9.2026
MultiProcessCollector fails permanently on an empty metrics file left by a killed worker Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 58/100

prometheus/client_python#1199 · 1 Reaktion · Erstellt am 12.8.2026
feature request/RFC: leave out a label (from at least `*MetricFamily` samples) when it's value is set to `None` Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 35/100

prometheus/client_python#1176 · Erstellt am 14.5.2026
WSL and MultiProcessCollector Offen

Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 52/100

prometheus/client_python#1126 · 2 Kommentare · Erstellt am 29.8.2025

Alle Issues in prometheus/client_python