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:
Newer release available (1.0.0b18)

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.0b17.tar.gz (513.8 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.0b17-py3-none-any.whl (42.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: plone_observability-1.0.0b17.tar.gz
  • Upload date:
  • Size: 513.8 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.0b17.tar.gz
Algorithm Hash digest
SHA256 94dfa05051f21e4e68436df37cdf5614aab68586ae7e960fee6c817cccbcf183
MD5 6f283e09070af6f4ff1386c1aef4feab
BLAKE2b-256 ed90ec7375a4b73a2f92faffa12fa8ab9a34e8b02106dba6b2b3dfb6b8deab0a

See more details on using hashes here.

Provenance

The following attestation bundles were made for plone_observability-1.0.0b17.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.0b17-py3-none-any.whl.

File metadata

File hashes

Hashes for plone_observability-1.0.0b17-py3-none-any.whl
Algorithm Hash digest
SHA256 81a7aa99274f2d3b96aa23674a8f7bf27106b7b042e0dfe4a9ec5f7c4f87cdc4
MD5 514acde6d4f7dfe5aa23e86b0e28090b
BLAKE2b-256 3563afaadc6accb5ea93678470e170f3ba8e65a2b8e78267a82ea874653c2615

See more details on using hashes here.

Provenance

The following attestation bundles were made for plone_observability-1.0.0b17-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