Skip to main content

Flowrensic Python SDK

Pre-release. This package is an early preview and not ready for production. Its API can change in any version.

Flowrensic runs beside your durable workflow engine and finds problems in your workflows. This is the Python SDK of Temporal Flowrensic, the edition for Temporal.

What it does today

  • Connects a Temporal Python worker to your Flowrensic server, with your env access key, so the worker shows up in Flowrensic. Call temporal_flowrensic.client.connect.
  • Every call to Flowrensic carries your env, its access key and the ephemeral run in the headers Flowrensic-Current-Env, Flowrensic-Env-Access-Key and Flowrensic-Current-Ephemeral-Run. Each part takes them as current_env, env_access_key and current_ephemeral_run. An env of kind ephemeral takes the ephemeral run, such as the CI build number, and without one the run is default. The SDK reads no environment variable: you pass the values in code.
  • Records each activity attempt: its result, error type, attempt number and time, with the timeouts and retry limit it ran under. Register temporal_flowrensic.activity.Interceptor in Worker(interceptors=[...]) and give it a sink from temporal_flowrensic.client.create_attempt_sink. Each attempt carries the namespace Temporal gives the activity, so there is no namespace setting. It never changes what an activity returns or raises.
  • The sink keeps the attempts in the worker's memory and sends them to Flowrensic in batches, in the background. Each send has a time limit. When Flowrensic does not answer, the attempts wait and are sent again later. The buffer has a limit on records and on memory, and past it the oldest are dropped and counted.
import temporal_flowrensic.activity
import temporal_flowrensic.client

sink = temporal_flowrensic.client.create_attempt_sink(
    "http://flowrensic:8080", current_env="prod", env_access_key=env_access_key, current_ephemeral_run="prod-1",
    worker_name="orders-worker",
)
worker = Worker(
    client,
    task_queue="main",
    workflows=[...],
    activities=[...],
    interceptors=[temporal_flowrensic.activity.Interceptor(sink, current_env="prod", current_ephemeral_run="prod-1", version=build_id)],
)
  • Worker telemetry: temporal_flowrensic.client.start_telemetry says hello, then sends regular beats so Flowrensic knows the worker is up, the engine's and the worker's own metrics, and the history of each run the worker saw. At shutdown it hands the ephemeral run over. When Flowrensic does not answer, the worker still starts and keeps trying in the background. Give telemetry.sink to the activity interceptor.
telemetry = await temporal_flowrensic.client.start_telemetry(
    server_base_url="http://flowrensic:8080",
    current_env="prod",
    env_access_key=env_access_key,
    current_ephemeral_run="prod-1",
    version=build_id,
    namespace="default",
    temporal_client=client,
)
interceptor = temporal_flowrensic.activity.Interceptor(telemetry.sink, current_env="prod", current_ephemeral_run="prod-1", version=build_id)
# ... run the worker ...
await telemetry.shutdown()
  • Client calls: temporal_flowrensic.client.ClientInterceptor in Client.connect(plugins=[...]) sends every query and signal that fails, and whether it ended on its deadline, under the namespace of the client. temporal_flowrensic.workflow.Interceptor in Worker(interceptors=[...]) counts the queries your workflows answer. Neither changes what a call returns or raises, or what a workflow does.

  • Replay before deploy: in CI, temporal_flowrensic.client.fetch_replay_set writes the histories Flowrensic picks for a workflow type from each env of replay_history_from_envs, such as ["prod", "staging"], asked as your current_env, which must be of kind ephemeral, since a persistent env is refused, you replay them with temporalio's Replayer, and temporal_flowrensic.client.publish_verdicts sends the result back, with the names of the workflow interceptors the replay ran with, as temporal_flowrensic.client.interceptor_name gives them. Give the same interceptors to start_telemetry, so Flowrensic can compare the two lists.

  • Deploy reports from CI: temporal_flowrensic.client.report_deploy_stage sends each stage of a deploy. Every CI call has a time limit and stops with a message that says Flowrensic could not be reached or what it answered. A failed deploy report does not fail the job unless you ask it to.

Planned

  • Each new part of the Node SDK, @flowrensic/temporal-flowrensic-node-sdk, comes to the Python SDK too.

Install

pip install temporal-flowrensic-python-sdk

Metadata

Release files for temporal-flowrensic-python-sdk 0.6.64

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for temporal-flowrensic-python-sdk 0.6.64
File Size Uploaded Provenance Actions
temporal_flowrensic_python_sdk-0.6.64.tar.gz 80.0 kB Without provenance Details for temporal_flowrensic_python_sdk-0.6.64.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for temporal-flowrensic-python-sdk 0.6.64
File Interpreter ABI Platform Actions
temporal_flowrensic_python_sdk-0.6.64-py3-none-any.whl Python 3 none any Details for temporal_flowrensic_python_sdk-0.6.64-py3-none-any.whl

Total release size: 191.1 kB

Release files / temporal_flowrensic_python_sdk-0.6.64.tar.gz

Download URL temporal_flowrensic_python_sdk-0.6.64.tar.gz
Size 80.0 kB
Tags Source
SHA-256 checksum
How to use checksums
557177081cd6b19a08f9ed8390b661f2f748f2f92b2291f73a472b4cda0c5c52
BLAKE2b-256 checksum
How to use checksums
ae5f97cc5ed9435bce01a2cdfc07252967645f79e427aad4ee3e3442aef7b894
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / temporal_flowrensic_python_sdk-0.6.64-py3-none-any.whl

Download URL temporal_flowrensic_python_sdk-0.6.64-py3-none-any.whl
Size 111.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ff22285b7339274267434918ebf97ee9e888b03a4f03ee7325830ca59235cb40
BLAKE2b-256 checksum
How to use checksums
8fa6ee48b52e87e00e47bc26d947460632ba22684653bc51f4500e4869c79103
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for temporal-flowrensic-python-sdk 0.6.64

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page