From deeb3ea8b77fc17494a7c41f2094594b40e7a70e Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Wed, 4 Mar 2026 03:11:47 +1000 Subject: [PATCH] Doc: Add Prysm documentation Add a basic Prysm overview page to the Architecture page of the CobaltCore website. Signed-off-by: Zac Dover --- docs/architecture/prysm.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 docs/architecture/prysm.md diff --git a/docs/architecture/prysm.md b/docs/architecture/prysm.md new file mode 100644 index 0000000..2b9553b --- /dev/null +++ b/docs/architecture/prysm.md @@ -0,0 +1,37 @@ +--- +title: Prysm +--- + +# Prysm + +Prysm is a comprehensive observability CLI tool developed by CobaltCore for +monitoring [Ceph](./ceph.md) storage clusters and RADOS Gateway (RGW) +deployments. Prysm provides a multi-layered architecture designed to deliver +real-time monitoring, data collection, and analysis across Ceph environments. + +Prysm employs a four-tier architecture consisting of Consumers, NATS +messaging, Remote Producers, and Nearby Producers. This design enables flexible +data collection from diverse sources within Ceph infrastructure. Remote +Producers gather metrics via APIs from outside the monitored environment, +collecting data such as RGW bucket notifications, quota usage, and RadosGW +usage statistics. Nearby Producers operate within the same network as Ceph +clusters, providing direct access to logs, metrics, and hardware sensors for +lower latency and higher fidelity monitoring of disk health, kernel metrics, +and resource usage. + +NATS serves as the messaging backbone, routing data between producers and +consumers with low latency and reliable delivery. Consumers process this data +to generate alerts, perform analytics, display real-time dashboards, and ensure +compliance through log analysis. + +Prysm supports multiple output formats including console, NATS, and Prometheus, +making it adaptable to existing monitoring infrastructure. It can function +standalone for specific tasks such as providing Prometheus metrics endpoints or +checking disk health through SMART attributes. + +Prysm addresses the operational complexity of managing large-scale Ceph +deployments by providing unified observability across storage clusters, gateway +services, and underlying hardware components. + +## See Also +[The Prysm Repository](https://github.com/cobaltcore-dev/prysm)