Skip to main content

airflow-supervisor

Run and monitor supervisord-managed jobs from Apache Airflow.

Build Status codecov License PyPI

Manage a dedicated supervisord instance on an Airflow worker or an SSH host. Define its programs directly in a Python DAG or in airflow-config YAML.

from datetime import datetime, timezone

from airflow import DAG
from airflow_supervisor import ProgramConfiguration, Supervisor, SupervisorAirflowConfiguration

with DAG(
    dag_id="nightly-supervisor",
    schedule="@daily",
    start_date=datetime(2025, 1, 1, tzinfo=timezone.utc),
    catchup=False,
) as dag:
    supervisor = Supervisor(
        dag=dag,
        cfg=SupervisorAirflowConfiguration(
            working_dir="/var/tmp/nightly-supervisor",
            port="127.0.0.1:9001",
            program={"nightly": ProgramConfiguration(command="/bin/sleep 5")},
        ),
    )

The lifecycle writes configuration, starts supervisord and its programs, monitors program state with airflow-ha, and stops and removes the instance on successful completion. SupervisorSSH runs configuration and daemon commands over SSH; program control and checks use the remote XML-RPC endpoint.

Documentation

Start with the tutorial to run a self-contained local job and check its cleanup. For an existing deployment, choose a how-to guide:

Execution Inline Python airflow-config YAML
Local worker Run a local job Configure a local job
SSH host Run a job over SSH Configure an SSH job

The API reference describes configuration fields, defaults, and DAG constraints. Why Airflow delegates process ownership explains worker placement, SSH and XML-RPC, and the Python/YAML configuration choices.

Use the log forwarding and health-check guide to collect program output in task logs and monitor retained services between runs.

Published documentation is available at airflow-laminar.github.io/airflow-supervisor.

Ecosystem

Metadata

Release files for airflow-supervisor 1.11.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for airflow-supervisor 1.11.1
File Size Uploaded Provenance
airflow_supervisor-1.11.1.tar.gz 26.6 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for airflow-supervisor 1.11.1
File Interpreter ABI Platform
airflow_supervisor-1.11.1-py3-none-any.whl Python 3 none any Details

Total release size: 65.4 kB

Release files / airflow_supervisor-1.11.1.tar.gz

Download URL airflow_supervisor-1.11.1.tar.gz
Size 26.6 kB
Tags Source
SHA-256 checksum
How to use checksums
34b25a26372e5edaddc79504c2129624b0cf29f57cadd1e7cc7d1c878647c129
BLAKE2b-256 checksum
How to use checksums
232aa355dc3f0d6701de4aca8aeaee4d98c13e641be1363f654f278d689eb091
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.15

Release files / airflow_supervisor-1.11.1-py3-none-any.whl

Download URL airflow_supervisor-1.11.1-py3-none-any.whl
Size 38.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a8d6acdde378a9175196cdc52eeba25c0af4954f880c7d0b08c103059034be24
BLAKE2b-256 checksum
How to use checksums
78c6c1dbbc9ef855c489cd0828113e15f64da457e73bc97c2f6e842f611cd026
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.15

Security for airflow-supervisor 1.11.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.11.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page