Pre-release

This release is a pre-release and may not be stable for production use.

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 @@metrics endpoint 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.

Project links

Data verified by PyPI on
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for jensens from gravatar.com jensens

Credits

Author: Jens Klein

GitHub Statistics

Data verified by PyPI on 
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

GPL-2.0-only
View SPDX License List

Requires

Python >=3.10

Provides Extra

opentelemetry opentelemetry-io test

Classifiers

Report project as malware

Download files

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

Source Distribution

plone_observability-1.0.0b18.tar.gz (514.5 kB view details)

Uploaded Source

Built Distribution

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

plone_observability-1.0.0b18-py3-none-any.whl (42.7 kB view details)

Uploaded Python 3

File details

Details for the file plone_observability-1.0.0b18.tar.gz.

File metadata

  • Download URL: plone_observability-1.0.0b18.tar.gz
  • Upload date:
  • Size: 514.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for plone_observability-1.0.0b18.tar.gz
Algorithm Hash digest
SHA256 e3035bae535a991359342964ea82c15a57c923f746e7f03710940284a28cd843
MD5 9696f7c526672fad29f6319f925cebca
BLAKE2b-256 d246d6a84934d8e453457c3b32ef8c9397054bff802f14a1cee3ffb5c2742179

See more details on using hashes here.

Provenance

The following attestation bundles were made for plone_observability-1.0.0b18.tar.gz:

Publisher: release.yaml on plone/plone.observability

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file plone_observability-1.0.0b18-py3-none-any.whl.

File metadata

File hashes

Hashes for plone_observability-1.0.0b18-py3-none-any.whl
Algorithm Hash digest
SHA256 48e86a762f54ad50a57f6bf47428c105a2e120b58dac8b57018c347f32aa20d0
MD5 52967c38cf19c096867c58cea65e9fd4
BLAKE2b-256 7909fbc1faac26f5d1bbf0e9091a5b99dddb42bc180ff6af5a2a51cf45fd44cb

See more details on using hashes here.

Provenance

The following attestation bundles were made for plone_observability-1.0.0b18-py3-none-any.whl:

Publisher: release.yaml on plone/plone.observability

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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