metaflow-logs 0.1.0__tar.gz

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

@@ -0,0 +1,73 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    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 package and test dependencies
+        run: |
+          pip install -e .
+          pip install -r tests/requirements.in
+
+      - name: Run tests
+        run: pytest tests/ -v --tb=short
+
+  lint:
+    name: Lint
+    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 ruff
+        run: pip install ruff
+
+      - name: Check formatting
+        run: ruff format --check src tests
+
+      - name: Check lint
+        run: ruff check src tests
+
+  typecheck:
+    name: Type check
+    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 dependencies
+        run: |
+          pip install -e .
+          pip install mypy
+
+      - name: Run mypy
+        run: mypy src

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

@@ -0,0 +1,47 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+  id-token: write  # required for OIDC trusted publishing
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build backend
+        run: pip install build
+
+      - name: Build wheel and sdist
+        run: python -m build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

metaflow_logs-0.1.0/.gitignore

@@ -0,0 +1,41 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+*.egg
+*.egg-info/
+dist/
+build/
+.eggs/
+*.whl
+
+# Virtual environments
+.venv/
+venv/
+env/
+.env
+
+# Tox / testing
+.tox/
+.pytest_cache/
+.coverage
+coverage.xml
+htmlcov/
+*.cover
+
+# Mypy
+.mypy_cache/
+.dmypy.json
+
+# Ruff
+.ruff_cache/
+
+# Hatch
+.hatch/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo

metaflow_logs-0.1.0/LICENSE

