Snakemake logger plugin: prometheus

Warning

This plugin is not maintained and reviewed by the official Snakemake organization.

Warning

No documentation found in repository https://github.com/tedil/snakemake-logger-plugin-prometheus. The plugin should provide a docs/intro.md with some introductory sentences and optionally a docs/further.md file with details beyond the auto-generated usage instructions presented in this catalog.

Installation

Install this plugin by installing it with pip or mamba directly, e.g.:

pip install snakemake-logger-plugin-prometheus

Or, if you are using pixi, add the plugin to your pixi.toml. Be careful to put it under the right dependency type based on the plugin’s availability, e.g.:

snakemake-logger-plugin-prometheus = "*"

Usage

In order to use the plugin, run Snakemake (>=9.11) with the corresponding value for the logger flag:

snakemake --logger prometheus ...

with ... being any additional arguments you want to use.

Settings

The logger plugin has the following settings (which can be passed via command line, the workflow or environment variables, if provided in the respective columns):

Settings

CLI argument	Description	Default	Choices	Required	Type
--logger-prometheus-port VALUE	Port to expose Prometheus metrics on	8000		✗	int
--logger-prometheus-push-gateway VALUE	URL of the Prometheus Pushgateway (e.g. http://localhost:9091)	None		✗	str
--logger-prometheus-push-job-name VALUE	Job name for the Pushgateway grouping	'snakemake'		✗	str
--logger-prometheus-run-id VALUE	Unique identifier for this workflow run (label). Defaults to UUID.	None		✗	str