# michelderu/cassandra-health-check architecture

> Architecture diagram of the GitHub repository michelderu/cassandra-health-check, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/michelderu/cassandra-health-check
- Repository: https://github.com/michelderu/cassandra-health-check

## Overview

This repository is a hands-on Cassandra/HCD health-check curriculum, not a standalone monitoring service. Its learning path moves from live health snapshots and a local lab through diagnostic collection to sperf and Montecristo analysis, with metrics and troubleshooting as supporting topics. The README documents the curriculum flow and container workflow; source excerpts were unavailable, so implementation-level connections are omitted.

Main entry points: [`docs/04-diagnostic-collection.md`](https://github.com/michelderu/cassandra-health-check/blob/main/docs/04-diagnostic-collection.md) (Diagnostic collection), [`docs/01-health-snapshot-bare-metal.md`](https://github.com/michelderu/cassandra-health-check/blob/main/docs/01-health-snapshot-bare-metal.md) (Bare-metal snapshot), [`scripts/analyze.sh`](https://github.com/michelderu/cassandra-health-check/blob/main/scripts/analyze.sh) (Analysis launcher), [`docker/Dockerfile`](https://github.com/michelderu/cassandra-health-check/blob/main/docker/Dockerfile) (Analysis container)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_training["Health training"]
  node_baremetal["Bare-metal snapshot"]
  node_kubernetes["Kubernetes snapshot"]
end

subgraph group_lab["Lab and collection"]
  node_local_lab["Local lab<br/>[03-local-lab.md]"]
  node_collector_guide["Diagnostic collection"]
end

subgraph group_analysis["Analysis workflow"]
  node_sperf_guide["sperf analysis"]
  node_montecristo_guide["Montecristo analysis"]
  node_analyze["Analysis launcher<br/>[analyze.sh]"]
  node_analysis_image["Analysis container"]
  node_discovery_output["Analysis outputs<br/>[README.md]"]
end

subgraph group_reference["Operational references"]
  node_metrics["Key metrics<br/>[07-key-metrics.md]"]
  node_troubleshooting["Troubleshooting"]
end

node_learner(("Technical specialist"))
node_collector["Diagnostic Collector"]
node_sperf["sperf CLI"]
node_montecristo["Montecristo"]

node_learner -->|"studies"| node_baremetal
node_learner -->|"studies"| node_kubernetes
node_baremetal -->|"leads to"| node_local_lab
node_kubernetes -->|"leads to"| node_local_lab
node_local_lab -->|"leads to"| node_collector_guide
node_collector_guide -->|"explains use"| node_collector
node_collector_guide -->|"leads to"| node_sperf_guide
node_collector_guide -->|"leads to"| node_montecristo_guide
node_sperf_guide -->|"leads to"| node_montecristo_guide
node_learner -->|"runs"| node_analyze
node_analyze -->|"runs"| node_analysis_image
node_analysis_image -->|"includes"| node_sperf
node_analysis_image -->|"includes"| node_montecristo
node_analyze -->|"writes"| node_discovery_output
node_metrics -.->|"informs"| node_baremetal
node_troubleshooting -.->|"informs"| node_baremetal
node_learner -->|"consults"| node_metrics
node_learner -->|"consults"| node_troubleshooting

click node_baremetal "https://github.com/michelderu/cassandra-health-check/blob/main/docs/01-health-snapshot-bare-metal.md"
click node_kubernetes "https://github.com/michelderu/cassandra-health-check/blob/main/docs/02-health-snapshot-kubernetes.md"
click node_local_lab "https://github.com/michelderu/cassandra-health-check/blob/main/docs/03-local-lab.md"
click node_collector_guide "https://github.com/michelderu/cassandra-health-check/blob/main/docs/04-diagnostic-collection.md"
click node_sperf_guide "https://github.com/michelderu/cassandra-health-check/blob/main/docs/05-sperf-analysis.md"
click node_montecristo_guide "https://github.com/michelderu/cassandra-health-check/blob/main/docs/06-montecristo-analysis.md"
click node_analyze "https://github.com/michelderu/cassandra-health-check/blob/main/scripts/analyze.sh"
click node_analysis_image "https://github.com/michelderu/cassandra-health-check/blob/main/docker/Dockerfile"
click node_discovery_output "https://github.com/michelderu/cassandra-health-check/blob/main/ds-discovery/README.md"
click node_metrics "https://github.com/michelderu/cassandra-health-check/blob/main/docs/07-key-metrics.md"
click node_troubleshooting "https://github.com/michelderu/cassandra-health-check/blob/main/docs/08-troubleshooting.md"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_baremetal,node_kubernetes toneBlue
class node_local_lab,node_collector_guide toneAmber
class node_sperf_guide,node_montecristo_guide,node_analyze,node_analysis_image,node_discovery_output toneMint
class node_metrics,node_troubleshooting toneRose
class node_learner,node_collector,node_sperf,node_montecristo toneIndigo
```

## Components

### Health training

- [Bare-metal snapshot](https://github.com/michelderu/cassandra-health-check/blob/main/docs/01-health-snapshot-bare-metal.md): `docs/01-health-snapshot-bare-metal.md`
- [Kubernetes snapshot](https://github.com/michelderu/cassandra-health-check/blob/main/docs/02-health-snapshot-kubernetes.md): `docs/02-health-snapshot-kubernetes.md`

### Lab and collection

- [Local lab](https://github.com/michelderu/cassandra-health-check/blob/main/docs/03-local-lab.md): `docs/03-local-lab.md`
- [Diagnostic collection](https://github.com/michelderu/cassandra-health-check/blob/main/docs/04-diagnostic-collection.md): `docs/04-diagnostic-collection.md`

### Analysis workflow

- [sperf analysis](https://github.com/michelderu/cassandra-health-check/blob/main/docs/05-sperf-analysis.md): `docs/05-sperf-analysis.md`
- [Montecristo analysis](https://github.com/michelderu/cassandra-health-check/blob/main/docs/06-montecristo-analysis.md): `docs/06-montecristo-analysis.md`
- [Analysis launcher](https://github.com/michelderu/cassandra-health-check/blob/main/scripts/analyze.sh): `scripts/analyze.sh`
- [Analysis container](https://github.com/michelderu/cassandra-health-check/blob/main/docker/Dockerfile): `docker/Dockerfile`
- [Analysis outputs](https://github.com/michelderu/cassandra-health-check/blob/main/ds-discovery/README.md): `ds-discovery/README.md`

### Operational references

- [Key metrics](https://github.com/michelderu/cassandra-health-check/blob/main/docs/07-key-metrics.md): `docs/07-key-metrics.md`
- [Troubleshooting](https://github.com/michelderu/cassandra-health-check/blob/main/docs/08-troubleshooting.md): `docs/08-troubleshooting.md`

### Other components

- **Technical specialist**
- **Diagnostic Collector**
- **sperf CLI**
- **Montecristo**

## Connections

- Technical specialist → Bare-metal snapshot: studies (evidence: `README.md`)
- Technical specialist → Kubernetes snapshot: studies (evidence: `README.md`)
- Bare-metal snapshot → Local lab: leads to (evidence: `README.md`)
- Kubernetes snapshot → Local lab: leads to (evidence: `README.md`)
- Local lab → Diagnostic collection: leads to (evidence: `README.md`)
- Diagnostic collection → Diagnostic Collector: explains use (evidence: `README.md`)
- Diagnostic collection → sperf analysis: leads to (evidence: `README.md`)
- Diagnostic collection → Montecristo analysis: leads to (evidence: `README.md`)
- sperf analysis → Montecristo analysis: leads to (evidence: `README.md`)
- Technical specialist → Analysis launcher: runs (evidence: `README.md`)
- Analysis launcher → Analysis container: runs (evidence: `README.md`)
- Analysis container → sperf CLI: includes (evidence: `README.md`)
- Analysis container → Montecristo: includes (evidence: `README.md`)
- Analysis launcher → Analysis outputs: writes (evidence: `README.md`)
- Key metrics → Bare-metal snapshot: informs (evidence: `README.md`)
- Troubleshooting → Bare-metal snapshot: informs (evidence: `README.md`)
- Technical specialist → Key metrics: consults (evidence: `README.md`)
- Technical specialist → Troubleshooting: consults (evidence: `README.md`)
