shumoku-plugin-prometheus

Prometheus data source plugin for Shumoku. Polls link and node metrics, discovers hosts from label values, and reads alerts from Alertmanager.

Capabilities

| Capability | What it provides | |------------|------------------| | metrics | Node up/down and link traffic (interface counters via rate(...[5m])) | | hosts | Hosts discovered from a label (default instance), with their interfaces | | alerts | Active / resolved alerts from the Alertmanager API |

Configuration

| Field | Type | Required | Default | Notes | |-------|------|----------|---------|-------| | url | string (uri) | ✅ | — | Prometheus base URL | | preset | snmp | node_exporter | custom | ✅ | snmp | Which metric names to query | | customMetrics | object | when preset=custom | — | inOctets, outOctets, interfaceLabel (required), upMetric (optional) | | hostLabel | string | | instance | Label that identifies a host | | jobFilter | string | | — | Optional job label to restrict hosts | | alertmanagerUrl | string (uri) | | Prometheus URL | Alertmanager endpoint | | basicAuth | object | | — | username / password |

Presets — snmp uses ifHCInOctets / ifHCOutOctets; node_exporter uses node_network_receive_bytes_total / node_network_transmit_bytes_total; custom lets you name your own. Label values are escaped before being interpolated into PromQL selectors.

Usage

Bundled with apps/server. To register elsewhere:

import { register } from 'shumoku-plugin-prometheus'
register(pluginRegistry)

The host validates config against configSchema and renders the form generically — no per-plugin UI code.

Exports

register(registry), PrometheusPlugin, and the types PrometheusPluginConfig, PrometheusCustomMetrics, PrometheusMetricPreset, PrometheusNodeMapping, PrometheusLinkMapping.

Depends on @shumoku/core and @shumoku/plugin-sdk. See Plugin Authoring.

License

AGPL-3.0-only. For commercial licensing, contact [email protected].