Snakemake Logger Plugin for STOMP

Send Snakemake workflow events monitoring to a STOMP message broker (ActiveMQ, RabbitMQ, etc.) in real-time.

Installation

pip install snakemake-logger-plugin-stomp

Quick Start

snakemake --logger stomp \
  --logger-stomp-host localhost \
  --logger-stomp-port 61613 \
  --logger-stomp-user admin \
  --logger-stomp-password admin \
  --logger-stomp-queue /queue/snakemake.events

Or use a profile:

# profiles/stomp/config.yaml
logger:
  stomp:
    host: "activemq.example.com"
    port: 61613
    user: "${STOMP_USER}"
    password: "${STOMP_PASSWORD}"
    queue: "/topic/snakemake.prod"

Features

• JSON event streaming to message brokers
• RabbitMQ stream queue support via STOMP queue headers
• SSL/TLS support
• Configurable formatters (default + JLab SWF schema + ComprehensiveEventFormatter)
• Event filtering (include/exclude)
• Heartbeat management
• Optional application-level consumer heartbeat events
• Environment variable support for secrets

Consumer Heartbeat Events

In addition to STOMP transport heartbeats, you can emit periodic heartbeat messages that are delivered to consumers on the configured destination.

Set consumer_heartbeat_interval in seconds:

logger:
  stomp:
    consumer_heartbeat_interval: 30

Use 0 (default) to disable consumer heartbeat events.

RabbitMQ Streams

RabbitMQ streams are supported as a queue type when the broker is accessed via the RabbitMQ STOMP adapter.

Example profile configuration:

logger:
  stomp:
    host: "rabbitmq.example.com"
    port: 61613
    user: "${STOMP_USER}"
    password: "${STOMP_PASSWORD}"
    queue: "/queue/snakemake.stream"
    use_stream: true
    stream_filter_by_workflow: true

Notes:

• RabbitMQ stream support in this plugin is publish-only.
• RabbitMQ queue type is immutable. If a destination already exists as a classic queue, it must be deleted and recreated as a stream before use_stream: true will work.