stackabletech / stackabletech/documentation

Product monitoring: Create concepts page

Offen
#331 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
CSS
Sterne
13
Forks
14
Ø Merge
4 T. 8 Std.
Gemergte PRs (30 T.)
10

Beschreibung

We should document that we recommend a Prometheus Servicemonitor and point to the monitoring stack.
Mention that we label all Services accordingly, so users only need to deploy a Servicemonitor and get all metrics instantly.
Provide some nice screenshots from Prometheus

This is mostly done on https://docs.stackable.tech/home/stable/operators/monitoring/
Expand it with

  • some screenshots from Prometheus
  • link to the monitoring stack to showcase the setup

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der bestehenden Monitoring-Seite unter docs.stackable.tech/home/stable/operators/monitoring/ und überprüfe ihre aktuellen Hinweise. Erweitere sie um Prometheus-Screenshots, einen Link zum Monitoring-Stack und die Empfehlung, einen Prometheus ServiceMonitor bereitzustellen; als abgeschlossen gilt die Aufgabe, wenn die Einrichtung und die automatische Erfassung von Metriken klar erklärt sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
prometheus
Bereich
documentation, observability
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
58/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.