prefect-otel 0.0.1__tar.gz

prefect_otel-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,51 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  checks:
+    name: Python ${{ matrix.python-version }}
+    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@v6
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          python-version: ${{ matrix.python-version }}
+          cache-dependency-glob: pyproject.toml
+
+      - name: Install dependencies
+        run: uv sync --all-groups
+
+      - name: Check formatting
+        run: uv run ruff format --check .
+
+      - name: Lint
+        run: uv run ruff check .
+
+      - name: Type check
+        run: uv run mypy prefect_opentelemetry tests
+
+      - name: Test
+        run: uv run coverage run -m pytest
+
+      - name: Coverage
+        run: uv run coverage report
+
+      - name: Documentation coverage
+        run: uv run interrogate
+
+      - name: Build package
+        run: uv build
+

prefect_otel-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/prefect-otel
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          python-version: "3.13"
+          cache-dependency-glob: pyproject.toml
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@v1.13.0

prefect_otel-0.0.1/.gitignore

@@ -0,0 +1,11 @@
+.coverage
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.venv/
+build/
+dist/
+*.egg-info/
+__pycache__/
+*.py[cod]
+

prefect_otel-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.15
+    hooks:
+      - id: ruff-format
+      - id: ruff
+        args: [--fix]
+  - repo: https://github.com/econchick/interrogate
+    rev: 1.7.0
+    hooks:
+      - id: interrogate
+        args: [-vv]
+        pass_filenames: false
+

prefect_otel-0.0.1/.python-version

@@ -0,0 +1,2 @@
+3.10
+

prefect_otel-0.0.1/LICENSE

@@ -0,0 +1,161 @@
+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 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 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 those 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
+

prefect_otel-0.0.1/PKG-INFO

