metaflow-observability 0.1.0__tar.gz

metaflow_observability-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Lint
+        run: ruff check src tests
+
+      - name: Format check
+        run: ruff format --check src tests
+
+      - name: Type check
+        run: mypy
+
+      - name: Test
+        run: pytest

metaflow_observability-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,46 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install hatch
+
+      - name: Build
+        run: hatch build
+
+      - name: Upload dist
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # required for OIDC trusted publisher
+
+    steps:
+      - name: Download dist
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

metaflow_observability-0.1.0/.gitignore

@@ -0,0 +1,41 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.egg
+*.egg-info/
+dist/
+build/
+.eggs/
+.venv/
+venv/
+env/
+.env
+
+# Testing / coverage
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+
+# Mypy
+.mypy_cache/
+
+# Ruff
+.ruff_cache/
+
+# Distribution
+*.whl
+*.tar.gz
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db

metaflow_observability-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: debug-statements

metaflow_observability-0.1.0/LICENSE

@@ -0,0 +1,175 @@
+                                 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 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
+      transformations 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 the Derivative Works thereof.
+
+      "Contribution" shall mean, as 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 tracking modifications
+      to the Work.
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      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 the 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 any such
+      Contribution constitutes direct or indirect patent infringement, then
+      any and all 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, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, 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 in addition 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 license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the Work.
+
+   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 conditions of TITLE,
+      MERCHANTIBILITY, 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 exemplary damages of whatever character arising as a
+      result of this License or out of the use or inability to use the
+      Work (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 wish 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 offer only
+      conditions consistent with this License, and not additionally charge
+      a fee for, acceptance of any liability obligations and/or rights
+      consistent with this License.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Nissan Pow
+
+   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.

metaflow_observability-0.1.0/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.4
+Name: metaflow-observability
+Version: 0.1.0
+Summary: Automatic observability for Metaflow — step duration, CPU, memory, disk, and GPU metrics via OpenTelemetry
+License: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: metaflow>=2.9
+Requires-Dist: opentelemetry-exporter-prometheus>=0.45b0
+Requires-Dist: opentelemetry-sdk>=1.24
+Requires-Dist: psutil>=5.9
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: opentelemetry-sdk>=1.24; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Requires-Dist: types-psutil; extra == 'dev'
+Provides-Extra: gpu
+Requires-Dist: pynvml>=11.0.0; extra == 'gpu'
+Description-Content-Type: text/markdown
+
+# metaflow-observability
+
+[![CI](https://github.com/npow/metaflow-observability/actions/workflows/ci.yml/badge.svg)](https://github.com/npow/metaflow-observability/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/metaflow-observability)](https://pypi.org/project/metaflow-observability/)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](LICENSE)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![Docs](https://img.shields.io/badge/docs-mintlify-18a34a?style=flat-square)](https://mintlify.com/npow/metaflow-observability)
+
+Get production metrics for every Metaflow step — without changing your flow code.
+
+## The problem
+
+When a Metaflow pipeline slows down or crashes in production, you have no time-series data to tell you whether it was CPU saturation, a memory spike, a disk bottleneck, or a GPU stall. You're left digging through logs after the fact. Metaflow's built-in tooling gives you per-run artifacts and cards, but nothing you can alert on or trend over time.
+
+## Quick start
+
+```bash
+pip install metaflow-observability
+```
+
+```python
+from metaflow import FlowSpec, step
+from metaflow.decorators import observability
+
+class MyFlow(FlowSpec):
+
+    @observability
+    @step
+    def train(self):
+        ...  # your code — metrics collected automatically
+        self.next(self.end)
+
+    @step
+    def end(self):
+        pass
+
+if __name__ == "__main__":
+    MyFlow()
+```
+
+Metrics are exported via OpenTelemetry. Point them at Prometheus + Grafana with:
+
+```bash
+export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
+python flow.py run
+```
+
+## Install
+
+```bash
+# Core (CPU, memory, disk, duration)
+pip install metaflow-observability
+
+# With GPU support (NVIDIA only, requires CUDA drivers)
+pip install "metaflow-observability[gpu]"
+```
+
+## Usage
+
+**Zero-config with Prometheus**
+
+Add `@observability` to any step. By default, metrics are scraped via a Prometheus endpoint on port 8000.
+
+```python
+@observability
+@step
+def preprocess(self):
+    ...
+```
+
+**Custom OTel backend**
+
+Use any OpenTelemetry-compatible backend (Grafana Cloud, Datadog, Honeycomb, etc.) via standard OTel environment variables:
+
+```bash
+export OTEL_EXPORTER_OTLP_ENDPOINT=https://otlp.example.com
+export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer <token>"
+```
+
+**GPU metrics**
+
+Install the GPU extra and run on a CUDA-enabled machine — GPU utilization and memory are collected automatically per device, tagged with `gpu_index`.
+
+```bash
+pip install "metaflow-observability[gpu]"
+```
+
+## How it works
+
+`@observability` wraps `task_pre_step` / `task_post_step` / `task_exception` hooks in Metaflow's decorator API. Before your step code runs, it starts background threads that sample CPU%, RSS memory, disk I/O throughput, and (optionally) GPU utilization at 1-second intervals. When the step finishes, samples are aggregated and exported as OpenTelemetry instruments:
+
+| Metric | Instrument | Tags |
+|---|---|---|
+| `step.duration` | Histogram (seconds) | `step`, `flow`, `run_id`, `retry` |
+| `step.cpu.pct` | Gauge (avg / max / p95) | same |
+| `step.memory.mb` | Gauge (avg / max RSS) | same |
+| `step.disk.read_bytes` | Counter | same |
+| `step.disk.write_bytes` | Counter | same |
+| `step.disk.read_throughput` | Gauge (MB/s) | same |
+| `step.disk.write_throughput` | Gauge (MB/s) | same |
+| `step.gpu.utilization` | Gauge | + `gpu_index` |
+| `step.gpu.memory.used_mb` | Gauge | + `gpu_index` |
+| `step.retries` | Gauge | same |
+| `step.failures` | Counter | same |
+
+## Configuration
+
+All configuration is via standard OpenTelemetry environment variables. No extension-specific config needed.
+
+| Variable | Purpose |
+|---|---|
+| `OTEL_EXPORTER_OTLP_ENDPOINT` | OTLP endpoint for traces and metrics |
+| `OTEL_EXPORTER_OTLP_HEADERS` | Auth headers (e.g., `Authorization=Bearer ...`) |
+| `OTEL_SERVICE_NAME` | Service name tag on all metrics |
+
+If neither variable is set, metrics are printed to stdout via the OTel console exporter (useful for local debugging).
+
+## Development
+
+```bash
+git clone https://github.com/npow/metaflow-observability
+cd metaflow-observability
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Lint + format
+ruff check src tests
+ruff format src tests
+
+# Type check
+mypy
+```
+
+CI runs the full suite across Python 3.9, 3.10, 3.11, and 3.12 on every push.
+
+## License
+
+[Apache-2.0](LICENSE)

metaflow_observability-0.1.0/README.md

@@ -0,0 +1,140 @@
+# metaflow-observability
+
+[![CI](https://github.com/npow/metaflow-observability/actions/workflows/ci.yml/badge.svg)](https://github.com/npow/metaflow-observability/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/metaflow-observability)](https://pypi.org/project/metaflow-observability/)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](LICENSE)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![Docs](https://img.shields.io/badge/docs-mintlify-18a34a?style=flat-square)](https://mintlify.com/npow/metaflow-observability)
+
+Get production metrics for every Metaflow step — without changing your flow code.
+
+## The problem
+
+When a Metaflow pipeline slows down or crashes in production, you have no time-series data to tell you whether it was CPU saturation, a memory spike, a disk bottleneck, or a GPU stall. You're left digging through logs after the fact. Metaflow's built-in tooling gives you per-run artifacts and cards, but nothing you can alert on or trend over time.
+
+## Quick start
+
+```bash
+pip install metaflow-observability
+```
+
+```python
+from metaflow import FlowSpec, step
+from metaflow.decorators import observability
+
+class MyFlow(FlowSpec):
+
+    @observability
+    @step
+    def train(self):
+        ...  # your code — metrics collected automatically
+        self.next(self.end)
+
+    @step
+    def end(self):
+        pass
+
+if __name__ == "__main__":
+    MyFlow()
+```
+
+Metrics are exported via OpenTelemetry. Point them at Prometheus + Grafana with:
+
+```bash
+export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
+python flow.py run
+```
+
+## Install
+
+```bash
+# Core (CPU, memory, disk, duration)
+pip install metaflow-observability
+
+# With GPU support (NVIDIA only, requires CUDA drivers)
+pip install "metaflow-observability[gpu]"
+```
+
+## Usage
+
+**Zero-config with Prometheus**
+
+Add `@observability` to any step. By default, metrics are scraped via a Prometheus endpoint on port 8000.
+
+```python
+@observability
+@step
+def preprocess(self):
+    ...
+```
+
+**Custom OTel backend**
+
+Use any OpenTelemetry-compatible backend (Grafana Cloud, Datadog, Honeycomb, etc.) via standard OTel environment variables:
+
+```bash
+export OTEL_EXPORTER_OTLP_ENDPOINT=https://otlp.example.com
+export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer <token>"
+```
+
+**GPU metrics**
+
+Install the GPU extra and run on a CUDA-enabled machine — GPU utilization and memory are collected automatically per device, tagged with `gpu_index`.
+
+```bash
+pip install "metaflow-observability[gpu]"
+```
+
+## How it works
+
+`@observability` wraps `task_pre_step` / `task_post_step` / `task_exception` hooks in Metaflow's decorator API. Before your step code runs, it starts background threads that sample CPU%, RSS memory, disk I/O throughput, and (optionally) GPU utilization at 1-second intervals. When the step finishes, samples are aggregated and exported as OpenTelemetry instruments:
+
+| Metric | Instrument | Tags |
+|---|---|---|
+| `step.duration` | Histogram (seconds) | `step`, `flow`, `run_id`, `retry` |
+| `step.cpu.pct` | Gauge (avg / max / p95) | same |
+| `step.memory.mb` | Gauge (avg / max RSS) | same |
+| `step.disk.read_bytes` | Counter | same |
+| `step.disk.write_bytes` | Counter | same |
+| `step.disk.read_throughput` | Gauge (MB/s) | same |
+| `step.disk.write_throughput` | Gauge (MB/s) | same |
+| `step.gpu.utilization` | Gauge | + `gpu_index` |
+| `step.gpu.memory.used_mb` | Gauge | + `gpu_index` |
+| `step.retries` | Gauge | same |
+| `step.failures` | Counter | same |
+
+## Configuration
+
+All configuration is via standard OpenTelemetry environment variables. No extension-specific config needed.
+
+| Variable | Purpose |
+|---|---|
+| `OTEL_EXPORTER_OTLP_ENDPOINT` | OTLP endpoint for traces and metrics |
+| `OTEL_EXPORTER_OTLP_HEADERS` | Auth headers (e.g., `Authorization=Bearer ...`) |
+| `OTEL_SERVICE_NAME` | Service name tag on all metrics |
+
+If neither variable is set, metrics are printed to stdout via the OTel console exporter (useful for local debugging).
+
+## Development
+
+```bash
+git clone https://github.com/npow/metaflow-observability
+cd metaflow-observability
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Lint + format
+ruff check src tests
+ruff format src tests
+
+# Type check
+mypy
+```
+
+CI runs the full suite across Python 3.9, 3.10, 3.11, and 3.12 on every push.
+
+## License
+
+[Apache-2.0](LICENSE)