# Prometheus

Canonical: https://docs.shumoku.dev/en/server/next/plugins/prometheus
Language: en
Server documentation version: next
Product version: 0.1.6-beta.4
Channel: development

This documentation describes the Server currently in development.

prometheus · 0.2.28

# Prometheus

[Source](https://github.com/konoe-akitoshi/shumoku/blob/73ebc72ba0bc0d1caf74e1ed34c89a6debcb0e6a/libs/plugins/prometheus/src/index.ts)

## Capabilities

metrics · hosts · alerts

## Connection configuration

| Field | Type | Description | Default |
| --- | --- | --- | --- |
| `url`  
required | `string` | **Prometheus URL**  
 | `—` |
| `preset`  
required | `string` | **Metric preset**  
snmp — SNMP Exporter, node\_exporter — Node Exporter, custom — Custom metrics | `snmp` |
| `customMetrics`  
 | `object` | **Custom metrics**  
 | `—` |
| `customMetrics.inOctets`  
required | `string` | **Inbound octets metric**  
 | `—` |
| `customMetrics.outOctets`  
required | `string` | **Outbound octets metric**  
 | `—` |
| `customMetrics.interfaceLabel`  
required | `string` | **Interface label**  
 | `—` |
| `customMetrics.upMetric`  
 | `string` | **Up metric**  
 | `—` |
| `hostLabel`  
 | `string` | **Host label**  
Label identifying hosts. | `instance` |
| `jobFilter`  
required | `string` | **Job filter**  
Required job label scope. Use one exact job or switch to regex for a related job family. | `—` |
| `jobFilterMode`  
 | `string` | **Job filter mode**  
Regex matches are fully anchored by Prometheus; use snmp-.\* for a prefix. exact — Exact match, regex — Regular expression (RE2) | `exact` |
| `alertmanagerUrl`  
 | `string` | **Alertmanager URL**  
Defaults to the Prometheus URL. | `—` |
| `basicAuth`  
 | `object` | **Basic auth (optional)**  
 | `—` |
| `basicAuth.username`  
 | `string` | **Username**  
 | `—` |
| `basicAuth.password`  
· secret | `string` | **Password**  
 | `—` |

## Topology options

None