Skip to content

Commit 0c64cae

Browse files
authored
Merge pull request #9 from zdover23/docs-2025-03-04-docs-architecture-prysm
Doc: Add Prysm documentation
2 parents 8fb4aa4 + deeb3ea commit 0c64cae

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

docs/architecture/prysm.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Prysm
3+
---
4+
5+
# Prysm
6+
7+
Prysm is a comprehensive observability CLI tool developed by CobaltCore for
8+
monitoring [Ceph](./ceph.md) storage clusters and RADOS Gateway (RGW)
9+
deployments. Prysm provides a multi-layered architecture designed to deliver
10+
real-time monitoring, data collection, and analysis across Ceph environments.
11+
12+
Prysm employs a four-tier architecture consisting of Consumers, NATS
13+
messaging, Remote Producers, and Nearby Producers. This design enables flexible
14+
data collection from diverse sources within Ceph infrastructure. Remote
15+
Producers gather metrics via APIs from outside the monitored environment,
16+
collecting data such as RGW bucket notifications, quota usage, and RadosGW
17+
usage statistics. Nearby Producers operate within the same network as Ceph
18+
clusters, providing direct access to logs, metrics, and hardware sensors for
19+
lower latency and higher fidelity monitoring of disk health, kernel metrics,
20+
and resource usage.
21+
22+
NATS serves as the messaging backbone, routing data between producers and
23+
consumers with low latency and reliable delivery. Consumers process this data
24+
to generate alerts, perform analytics, display real-time dashboards, and ensure
25+
compliance through log analysis.
26+
27+
Prysm supports multiple output formats including console, NATS, and Prometheus,
28+
making it adaptable to existing monitoring infrastructure. It can function
29+
standalone for specific tasks such as providing Prometheus metrics endpoints or
30+
checking disk health through SMART attributes.
31+
32+
Prysm addresses the operational complexity of managing large-scale Ceph
33+
deployments by providing unified observability across storage clusters, gateway
34+
services, and underlying hardware components.
35+
36+
## See Also
37+
[The Prysm Repository](https://github.com/cobaltcore-dev/prysm)

0 commit comments

Comments
 (0)