@@ -0,0 +1,184 @@
+                                 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 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, "submit" 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 clarifying or
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "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
+      Contribution embodied within the Work constitutes 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, 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 with
+          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 terms and conditions for use, reproduction,
+      or modification of Your modifications, beyond those set out 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 and 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,
+      NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR
+      PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and are responsible
+      for 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 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 all other
+      commercial and 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 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 that are your own account and 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 2024 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_logs-0.1.0/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: metaflow-logs
+Version: 0.1.0
+Summary: Ships Metaflow task logs to a centralized backend via OpenTelemetry
+License: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: metaflow>=2.9
+Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.24
+Requires-Dist: opentelemetry-sdk>=1.24
+Description-Content-Type: text/markdown
+
+# metaflow-logs
+
+[![CI](https://img.shields.io/github/actions/workflow/status/npow/metaflow-logs/ci.yml?branch=main&style=flat-square&label=CI)](https://github.com/npow/metaflow-logs/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/metaflow-logs?style=flat-square)](https://pypi.org/project/metaflow-logs/)
+[![Python](https://img.shields.io/pypi/pyversions/metaflow-logs?style=flat-square)](https://pypi.org/project/metaflow-logs/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](LICENSE)
+
+A Metaflow extension that ships task stdout and stderr to any [OpenTelemetry](https://opentelemetry.io/)-compatible backend (Grafana Loki, Datadog, New Relic, Elasticsearch, Honeycomb, …). Each log line is tagged with full task context — flow name, run ID, step name, task ID, attempt — making logs filterable and correlatable from any OTel-aware tool.
+
+## Quick start
+
+```bash
+pip install metaflow-logs
+```
+
+Add the decorator to any step:
+
+```python
+from metaflow import FlowSpec, step
+from metaflow_extensions.logs.plugins.decorator import LogsDecorator
+
+class MyFlow(FlowSpec):
+    @LogsDecorator()
+    @step
+    def train(self):
+        print("epoch 1 complete")
+        self.next(self.end)
+
+    @step
+    def end(self):
+        pass
+
+if __name__ == "__main__":
+    MyFlow()
+```
+
+Point it at your OTel collector:
+
+```bash
+export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
+python flow.py run
+```
+
+Each log line arrives in your backend tagged with:
+
+| Attribute | Example |
+|-----------|---------|
+| `metaflow.flow` | `MyFlow` |
+| `metaflow.run_id` | `123` |
+| `metaflow.step` | `train` |
+| `metaflow.task_id` | `456` |
+| `metaflow.attempt` | `0` |
+| `metaflow.log_source` | `task` or `runtime` |
+
+## Configuration
+
+All configuration is via standard OTel environment variables:
+
+| Variable | Default | Purpose |
+|----------|---------|---------|
+| `OTEL_EXPORTER_OTLP_ENDPOINT` | `http://localhost:4318` | OTel collector endpoint |
+| `OTEL_EXPORTER_OTLP_HEADERS` | — | Auth headers (e.g. `Authorization=Bearer ...`) |
+| `OTEL_SERVICE_NAME` | `metaflow` | Service name in your backend |
+
+Falls back to a console exporter if `opentelemetry-exporter-otlp-proto-http` is not installed.
+
+## How it works
+
+Reads Metaflow's structured MFLOG files (`MFLOG_STDOUT`, `MFLOG_STDERR`) at step completion and emits each line as an OTel `LogRecord`. Runtime logs (Metaflow internals) are emitted at `DEBUG` severity; task logs (your code's stdout/stderr) at `INFO`.
+
+## Development
+
+```bash
+git clone https://github.com/npow/metaflow-logs
+cd metaflow-logs
+pip install -e .
+pytest tests/ -v
+```

metaflow_logs-0.1.0/README.md

@@ -0,0 +1,78 @@
+# metaflow-logs
+
+[![CI](https://img.shields.io/github/actions/workflow/status/npow/metaflow-logs/ci.yml?branch=main&style=flat-square&label=CI)](https://github.com/npow/metaflow-logs/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/metaflow-logs?style=flat-square)](https://pypi.org/project/metaflow-logs/)
+[![Python](https://img.shields.io/pypi/pyversions/metaflow-logs?style=flat-square)](https://pypi.org/project/metaflow-logs/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](LICENSE)
+
+A Metaflow extension that ships task stdout and stderr to any [OpenTelemetry](https://opentelemetry.io/)-compatible backend (Grafana Loki, Datadog, New Relic, Elasticsearch, Honeycomb, …). Each log line is tagged with full task context — flow name, run ID, step name, task ID, attempt — making logs filterable and correlatable from any OTel-aware tool.
+
+## Quick start
+
+```bash
+pip install metaflow-logs
+```
+
+Add the decorator to any step:
+
+```python
+from metaflow import FlowSpec, step
+from metaflow_extensions.logs.plugins.decorator import LogsDecorator
+
+class MyFlow(FlowSpec):
+    @LogsDecorator()
+    @step
+    def train(self):
+        print("epoch 1 complete")
+        self.next(self.end)
+
+    @step
+    def end(self):
+        pass
+
+if __name__ == "__main__":
+    MyFlow()
+```
+
+Point it at your OTel collector:
+
+```bash
+export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
+python flow.py run
+```
+
+Each log line arrives in your backend tagged with:
+
+| Attribute | Example |
+|-----------|---------|
+| `metaflow.flow` | `MyFlow` |
+| `metaflow.run_id` | `123` |
+| `metaflow.step` | `train` |
+| `metaflow.task_id` | `456` |
+| `metaflow.attempt` | `0` |
+| `metaflow.log_source` | `task` or `runtime` |
+
+## Configuration
+
+All configuration is via standard OTel environment variables:
+
+| Variable | Default | Purpose |
+|----------|---------|---------|
+| `OTEL_EXPORTER_OTLP_ENDPOINT` | `http://localhost:4318` | OTel collector endpoint |
+| `OTEL_EXPORTER_OTLP_HEADERS` | — | Auth headers (e.g. `Authorization=Bearer ...`) |
+| `OTEL_SERVICE_NAME` | `metaflow` | Service name in your backend |
+
+Falls back to a console exporter if `opentelemetry-exporter-otlp-proto-http` is not installed.
+
+## How it works
+
+Reads Metaflow's structured MFLOG files (`MFLOG_STDOUT`, `MFLOG_STDERR`) at step completion and emits each line as an OTel `LogRecord`. Runtime logs (Metaflow internals) are emitted at `DEBUG` severity; task logs (your code's stdout/stderr) at `INFO`.
+
+## Development
+
+```bash
+git clone https://github.com/npow/metaflow-logs
+cd metaflow-logs
+pip install -e .
+pytest tests/ -v
+```

metaflow_logs-0.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "metaflow-logs"
+version = "0.1.0"
+description = "Ships Metaflow task logs to a centralized backend via OpenTelemetry"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "Apache-2.0" }
+dependencies = [
+    "metaflow>=2.9",
+    "opentelemetry-sdk>=1.24",
+    "opentelemetry-exporter-otlp-proto-http>=1.24",
+]
+
+[project.entry-points."metaflow_extensions"]
+logs = "metaflow_extensions.logs"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/metaflow_extensions"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]
+
+[tool.mypy]
+python_version = "3.9"
+strict = true
+disallow_subclassing_any = false
+
+[[tool.mypy.overrides]]
+module = ["metaflow.*", "opentelemetry.*"]
+ignore_missing_imports = true

metaflow_logs-0.1.0/src/metaflow_extensions/logs/__init__.py

@@ -0,0 +1,5 @@
+"""metaflow-logs: ships Metaflow task logs to a centralized OTel backend."""
+
+from .plugins.decorator import LogsDecorator
+
+STEP_DECORATORS = [LogsDecorator]

metaflow_logs-0.1.0/src/metaflow_extensions/logs/plugins/attrs.py

@@ -0,0 +1,10 @@
+"""OTel attribute name constants for Metaflow log records."""
+
+ATTR_FLOW = "metaflow.flow"
+ATTR_RUN_ID = "metaflow.run_id"
+ATTR_STEP = "metaflow.step"
+ATTR_TASK_ID = "metaflow.task_id"
+ATTR_ATTEMPT = "metaflow.attempt"
+ATTR_LOG_SOURCE = "metaflow.log_source"
+
+SERVICE_NAME = "metaflow"

metaflow_logs-0.1.0/src/metaflow_extensions/logs/plugins/decorator.py

@@ -0,0 +1,104 @@
+"""Metaflow step decorator that ships task logs to an OTel backend."""
+
+from __future__ import annotations
+
+import os
+from typing import Any, Callable
+
+from metaflow.decorators import StepDecorator
+
+from .attrs import ATTR_ATTEMPT, ATTR_FLOW, ATTR_RUN_ID, ATTR_STEP, ATTR_TASK_ID
+from .exporter import LogShipper, TaskAttributes, make_logger_provider
+from .mflog_parser import parse_stream
+
+_LOG_ENV_VARS = ("MFLOG_STDOUT", "MFLOG_STDERR")
+
+
+class LogsDecorator(StepDecorator):
+    """Ships task stdout and stderr to an OpenTelemetry Logs backend.
+
+    Applied per-step::
+
+        @logs
+        @step
+        def train(self):
+            ...
+
+    Configure the export endpoint with standard OTel environment variables
+    (``OTEL_EXPORTER_OTLP_ENDPOINT``, etc.).  Log records carry Metaflow
+    task context as OTel attributes (flow, run_id, step, task_id, attempt).
+    """
+
+    name = "logs"
+    defaults: dict[str, Any] = {}
+
+    def __init__(
+        self,
+        *args: Any,
+        provider_factory: Callable[[TaskAttributes], Any] | None = None,
+        **kwargs: Any,
+    ) -> None:
+        super().__init__(*args, **kwargs)  # type: ignore[no-untyped-call]
+        self._provider_factory = provider_factory or make_logger_provider
+        self._shipper: LogShipper | None = None
+        self._provider: Any | None = None
+        self._task_attrs: TaskAttributes = {}
+
+    def task_pre_step(
+        self,
+        step_name: str,
+        task_datastore: Any,
+        metadata: Any,
+        run_id: str,
+        task_id: str,
+        flow: Any,
+        graph: Any,
+        retry_count: int,
+        max_user_code_retries: int,
+        ubf_context: Any,
+        inputs: Any,
+    ) -> None:
+        self._task_attrs = {
+            ATTR_FLOW: flow.__class__.__name__,
+            ATTR_RUN_ID: str(run_id),
+            ATTR_STEP: step_name,
+            ATTR_TASK_ID: str(task_id),
+            ATTR_ATTEMPT: str(retry_count),
+        }
+        self._provider = self._provider_factory(self._task_attrs)
+        self._shipper = LogShipper(self._provider)
+
+    def task_post_step(
+        self,
+        step_name: str,
+        flow: Any,
+        graph: Any,
+        retry_count: int,
+        max_user_code_retries: int,
+    ) -> None:
+        self._emit_and_flush()
+
+    def task_exception(
+        self,
+        exception: Exception,
+        step_name: str,
+        flow: Any,
+        graph: Any,
+        retry_count: int,
+        max_user_code_retries: int,
+    ) -> None:
+        self._emit_and_flush()
+
+    def _emit_and_flush(self) -> None:
+        if self._shipper is None:
+            return
+        for env_var in _LOG_ENV_VARS:
+            path = os.environ.get(env_var)
+            if path and os.path.exists(path):
+                with open(path, "rb") as fh:
+                    for line in parse_stream(fh.read()):
+                        self._shipper.ship(line, self._task_attrs)
+        if self._provider is not None:
+            self._provider.shutdown()
+        self._shipper = None
+        self._provider = None