Skip to content

Commit 10da036

Browse files
committed
docs: move Prysm into Observability & Audit subsection
- Move prysm.md into cloud-storage/observability/ so it sits alongside Prometheus and Perses as part of the unified observability story - Rename the observability section to "Observability & Audit" to reflect Prysm's audit and compliance capabilities (log analysis, access audit) - Update observability/index.md: add Prysm to the stack table, add Audit to the key metrics list, fix See Also links - Update cloud-storage/index.md: remove standalone Prysm row, update component table, data flow diagram, and See Also links accordingly - Fix prysm.md internal link: ceph.md path updated for new folder depth
1 parent 9201f7b commit 10da036

3 files changed

Lines changed: 14 additions & 12 deletions

File tree

docs/architecture/cloud-storage/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The storage stack is organized into three layers:
1414

1515
**Operations**[Rook](./rook.md) runs as a Kubernetes operator and manages the full lifecycle of Ceph daemons (monitors, managers, OSDs, MDS, RGW) as containerized workloads. [Arbiter](./arbiter.md) extends quorum into stretched cluster topologies by deploying external Ceph monitors that Rook does not manage directly.
1616

17-
**Data Services**[Chorus](./chorus.md) provides zero-downtime data replication and migration between object storage systems (S3 and Swift). [Liquid-Ceph](./liquid-ceph.md) enables dynamic, on-demand storage allocation across the cluster. [Prysm](./prysm.md) delivers a CLI-based observability layer over Ceph clusters and RGW deployments.
17+
**Data Services**[Chorus](./chorus.md) provides zero-downtime data replication and migration between object storage systems (S3 and Swift). [Liquid-Ceph](./liquid-ceph.md) enables dynamic, on-demand storage allocation across the cluster.
1818

1919
## Components
2020

@@ -25,8 +25,7 @@ The storage stack is organized into three layers:
2525
| [Arbiter](./arbiter.md) | Operations | External Ceph monitors for quorum in stretched clusters |
2626
| [Chorus](./chorus.md) | Data Services | Zero-downtime object storage replication and migration |
2727
| [Liquid-Ceph](./liquid-ceph.md) | Data Services | Dynamic storage allocation across the Ceph cluster |
28-
| [Prysm](./prysm.md) | Data Services | Observability CLI for Ceph clusters and RGW |
29-
| [Observability](./observability/) | Observability | Metrics, dashboards, and alerting for the storage stack |
28+
| [Observability & Audit](./observability/) | Observability | Metrics, dashboards, alerting, and audit — Prometheus, Perses, Prysm |
3029

3130
## Storage Interfaces
3231

@@ -58,9 +57,10 @@ Applications / VMs
5857
└───────────┘ └─────────┘ └────────────┘
5958
(quorum) (replication) (allocation)
6059
61-
┌────┴──────┐
62-
│ Prysm │ ← observability CLI
63-
└───────────┘
60+
┌────┴──────────────────────────┐
61+
│ Observability & Audit │
62+
│ Prometheus · Perses · Prysm │
63+
└───────────────────────────────┘
6464
```
6565

6666
## High Availability
@@ -69,6 +69,6 @@ Ceph achieves HA through monitor quorum (typically 3 or 5 monitors), OSD replica
6969

7070
## See Also
7171

72-
- [Observability](./observability/) — Prometheus metrics and Perses dashboards for the storage stack
72+
- [Observability & Audit](./observability/) — Prometheus metrics, Perses dashboards, and Prysm CLI for the storage stack
7373
- [Ceph upstream architecture docs](https://docs.ceph.com/en/latest/architecture/)
7474
- [Rook documentation](https://rook.io/docs/rook/latest-release/Getting-Started/intro/)

docs/architecture/cloud-storage/observability/index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
---
2-
title: Overview
2+
title: Observability & Audit
33
---
44

5-
# Observability Overview
5+
# Observability & Audit Overview
66

7-
CobaltCore monitors the cloud storage stack through a combination of Prometheus-based metrics collection and Perses dashboards. Together they provide real-time visibility into Ceph cluster health, OSD performance, RGW throughput, and storage capacity trends.
7+
CobaltCore monitors the cloud storage stack through a combination of Prometheus-based metrics collection, Perses dashboards, and the Prysm observability CLI. Together they provide real-time visibility into Ceph cluster health, OSD performance, RGW throughput, storage capacity trends, and audit compliance.
88

99
## Stack
1010

1111
| Component | Role |
1212
|-----------|------|
1313
| [Prometheus](./prometheus.md) | Scrapes and stores time-series metrics from Ceph, Rook, and RGW exporters |
1414
| [Perses](./perses.md) | Dashboard platform for visualizing storage metrics and defining alerts |
15+
| [Prysm](./prysm.md) | CLI-based observability tool for Ceph clusters and RGW — real-time monitoring, SMART disk health, log compliance |
1516

1617
## Key Metrics
1718

@@ -23,6 +24,7 @@ The following signal categories are covered by the observability stack:
2324
- **RGW** — request rates, error rates, bandwidth per bucket and user
2425
- **Replication** — Chorus replication lag, sync success/failure rates
2526
- **Availability** — Arbiter monitor reachability, MDS active/standby state
27+
- **Audit** — log compliance analysis and access audit via Prysm consumers
2628

2729
## Alerting
2830

@@ -32,4 +34,4 @@ Alerts are defined as Prometheus rules and surfaced through the CobaltCore alert
3234

3335
- [Prometheus](./prometheus.md)
3436
- [Perses](./perses.md)
35-
- [Prysm](../prysm.md) — CLI-based observability for Ceph and RGW
37+
- [Prysm](./prysm.md)

docs/architecture/cloud-storage/prysm.md renamed to docs/architecture/cloud-storage/observability/prysm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Prysm
55
# Prysm
66

77
Prysm is a comprehensive observability CLI tool developed by CobaltCore for
8-
monitoring [Ceph](./ceph.md) storage clusters and RADOS Gateway (RGW)
8+
monitoring [Ceph](../ceph.md) storage clusters and RADOS Gateway (RGW)
99
deployments. Prysm provides a multi-layered architecture designed to deliver
1010
real-time monitoring, data collection, and analysis across Ceph environments.
1111

0 commit comments

Comments
 (0)