@@ -0,0 +1,239 @@
+Metadata-Version: 2.4
+Name: prefect-otel
+Version: 0.0.1
+Summary: Experimental Prefect integration for OpenTelemetry auto-instrumentation.
+Author-email: "Prefect Technologies, Inc." <help@prefect.io>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/prefectlabs/prefect-otel
+Project-URL: Source, https://github.com/prefectlabs/prefect-otel
+Project-URL: Tracker, https://github.com/prefectlabs/prefect-otel/issues
+Keywords: prefect,opentelemetry,otel
+Classifier: Natural Language :: English
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: <3.15,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: prefect>=3.7.0
+Requires-Dist: opentelemetry-distro<1.0.0,>=0.48b0
+Requires-Dist: opentelemetry-exporter-otlp<2.0.0,>=1.27.0
+Requires-Dist: opentelemetry-instrumentation<1.0.0,>=0.48b0
+Dynamic: license-file
+
+# prefect-otel
+
+`prefect-otel` is an experimental Prefect integration for OpenTelemetry.
+
+This package provides a Prefect plugin hook that bootstraps OpenTelemetry
+Python auto-instrumentation in Prefect flow-run subprocesses.
+
+## Experimental Status
+
+This package is experimental. Public settings, behavior, and compatibility
+guarantees may change in breaking ways at any time.
+
+## Installation
+
+```bash
+pip install prefect-otel
+```
+
+OpenTelemetry automatic instrumentation still requires the normal
+OpenTelemetry packages and instrumentation libraries. The package depends on
+the OpenTelemetry distro and OTLP exporter, but users should still run
+bootstrap in their target environment when they want library-specific
+instrumentation:
+
+```bash
+opentelemetry-bootstrap -a install
+```
+
+## Usage
+
+No flow code changes are required. The environment that actually executes your
+flow must have:
+
+- `prefect-otel` installed.
+- Prefect plugins enabled with `PREFECT_PLUGINS_ENABLED=1`.
+- Standard OpenTelemetry `OTEL_*` environment variables configured.
+
+For deployed flows, this usually means the worker environment, job image,
+virtual environment, or work pool job configuration used by the deployment.
+
+Enable Prefect plugins in that same runtime:
+
+```bash
+export PREFECT_PLUGINS_ENABLED=1
+```
+
+Once Prefect loads this plugin, OpenTelemetry auto-instrumentation is enabled
+by default.
+
+Configure OpenTelemetry with standard `OTEL_*` environment variables in that
+same runtime:
+
+```bash
+export OTEL_SERVICE_NAME=my-prefect-flow
+export OTEL_TRACES_EXPORTER=otlp
+export OTEL_METRICS_EXPORTER=none
+export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
+```
+
+For a flow run directly from Python, set the same variables before starting the
+process:
+
+```bash
+python my_flow.py
+```
+
+The plugin runs when Prefect is imported. By default, it calls OpenTelemetry's
+programmatic auto-instrumentation initializer in each Prefect process. This
+allows spawned flow-run subprocesses to configure OpenTelemetry from inherited
+`OTEL_*` variables even though the parent process's in-memory SDK setup is not
+inherited across Python `spawn`.
+
+You do not need to call `opentelemetry-instrument` in a custom Prefect command
+to use this package. If you already wrap a worker or application entrypoint
+with `opentelemetry-instrument`, you can keep that wrapper; this integration
+handles Prefect processes that are started later from the inherited
+environment.
+
+### Deployment Job Variables
+
+For deployments, set these variables in `job_variables.env` so the process that
+runs your flow receives them:
+
+```yaml
+deployments:
+- name: my-deployment
+  entrypoint: flows.py:my_flow
+  work_pool:
+    name: my-pool
+    job_variables:
+      env:
+        PREFECT_PLUGINS_ENABLED: "1"
+        OTEL_SERVICE_NAME: "my-prefect-flow"
+        OTEL_TRACES_EXPORTER: "otlp"
+        OTEL_METRICS_EXPORTER: "none"
+        OTEL_EXPORTER_OTLP_ENDPOINT: "http://otel-collector:4317"
+```
+
+If you create deployments from Python, pass the same environment variables in
+`job_variables`:
+
+```python
+from prefect import flow
+
+
+@flow
+def my_flow() -> None:
+    ...
+
+
+if __name__ == "__main__":
+    my_flow.deploy(
+        name="my-deployment",
+        work_pool_name="my-pool",
+        job_variables={
+            "env": {
+                "PREFECT_PLUGINS_ENABLED": "1",
+                "OTEL_SERVICE_NAME": "my-prefect-flow",
+                "OTEL_TRACES_EXPORTER": "otlp",
+                "OTEL_METRICS_EXPORTER": "none",
+                "OTEL_EXPORTER_OTLP_ENDPOINT": "http://otel-collector:4317",
+            }
+        },
+    )
+```
+
+These examples configure OTLP trace export and disable metric export. Adjust the
+`OTEL_*` values for your collector, exporter, and telemetry pipeline.
+
+Common places to set them:
+
+- Deployment `job_variables.env`.
+- Work pool default job variables.
+- Container image entrypoints or Kubernetes, Docker, ECS, Cloud Run, or other
+  job environment settings.
+
+For a container image, install the package and OpenTelemetry instrumentation in
+the image that will run flows:
+
+```dockerfile
+FROM prefecthq/prefect:3-python3.12
+
+RUN pip install prefect-otel \
+    && opentelemetry-bootstrap -a install
+```
+
+The image installs the package and instrumentation libraries. The deployment
+or work pool still needs the `job_variables.env` values shown above so the
+flow process can configure OpenTelemetry at runtime.
+
+### Disable Auto-Instrumentation
+
+To disable the integration without uninstalling it, set:
+
+```bash
+export PREFECT_INTEGRATIONS_OTEL_AUTO_INSTRUMENT=false
+```
+
+## Settings
+
+Settings follow Prefect integration naming conventions and can be configured
+with environment variables, `.env`, `prefect.toml`, or `pyproject.toml`.
+
+| Setting | Environment variable | Default |
+| --- | --- | --- |
+| `auto_instrument` | `PREFECT_INTEGRATIONS_OTEL_AUTO_INSTRUMENT` | `true` |
+| `require_auto_instrument` | `PREFECT_INTEGRATIONS_OTEL_REQUIRE_AUTO_INSTRUMENT` | `false` |
+
+`prefect.toml`:
+
+```toml
+[integrations.otel]
+auto_instrument = false
+require_auto_instrument = false
+```
+
+`pyproject.toml`:
+
+```toml
+[tool.prefect.integrations.otel]
+auto_instrument = false
+require_auto_instrument = false
+```
+
+If `require_auto_instrument` is true, initialization failures are re-raised.
+Use this with `PREFECT_PLUGINS_STRICT=1` when startup should fail instead of
+running without OpenTelemetry auto-instrumentation:
+
+```bash
+export PREFECT_PLUGINS_STRICT=1
+export PREFECT_INTEGRATIONS_OTEL_REQUIRE_AUTO_INSTRUMENT=true
+```
+
+## Diagnostics
+
+Prefect can show plugin discovery and hook results:
+
+```bash
+prefect plugins diagnose
+```
+
+If traces are missing, check that:
+
+- `prefect-otel` is installed in the environment that runs the flow, not just
+  in the environment where the deployment was built.
+- `PREFECT_PLUGINS_ENABLED=1` is set where the flow code runs.
+- The `OTEL_*` variables are inherited by the flow-run process.
+- The relevant OpenTelemetry instrumentation libraries are installed.
+- Your collector or exporter endpoint is reachable from the flow-run
+  environment.