Skip to main content

z4j Flask framework adapter (Apache 2.0)

Project description

z4j-flask

PyPI version Python License

The Flask framework adapter for z4j.

Adds the z4j agent into your Flask app via a one-line Z4J(app) initializer. Auto-discovers the engine adapter you have installed (Celery, RQ, Dramatiq, Huey, arq, TaskIQ) and streams every task lifecycle event to z4j. Operator control actions flow back the same channel.

What it ships

  • One-line install, Z4J(app) and the agent connects on the next worker boot
  • Engine auto-discovery, picks up whichever z4j engine adapter is installed alongside; cross-stack combos (Flask + RQ, Flask + Celery) are first-class
  • @z4j_meta decorator, optional per-task annotations (priority="critical", description="...") for dashboard filtering and SLO display
  • Service-user safe, auto-relocates the local outbound buffer to $TMPDIR/z4j-{uid} when $HOME is unwritable

Install

pip install z4j-flask z4j-celery z4j-celerybeat

Wire it into your app:

from flask import Flask
from z4j_flask import Z4J

app = Flask(__name__)
Z4J(app)  # reads Z4J_AGENT_TOKEN, Z4J_BRAIN_URL, Z4J_PROJECT from env

Mint the agent token from the dashboard's Agents page.

Reliability

  • No exception from the agent ever propagates back into Flask request handlers or your worker code.
  • Events buffer locally when z4j is unreachable; your application never blocks on network I/O.

Documentation

Full docs at z4j.dev/frameworks/flask/.

License

Apache-2.0, see LICENSE.

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

z4j_flask-1.6.0.tar.gz (28.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

z4j_flask-1.6.0-py3-none-any.whl (22.9 kB view details)

Uploaded Python 3

File details

Details for the file z4j_flask-1.6.0.tar.gz.

File metadata

  • Download URL: z4j_flask-1.6.0.tar.gz
  • Upload date:
  • Size: 28.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for z4j_flask-1.6.0.tar.gz
Algorithm Hash digest
SHA256 49c333f55c30bdefc1da765a43de0821fc8754311a34634a2281a106cb70cd23
MD5 a4c44e23555f29c1473089f3dbd4db73
BLAKE2b-256 a556c197147d02f05e7fdb5d5ebb2c97d430ca52c849d94b562b64f00daa21a1

See more details on using hashes here.

File details

Details for the file z4j_flask-1.6.0-py3-none-any.whl.

File metadata

  • Download URL: z4j_flask-1.6.0-py3-none-any.whl
  • Upload date:
  • Size: 22.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for z4j_flask-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a9473e70778ad7894658d9b6593507b8a5cdcb5ebb33c503a76d8f935ba5e0f8
MD5 96a982053b524014b1b3aa13e0c0cf32
BLAKE2b-256 9b94a6da133d000fbf26e4ff9b08d88cf4862cdc62920c1d9f91f357be394bd2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page