airflow-plugin-watchdog 0.6.0__tar.gz

airflow_plugin_watchdog-0.6.0/.github/workflows/integration.yml

@@ -0,0 +1,72 @@
+name: Integration Tests
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "airflow_watchdog/**"
+      - "tests/integration/**"
+      - "pyproject.toml"
+      - "uv.lock"
+      - ".github/workflows/integration.yml"
+  pull_request:
+    branches: [main]
+    paths:
+      - "airflow_watchdog/**"
+      - "tests/integration/**"
+      - "pyproject.toml"
+      - "uv.lock"
+      - ".github/workflows/integration.yml"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  integration:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        # PostgreSQL is the production backend; SQLite is exercised too because
+        # the watchdog reads timestamps/JSON via raw SQL, which differs by driver.
+        include:
+          - backend: postgres
+            db_url: "postgresql+psycopg2://airflow:airflow@localhost:5432/airflow"
+          - backend: sqlite
+            db_url: "sqlite:////tmp/watchdog_integration.db"
+
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_USER: airflow
+          POSTGRES_PASSWORD: airflow
+          POSTGRES_DB: airflow
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd "pg_isready -U airflow"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Create the virtualenv on Python 3.14
+        run: uv venv .venv --python 3.14
+
+      - name: Install dependencies (incl. DB drivers)
+        run: uv sync --extra dev
+
+      - name: Run integration tests (${{ matrix.backend }})
+        env:
+          WATCHDOG_IT_DB_URL: ${{ matrix.db_url }}
+        run: uv run --extra dev pytest tests/integration -m integration -v

airflow_plugin_watchdog-0.6.0/.github/workflows/lint.yml

@@ -0,0 +1,36 @@
+name: Lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  lint-and-format:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Check lockfile is up to date
+        run: uv lock --check
+
+      - name: Run ruff lint
+        run: uvx ruff check --extend-select=I
+
+      - name: Run ruff format
+        run: uvx ruff format --check --diff
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run type check
+        run: uvx ty check airflow_watchdog

airflow_plugin_watchdog-0.6.0/.github/workflows/publish.yml

@@ -0,0 +1,67 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+
+      - name: Install build dependencies
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  verify:
+    needs: publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+
+      - name: Install tox
+        run: pip install tox
+
+      - name: Wait for PyPI to update
+        run: sleep 30
+
+      - name: Run tests against published package
+        run: tox -e verify-airflow3

airflow_plugin_watchdog-0.6.0/.github/workflows/test.yml

@@ -0,0 +1,48 @@
+name: Unit Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install tox
+        run: |
+          uv venv .venv --python ${{ matrix.python-version }}
+          uv pip install tox tox-uv --python .venv/bin/python
+
+      - name: Run tests
+        run: .venv/bin/tox -e airflow3
+
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.14'
+        uses: codecov/codecov-action@v4
+        with:
+          files: coverage.xml
+          fail_ci_if_error: false
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

airflow_plugin_watchdog-0.6.0/.gitignore

@@ -0,0 +1,16 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+.pytest_cache/
+.ruff_cache/
+.venv/
+venv/
+*.so
+.DS_Store
+.claude/
+.idea/

airflow_plugin_watchdog-0.6.0/CHANGELOG.md

