bvandeusenandClaude Opus 5.5
5ca13f9278
#5691 "Generic Prometheus dashboard widget: pick a target and a template", step 3 of milestone 508 "Prometheus widget templates". - /plugins/prometheus/widget draws one target with one template in widget shape: the verdict (led by "isn't answering" when the target is down), then each block with problems first, figures beside a share bar or the last 24h of bars, and the healthy rest folding to "+N more healthy" past six. A missing target or template, or one that no longer checks, says so. - library.py: bundled templates from plugins/prometheus/widgets/*.yaml, the picker's target and template lists, and the default title. - widgets/fabled_archives.yaml: the first bundled template, against the series Archives reports (refined in #5693). - Dashboard: a widget setting may take `options_from` (read when the picker opens) with an `empty` sentence; `default_title`; a Details link may name settings ("/plugins/prometheus/targets/{target}"). Prometheus is grouped with the integrations. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
70 lines
2.3 KiB
Python
70 lines
2.3 KiB
Python
# plugins/prometheus/__init__.py
|
|
from __future__ import annotations
|
|
from typing import TYPE_CHECKING
|
|
|
|
if TYPE_CHECKING:
|
|
from quart import Quart
|
|
|
|
_app: "Quart | None" = None
|
|
|
|
|
|
def setup(app: "Quart") -> None:
|
|
global _app
|
|
_app = app
|
|
from .models import PrometheusTarget # noqa: F401 — registers the table
|
|
register_widgets()
|
|
|
|
|
|
def register_widgets() -> None:
|
|
"""One dashboard widget for every target and template (System 181's
|
|
ruling). Its target and template lists are read when the widget picker
|
|
opens, so a new target or template appears without a restart."""
|
|
from steward.core.widgets import register_widget
|
|
|
|
from . import library
|
|
register_widget({
|
|
"key": "prometheus",
|
|
"label": "Prometheus",
|
|
"description": "One scrape target drawn by a widget template: Fabled Archives, or one you copy in",
|
|
"hx_url": "/plugins/prometheus/widget",
|
|
"detail_url": "/plugins/prometheus/targets/{target}",
|
|
"plugin": "prometheus",
|
|
"poll": True,
|
|
"default_title": library.default_title,
|
|
"params": [
|
|
{"key": "target", "label": "Target", "type": "select", "default": "",
|
|
"options_from": library.target_options,
|
|
"empty": "No targets yet: add one under Prometheus first."},
|
|
{"key": "template", "label": "Template", "type": "select", "default": "",
|
|
"options_from": library.template_options,
|
|
"empty": "No templates yet."},
|
|
],
|
|
})
|
|
|
|
|
|
def get_scheduled_tasks() -> list:
|
|
from .scheduler import make_scrape_task
|
|
return [make_scrape_task(_app)]
|
|
|
|
|
|
def get_blueprint():
|
|
from .routes import prometheus_bp
|
|
return prometheus_bp
|
|
|
|
|
|
def get_nav() -> list[dict]:
|
|
# Surfaces in the sidebar's Infrastructure group (scraped endpoints).
|
|
return [{"label": "Prometheus", "href": "/plugins/prometheus/"}]
|
|
|
|
|
|
def get_alert_metrics() -> dict[str, list[str]]:
|
|
"""The metric names are whatever each endpoint exposes, so the list is
|
|
empty here and the rule form offers the names recorded so far."""
|
|
return {"prometheus": []}
|
|
|
|
|
|
def get_audit_entities() -> dict:
|
|
"""Audit rows about a target name it and link to its page."""
|
|
from .models import PrometheusTarget
|
|
return {"prometheus_target": (PrometheusTarget, "/plugins/prometheus/targets/{}")}
|