plone.observability
Kubernetes-style health probes, a pluggable Prometheus and JSON metrics endpoint, and optional OpenTelemetry tracing for Plone running in containers.
Plone's built-in @@ok view answers OK whether the database is reachable or not, right up until the process is too busy to answer at all.
plone.observability gives an orchestrator the real signals it needs: separate liveness, readiness, and startup probes on a dedicated port that stays answerable under load, plus a metrics endpoint your monitoring stack can scrape.
Features
- Liveness, readiness, and startup probes on a separate HTTP port
- A pluggable
@@metricsendpoint with Prometheus and JSON output - Request, ZODB, and content metrics with low-cardinality labels
- Optional OpenTelemetry tracing that honors the standard
OTEL_*environment variables - Extensible via the Zope Component Architecture: custom health checks, metric providers, and formatters
Installation
Add plone.observability to your dependencies, include its ZCML, and wire the WSGI filters.
See the installation guide for the full steps.
[project]
dependencies = [
"plone.observability",
]
<include package="plone.observability" />
Documentation
Full documentation is at https://plone.github.io/plone.observability/:
- How-to guides — install, configure Kubernetes probes, scrape with Prometheus, enable tracing, extend via ZCA
- Reference — configuration, health endpoints, metrics, tracing, interfaces
- Explanation — why three probes, why a separate port, label cardinality, tracing design
For LLM context, see llms.txt.
License
GPL-2.0-only. See LICENSE.
1 maintainer
Release files for plone.observability 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| plone_observability-1.0.0.tar.gz | 514.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| plone_observability-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 557.5 kB
Release files / plone_observability-1.0.0.tar.gz
| Download URL | plone_observability-1.0.0.tar.gz |
|---|---|
| Size | 514.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b9c20f4f11192f6facf7693af2a5fe44142172b5cda66b7cbf3cab7d273155ec
|
|
BLAKE2b-256 checksum How to use checksums |
80c940d6ec2ef86428ca9789fbd62886d5518182eea640dfd9262ee5c6b62207
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 14, 2026.
Transparency logRelease files / plone_observability-1.0.0-py3-none-any.whl
| Download URL | plone_observability-1.0.0-py3-none-any.whl |
|---|---|
| Size | 42.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4e8618a75b62b947c2b95384aa90f39c9e5d6bd26532667e1e51a31b6f1e23cd
|
|
BLAKE2b-256 checksum How to use checksums |
bd175fe89362383da4c836df0cdf5109ea4f6ebc8683e07a8cdfb778755dca07
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 14, 2026.
Transparency log