@@ -0,0 +1,131 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.6.0] - 2026-05-31
+
+> **Renamed:** the distribution is now **`airflow-plugin-watchdog`** (was `airflow-provider-watchdog`). Install with `pip install airflow-plugin-watchdog`. The import path is unchanged (`import airflow_watchdog`).
+
+### Fixed
+
+- **`RuntimeError: Direct database access via the ORM is not allowed in Airflow 3.0`** — the monitor DAG's task ran the detector SQL through `airflow.settings.Session`, but Airflow 3 isolates task/worker execution from the metadata DB (AIP-72), so every run failed. Detection now runs on the API-server side, where direct metadata-DB access is sanctioned.
+
+### Changed
+
+- **Detection moved off the worker and onto the API server.** A background scheduler, started by the plugin's FastAPI lifespan, runs the detectors every `schedule_interval_minutes` inside the API-server process — the same place, and the same DB access, the dashboard already used. The synchronous detector SQL runs on a dedicated daemon thread so it never blocks the API server's event loop. Across multiple API-server replicas/workers, a database advisory lock (Postgres/MySQL) plus a last-run check ensures only one cycle runs per interval.
+- **No monitoring DAG to deploy.** Installing the plugin is now sufficient; there is no `dags_folder` shim step. `schedule_interval_minutes` is read each cycle, so cadence changes apply without a restart (previously required a scheduler restart).
+- Dashboard alert results now come from the `watchdog_last_results` Variable (written by the scheduler, capped at 50 most-severe alerts) instead of the monitor DAG's XCom.
+- `exclude_dags` no longer force-includes the (now-removed) `airflow_watchdog_monitor` DAG; it defaults to `[]` and is normalized to a sorted, de-duplicated list.
+
+### Removed
+
+- The `airflow_watchdog_monitor` DAG (`airflow_watchdog/dag.py`) and the `example_dags/watchdog_monitor.py` shim. Detection no longer runs as a DAG task, so it no longer appears in Airflow's DAG/run list — its activity is visible in the dashboard and the API-server logs.
+- **Provider registration.** The package is now a plain Airflow **plugin**, not a provider: `get_provider_info()` and the `apache_airflow_provider` entry point are gone. The plugin loads via the `airflow.plugins` entry point (the registration that already did the work). It no longer appears in Airflow's Providers list — look under Plugins instead.
+
+## [0.5.0] - 2026-05-30
+
+### Fixed
+
+- **Dashboard / nav link never appeared** — `WatchdogPlugin` was never registered, so the `/watchdog/` dashboard and the Browse → Watchdog nav link were invisible in every deployment. The plugin is now registered both via the provider-info `plugins` key and an `airflow.plugins` entry point (the latter survives `LAZY_LOAD_PROVIDERS=True`). Airflow dedupes by plugin name, so the two registrations don't double-mount.
+- **`"dags"` provider-info key did nothing** — the key added in 0.4.1 is not part of Airflow's provider-info schema and was silently ignored; Airflow has no mechanism to auto-discover DAGs shipped inside provider packages. Removed it.
+
+### Added
+
+- `example_dags/watchdog_monitor.py` — a one-line shim that re-exports the monitor DAG. Copy it into your `dags_folder` to expose `airflow_watchdog_monitor` to the scheduler (see README).
+- Provider-wiring integration tests asserting the plugin is discoverable via `ProvidersManager` and the monitor DAG loads cleanly in a `DagBag`.
+
+### Changed
+
+- README installation steps now reflect reality: `pip install` registers the dashboard, and the monitor DAG requires dropping the shim into `dags_folder`.
+
+## [0.4.1] - 2026-05-30
+
+### Fixed
+
+- **DAG not auto-discovered after install** — added missing `"dags"` key to provider info so Airflow's provider manager correctly discovers the `airflow_watchdog_monitor` DAG (superseded by 0.5.0 — this key is not a real Airflow mechanism and had no effect)
+
+## [0.4.0] - 2026-05-29
+
+### Added
+
+- Python 3.14 support (added to classifiers and CI test matrix)
+- Integration test suite that runs the detector/dashboard SQL, the XCom round trip, and the auth dependencies against a **real** Airflow metadata DB; CI exercises it on a PostgreSQL service container and on SQLite
+
+### Security
+
+- Dashboard and config endpoints now require an authenticated Airflow user. Reads require website (view) access; saving config requires permission to edit Airflow Variables. Previously these plugin endpoints — including the config-write endpoint that mutates the `watchdog_config` Variable — were reachable without authentication.
+
+### Fixed
+
+- **Deadline/stuck/schedule detectors and dashboard broken on SQLite** — raw SQL returns timestamps as strings on SQLite (vs `datetime` objects on PostgreSQL/MySQL), so duration arithmetic raised `TypeError`. Timestamps are now coerced via a shared `as_datetime` helper that works on every backend.
+- **Dashboard showed no alerts** — the watchdog DAG pushed `json.dumps(summary)` to XCom, which XCom serialized again (double-encoding); the dashboard's `json.loads` then yielded a string instead of a dict. The DAG now pushes the dict directly, and the dashboard decodes defensively across backends (handles single/double-encoded strings and pre-decoded JSON).
+- Failure-spike baseline now **excludes** the recent window (`rn > window`), so a fresh wave of failures no longer dilutes the baseline it's compared against
+- Naive metadata timestamps are now interpreted as UTC (the value Airflow actually stores) instead of `airflow.settings.TIMEZONE`, which produced incorrect elapsed times for deadline/stuck detection on non-UTC deployments
+- Dashboard DAG-link `base_url` is now passed through `encodeURI` for consistent escaping
+
+### Changed
+
+- Alerts serialized into the dashboard XCom are capped (most-severe first) to keep the payload bounded; `total_alerts`/`by_type` counts still reflect every alert
+
+## [0.3.1] - 2026-03-25
+
+### Fixed
+
+- Dashboard and config UI now use relative URLs — works behind any URL prefix (e.g. `/airflow/watchdog/`)
+- DAG links in dashboard use `base_url` from Airflow config instead of hardcoded `/dags/`
+
+## [0.3.0] - 2026-03-21
+
+### Added
+
+- **Schedule anomaly detector** — flags tasks whose start or end time-of-day deviates from historical norms (IQR-based, handles midnight wraparound)
+- **Per-DAG detector enable/disable** — `disable_detectors` (global) and `dag_overrides` (per-DAG) configuration fields
+- **Configuration UI** at `/watchdog/config` — toggle detectors on/off globally or per DAG with a visual grid
+- **MS Teams alerting** via Adaptive Card webhook (`alert_teams_webhook` config)
+- **Discord alerting** via webhook (`alert_discord_webhook` config)
+- `schedule_interval_minutes` config now wired to DAG schedule (read at parse time)
+
+### Fixed
+
+- Email alerts now HTML-escape DAG/task IDs to prevent XSS in email clients
+- Config POST endpoint validates detector names against `AlertType` enum
+- Config page dirty-check bug after saving (Save button now re-enables correctly)
+- Consolidated duplicate `_fmt` duration helper into shared `_stats.fmt_duration`
+- Naive datetimes now respect `airflow.settings.TIMEZONE` instead of assuming UTC
+
+## [0.2.0] - 2026-03-21
+
+### Added
+
+- Multi-database support — detectors and dashboard now work with PostgreSQL, MySQL, and SQLite
+- Dashboard error indicator — shows a visible error message instead of a blank page on DB failures
+- Light/dark theme support — dashboard follows OS `prefers-color-scheme`
+- Dashboard tests (8 new tests covering data assembly, endpoints, XSS escaping)
+- `py.typed` marker for type checker support
+- `CHANGELOG.md`
+
+### Changed
+
+- Renamed DAG from `watchdog_monitor` to `airflow_watchdog_monitor` to avoid collisions
+- Detectors compute statistics in Python instead of PostgreSQL-specific `PERCENTILE_CONT`
+- Dashboard SQL replaced `LEFT JOIN LATERAL`, `EXTRACT(EPOCH FROM)`, `NOW()` with standard SQL
+
+### Fixed
+
+- XSS vulnerability in dashboard — replaced incomplete `</` escaping with OWASP-recommended unicode escapes
+- Type safety — replaced `type: ignore` with `cast()` in alerting module
+- Airflow 3 compatibility — DAG `tags` changed from `list` to `set`
+
+## [0.1.0] - 2026-03-20
+
+### Added
+
+- Four health detectors: runtime anomaly (IQR), failure spike, missed deadline, stuck task
+- Auto-registered `airflow_watchdog_monitor` DAG with configurable schedule
+- Dark-themed `/watchdog/` dashboard with auto-refresh (FastAPI + Airflow plugin)
+- Alerting via Airflow logs, email, and Slack webhook
+- JSON-based configuration via Airflow Variable `watchdog_config`
+- Support for Python 3.10–3.13 and Apache Airflow 3.0+

airflow_plugin_watchdog-0.6.0/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Qing
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.