temporal-parseable 0.1.0__tar.gz

temporal_parseable-0.1.0/.github/workflows/ci.yaml

@@ -0,0 +1,61 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+    tags: ["v*"]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - 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: Type check
+        run: mypy src/temporal_parseable
+
+      - name: Test
+        run: pytest --tb=short -q
+
+  publish:
+    name: Publish to PyPI
+    needs: test
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    environment: pypi
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build tools
+        run: pip install build twine
+
+      - name: Build
+        run: python -m build
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: twine upload dist/*

temporal_parseable-0.1.0/.gitignore

@@ -0,0 +1,40 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+.Python
+*.egg
+*.egg-info/
+dist/
+build/
+.eggs/
+*.whl
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# Type checking
+.mypy_cache/
+.ruff_cache/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# macOS
+.DS_Store
+
+# Distribution
+dist/
+*.tar.gz

temporal_parseable-0.1.0/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to `temporal-parseable` are documented here.
+
+## [0.1.0] - 2026-06-03
+
+### Added
+- `ParseablePlugin` — drop-in Temporal plugin wiring logs and traces to Parseable
+- `ParseableConfig` — dataclass config with full `PARSEABLE_*` env-var support
+- `ParseableActivityInterceptor` — emits `started / completed / failed` records per activity execution, including `attempt` and `duration_ms`
+- `ParseableWorkflowInboundInterceptor` — emits records for `execute_workflow`, `handle_signal`, `handle_query`, `handle_update`
+- `ParseableWorkflowOutboundInterceptor` — emits records for `start_child_workflow`, `signal_external_workflow`, `signal_child_workflow`, `continue_as_new`
+- `workflow_event()` — replay-safe helper for emitting custom domain events from workflow code
+- `SanitizingSpanExporter` — flattens non-primitive OTel span attributes to prevent Parseable `400` rejections
+- Correct `X-P-Log-Source` headers: `otel-logs` for logs pipeline, `otel-traces` for traces pipeline
+- Sandbox passthrough support — `temporal_parseable` marked as passthrough so the Temporal workflow sandbox does not attempt to import OTel/requests inside the isolate
+- Full `pyproject.toml` with hatchling build backend, pinned OTel 1.x deps, and `dev` extras
+- `examples/` with `worker.py`, `client.py`, `workflows.py` covering all interceptor paths
+- `tests/` with `test_config.py`, `test_sanitizing_exporter.py`, `test_interceptors.py`
+- `.github/workflows/ci.yml` — pytest on push/PR, auto-publish to PyPI on `v*` tag

temporal_parseable-0.1.0/INTEGRATION.MD

@@ -0,0 +1,176 @@
+# Parseable
+
+[Parseable](https://www.parseable.com/) is an observability platform for logs, metrics, and traces. The `temporal-parseable` plugin ships Temporal workflow and activity execution events to Parseable as both OpenTelemetry traces (a waterfall view of workflow runs) and structured log records (a queryable schema with `workflow_id`, `activity_name`, `attempt`, `duration_ms`, etc.).
+
+Together, the two streams give Temporal users:
+
+- A flame-graph trace of every workflow run, including child workflows and activity calls.
+- A flat, queryable log schema for fleet-wide analytics — failure rates by activity name, latency by workflow type, retry hotspots, and custom domain events emitted via a `workflow_event()` helper.
+
+---
+
+## Installation
+
+```bash
+pip install temporal-parseable
+```
+
+---
+
+## Configuration
+
+```python
+import asyncio
+from temporalio.client import Client
+from temporalio.worker import Worker
+from temporalio.worker.workflow_sandbox import SandboxedWorkflowRunner, SandboxRestrictions
+from temporal_parseable import ParseablePlugin, ParseableConfig
+
+config = ParseableConfig(
+    service_name="temporal-worker",
+    endpoint="https://parseable.example.com",
+    username="admin",
+    password="secret",
+    # optional — defaults shown:
+    # logs=LogsConfig(stream="temporal-logs"),
+    # traces=TracesConfig(stream="temporal-traces"),
+)
+plugin = ParseablePlugin(config)
+
+client = await Client.connect("localhost:7233", plugins=[plugin])
+
+# Required: mark temporal_parseable as a sandbox passthrough so the
+# Temporal workflow isolate does not try to import OTel/requests inside it.
+sandbox = SandboxedWorkflowRunner(
+    restrictions=SandboxRestrictions.default.with_passthrough_modules("temporal_parseable")
+)
+
+async with Worker(
+    client,
+    task_queue="my-queue",
+    workflows=[MyWorkflow],
+    activities=[my_activity],
+    workflow_runner=sandbox,
+):
+    await asyncio.Event().wait()
+```
+
+Logs are POSTed to `{endpoint}/v1/logs` with header `X-P-Log-Source: otel-logs`; traces to `{endpoint}/v1/traces` with `X-P-Log-Source: otel-traces`. Both pipelines are independently configurable — pass `logs=None` or `traces=None` to disable either.
+
+### Options
+
+| Option         | Type                   | Default                                  | Notes                                                                       |
+| -------------- | ---------------------- | ---------------------------------------- | --------------------------------------------------------------------------- |
+| `service_name` | `str`                  | `"temporal-worker"`                      | Becomes `service.name` OTel resource attribute and `service_name` log field |
+| `endpoint`     | `str`                  | `$PARSEABLE_URL`                         | Parseable base URL, e.g. `http://parseable.example:8010`                    |
+| `username`     | `str`                  | `$PARSEABLE_USERNAME`                    | HTTP Basic auth username                                                    |
+| `password`     | `str`                  | `$PARSEABLE_PASSWORD`                    | HTTP Basic auth password                                                    |
+| `logs`         | `LogsConfig \| None`   | `LogsConfig(stream="temporal-logs")`     | Set to `None` to disable log emission                                       |
+| `traces`       | `TracesConfig \| None` | `TracesConfig(stream="temporal-traces")` | Set to `None` to disable trace emission                                     |
+
+All options fall back to environment variables with the `PARSEABLE_` prefix when omitted.
+
+### Pre-create streams
+
+Parseable's OTLP endpoint requires the target stream to exist before first ingest. Run once:
+
+```bash
+curl -u admin:admin -X PUT https://parseable.example.com/api/v1/logstream/temporal-logs
+curl -u admin:admin -X PUT https://parseable.example.com/api/v1/logstream/temporal-traces
+```
+
+---
+
+## What gets captured
+
+### Workflow lifecycle
+
+Every workflow run emits `started` and `completed` (or `failed`) records with `duration_ms`, `workflow_id`, `run_id`, `workflow_name`, and on failure an `error` message.
+
+### Activity lifecycle
+
+Every activity execution emits `started` and `completed` (or `failed`) records carrying `activity_name`, `activity_id`, `attempt`, `duration_ms`, and the parent workflow's identifiers. Retries produce a record per attempt — the `attempt` field is 1-based.
+
+### Inbound and outbound messages
+
+In addition to workflow and activity records, the plugin emits **message records** (`type: signal | query | update | child_workflow | continue_as_new`) for:
+
+- Signals, queries, and updates received by the workflow.
+- Outgoing signals to other workflows, child workflows started, and continue-as-new transitions.
+
+The `direction` field distinguishes `inbound` (received by this workflow) from `outbound` (sent by this workflow).
+
+| Field                                      | Type                                                                     | Notes                                            |
+| ------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------ |
+| `type`                                     | `signal` \| `query` \| `update` \| `child_workflow` \| `continue_as_new` |                                                  |
+| `direction`                                | `inbound` \| `outbound`                                                  |                                                  |
+| `status`                                   | `started` \| `completed` \| `failed`                                     |                                                  |
+| `message_name`                             | string                                                                   | signal/query/update name, or child workflow type |
+| `target_workflow_id`                       | string                                                                   | outbound signals/child workflows only            |
+| `workflow_id` / `run_id` / `workflow_name` | string                                                                   | the workflow emitting/handling the message       |
+| `duration_ms`                              | float                                                                    | on completion/fail                               |
+| `error`                                    | string                                                                   | on fail                                          |
+
+### Custom user events from workflow code
+
+Workflows can emit replay-safe domain events via the `workflow_event` helper:
+
+```python
+from temporal_parseable.workflow import workflow_event
+
+@workflow.defn
+class AgentWorkflow:
+    @workflow.run
+    async def run(self, input: AgentInput) -> AgentResult:
+        workflow_event("agent.started", {"user_id": input.user_id})
+
+        plan = await workflow.execute_activity(plan_activity, input)
+        workflow_event("agent.plan.chosen", {"steps": len(plan.steps)})
+
+        for step in plan.steps:
+            workflow_event("agent.step.start", {"tool": step.tool})
+            await workflow.execute_activity(run_step, step)
+
+        return result
+```
+
+Each call emits a record with `type: "user_event"`, `event_name`, and an arbitrary JSON-serialisable `event_data` payload. Useful for AI agents, multi-step orchestration, or any case where you want domain-specific signals alongside Temporal's built-in lifecycle events.
+
+### Replay safety
+
+All workflow-side emission is replay-safe. The plugin guards every emit with `workflow.unsafe.is_replaying()`, so workflow records and user events are never duplicated when Temporal replays workflow history (during worker recovery, cache eviction, or manual replay). This is verified by an automated test using `Replayer.replay_workflow()`.
+
+---
+
+## Log schema
+
+| Field                | Type                                                                                                                 | Notes                           |
+| -------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
+| `type`               | `activity` \| `workflow` \| `user_event` \| `signal` \| `query` \| `update` \| `child_workflow` \| `continue_as_new` | discriminator                   |
+| `status`             | `started` \| `completed` \| `failed`                                                                                 | not present on `user_event`     |
+| `service_name`       | string                                                                                                               | from plugin config              |
+| `timestamp`          | ISO 8601                                                                                                             | event time                      |
+| `workflow_id`        | string                                                                                                               |                                 |
+| `run_id`             | string                                                                                                               |                                 |
+| `workflow_name`      | string                                                                                                               |                                 |
+| `activity_name`      | string                                                                                                               | activity records only           |
+| `activity_id`        | string                                                                                                               | activity records only           |
+| `attempt`            | int                                                                                                                  | activity records only (1-based) |
+| `duration_ms`        | float                                                                                                                | on completion/fail              |
+| `error`              | string                                                                                                               | on fail                         |
+| `direction`          | `inbound` \| `outbound`                                                                                              | message records only            |
+| `message_name`       | string                                                                                                               | message records only            |
+| `target_workflow_id` | string                                                                                                               | outbound message records        |
+| `event_name`         | string                                                                                                               | user events only                |
+| `event_data`         | object                                                                                                               | user events only                |
+
+All logs and traces carry a `parseable.plugin.version` resource attribute so consumers can correlate behaviour with plugin releases.
+
+---
+
+## Links
+
+- Plugin source: https://github.com/parseablehq/temporal-plugin-python
+- PyPI: https://pypi.org/project/temporal-parseable
+- Parseable docs: https://www.parseable.com/docs
+- TypeScript SDK: https://github.com/parseablehq/temporal-plugin

temporal_parseable-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.