# siddharthsoumya/driftshield architecture

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

- Interactive diagram: https://gitdiagram.com/siddharthsoumya/driftshield
- Repository: https://github.com/siddharthsoumya/driftshield

## Overview

DriftShield monitors configuration drift against a trusted YAML baseline, records differences, and automatically restores runtime configuration. The primary flow runs on a backend scheduler or detection API, then exposes persisted events and runtime state to a React dashboard that polls every five seconds. The README also documents alerts and persistent JPA storage. The graph follows excerpted calls and indexed references; deployment and unsampled implementation details are omitted.

Main entry points: [`backend/backend/src/main/java/com/driftshield/backend/detection/drift/DriftDetectionEngine.java`](https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/detection/drift/DriftDetectionEngine.java) (Detection engine), [`frontend/src/App.jsx`](https://github.com/siddharthsoumya/driftshield/blob/main/frontend/src/App.jsx) (Dashboard app), [`backend/backend/src/main/java/com/driftshield/backend/remediation/drift/AutoRevertService.java`](https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/remediation/drift/AutoRevertService.java) (Auto-revert service), [`frontend/src/api/driftApi.js`](https://github.com/siddharthsoumya/driftshield/blob/main/frontend/src/api/driftApi.js) (Drift API client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_monitor["Drift monitoring"]
  node_drift_api["Drift API"]
  node_scheduler["Monitoring scheduler"]
  node_engine["Detection engine"]
  node_yaml_loader["YAML loader"]
  node_comparator["Config comparator"]
end

subgraph group_backend["Backend services"]
  node_drift_service["Event service"]
  node_auto_revert["Auto-revert service"]
  node_restore["Config restore"]
  node_runtime_api["Runtime config API"]
  node_runtime_service["Runtime config service"]
  node_alert_api["Alert API"]
  node_alert_service["Alert service<br/>[AlertService.java]"]
end

subgraph group_storage["State and persistence"]
  node_drift_repo["Event repository"]
  node_drift_db[("Persistent database")]
  node_alert_repo["Alert repository"]
end

subgraph group_dashboard["Dashboard"]
  node_dashboard["Dashboard app<br/>[App.jsx]"]
  node_api_client["Drift API client<br/>[driftApi.js]"]
  node_polling["Polling service<br/>[pollingService.js]"]
  node_dashboard_views["Monitoring views"]
  node_infrastructure_view["Infrastructure status"]
  node_remediation_view["Remediation timeline"]
end

node_operator(("System activity"))

node_operator -.->|"submits activity"| node_drift_api
node_scheduler -->|"runs detection"| node_engine
node_drift_api -->|"runs detection"| node_engine
node_engine -->|"loads configs"| node_yaml_loader
node_engine -->|"compares configs"| node_comparator
node_engine -->|"saves differences"| node_drift_service
node_engine -->|"triggers restore"| node_auto_revert
node_drift_service -->|"saves and reads"| node_drift_repo
node_drift_repo -.->|"persists events"| node_drift_db
node_auto_revert -->|"restores config"| node_restore
node_auto_revert -->|"marks reverted"| node_drift_repo
node_runtime_api -->|"gets runtime config"| node_runtime_service
node_runtime_service -->|"loads runtime"| node_yaml_loader
node_alert_api -->|"handles alerts"| node_alert_service
node_alert_service -->|"stores and lists"| node_alert_repo
node_dashboard -->|"starts polling"| node_polling
node_dashboard -->|"requests data"| node_api_client
node_api_client -.->|"requests drift events"| node_drift_api
node_api_client -.->|"requests runtime state"| node_runtime_api
node_dashboard -->|"renders events"| node_dashboard_views
node_dashboard -->|"renders status"| node_infrastructure_view
node_dashboard -->|"renders history"| node_remediation_view

click node_drift_api "https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/controller/drift/DriftController.java"
click node_scheduler "https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/scheduler/DriftMonitoringScheduler.java"
click node_engine "https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/detection/drift/DriftDetectionEngine.java"
click node_yaml_loader "https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/detection/drift/YamlConfigLoader.java"
click node_comparator "https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/detection/drift/ConfigComparator.java"
click node_drift_service "https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/service/drift/DriftEventService.java"
click node_drift_repo "https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/repository/drift/DriftEventRepository.java"
click node_auto_revert "https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/remediation/drift/AutoRevertService.java"
click node_restore "https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/remediation/drift/ConfigRestoreService.java"
click node_runtime_api "https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/controller/runtime/RuntimeConfigController.java"
click node_runtime_service "https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/service/runtime/RuntimeConfigService.java"
click node_alert_api "https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/controller/alert/AlertController.java"
click node_alert_service "https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/service/alert/AlertService.java"
click node_alert_repo "https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/repository/alert/AlertRepository.java"
click node_dashboard "https://github.com/siddharthsoumya/driftshield/blob/main/frontend/src/App.jsx"
click node_api_client "https://github.com/siddharthsoumya/driftshield/blob/main/frontend/src/api/driftApi.js"
click node_polling "https://github.com/siddharthsoumya/driftshield/blob/main/frontend/src/services/pollingService.js"
click node_dashboard_views "https://github.com/siddharthsoumya/driftshield/blob/main/frontend/src/components/tables/DriftEventsTable.jsx"
click node_infrastructure_view "https://github.com/siddharthsoumya/driftshield/blob/main/frontend/src/components/cards/InfrastructureStatus.jsx"
click node_remediation_view "https://github.com/siddharthsoumya/driftshield/blob/main/frontend/src/components/timeline/RemediationTimeline.jsx"

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_drift_api,node_scheduler,node_engine,node_yaml_loader,node_comparator toneBlue
class node_drift_service,node_auto_revert,node_restore,node_runtime_api,node_runtime_service,node_alert_api,node_alert_service toneAmber
class node_drift_repo,node_drift_db,node_alert_repo toneMint
class node_dashboard,node_api_client,node_polling,node_dashboard_views,node_infrastructure_view,node_remediation_view toneRose
class node_operator toneIndigo
```

## Components

### Drift monitoring

- [Drift API](https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/controller/drift/DriftController.java): `backend/backend/src/main/java/com/driftshield/backend/controller/drift/DriftController.java`
- [Monitoring scheduler](https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/scheduler/DriftMonitoringScheduler.java): `backend/backend/src/main/java/com/driftshield/backend/scheduler/DriftMonitoringScheduler.java`
- [Detection engine](https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/detection/drift/DriftDetectionEngine.java): `backend/backend/src/main/java/com/driftshield/backend/detection/drift/DriftDetectionEngine.java`
- [YAML loader](https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/detection/drift/YamlConfigLoader.java): `backend/backend/src/main/java/com/driftshield/backend/detection/drift/YamlConfigLoader.java`
- [Config comparator](https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/detection/drift/ConfigComparator.java): `backend/backend/src/main/java/com/driftshield/backend/detection/drift/ConfigComparator.java`

### Backend services

- [Event service](https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/service/drift/DriftEventService.java): `backend/backend/src/main/java/com/driftshield/backend/service/drift/DriftEventService.java`
- [Auto-revert service](https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/remediation/drift/AutoRevertService.java): `backend/backend/src/main/java/com/driftshield/backend/remediation/drift/AutoRevertService.java`
- [Config restore](https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/remediation/drift/ConfigRestoreService.java): `backend/backend/src/main/java/com/driftshield/backend/remediation/drift/ConfigRestoreService.java`
- [Runtime config API](https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/controller/runtime/RuntimeConfigController.java): `backend/backend/src/main/java/com/driftshield/backend/controller/runtime/RuntimeConfigController.java`
- [Runtime config service](https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/service/runtime/RuntimeConfigService.java): `backend/backend/src/main/java/com/driftshield/backend/service/runtime/RuntimeConfigService.java`
- [Alert API](https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/controller/alert/AlertController.java): `backend/backend/src/main/java/com/driftshield/backend/controller/alert/AlertController.java`
- [Alert service](https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/service/alert/AlertService.java): `backend/backend/src/main/java/com/driftshield/backend/service/alert/AlertService.java`

### State and persistence

- [Event repository](https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/repository/drift/DriftEventRepository.java): `backend/backend/src/main/java/com/driftshield/backend/repository/drift/DriftEventRepository.java`
- **Persistent database**
- [Alert repository](https://github.com/siddharthsoumya/driftshield/blob/main/backend/backend/src/main/java/com/driftshield/backend/repository/alert/AlertRepository.java): `backend/backend/src/main/java/com/driftshield/backend/repository/alert/AlertRepository.java`

### Dashboard

- [Dashboard app](https://github.com/siddharthsoumya/driftshield/blob/main/frontend/src/App.jsx): `frontend/src/App.jsx`
- [Drift API client](https://github.com/siddharthsoumya/driftshield/blob/main/frontend/src/api/driftApi.js): `frontend/src/api/driftApi.js`
- [Polling service](https://github.com/siddharthsoumya/driftshield/blob/main/frontend/src/services/pollingService.js): `frontend/src/services/pollingService.js`
- [Monitoring views](https://github.com/siddharthsoumya/driftshield/blob/main/frontend/src/components/tables/DriftEventsTable.jsx): `frontend/src/components/tables/DriftEventsTable.jsx`
- [Infrastructure status](https://github.com/siddharthsoumya/driftshield/blob/main/frontend/src/components/cards/InfrastructureStatus.jsx): `frontend/src/components/cards/InfrastructureStatus.jsx`
- [Remediation timeline](https://github.com/siddharthsoumya/driftshield/blob/main/frontend/src/components/timeline/RemediationTimeline.jsx): `frontend/src/components/timeline/RemediationTimeline.jsx`

### Other components

- **System activity**

## Connections

- System activity → Drift API: submits activity (evidence: `README.md`)
- Monitoring scheduler → Detection engine: runs detection (evidence: `backend/backend/src/main/java/com/driftshield/backend/scheduler/DriftMonitoringScheduler.java`)
- Drift API → Detection engine: runs detection (evidence: `backend/backend/src/main/java/com/driftshield/backend/controller/drift/DriftController.java`)
- Detection engine → YAML loader: loads configs (evidence: `backend/backend/src/main/java/com/driftshield/backend/detection/drift/DriftDetectionEngine.java`)
- Detection engine → Config comparator: compares configs (evidence: `backend/backend/src/main/java/com/driftshield/backend/detection/drift/DriftDetectionEngine.java`)
- Detection engine → Event service: saves differences (evidence: `backend/backend/src/main/java/com/driftshield/backend/detection/drift/DriftDetectionEngine.java`)
- Detection engine → Auto-revert service: triggers restore (evidence: `backend/backend/src/main/java/com/driftshield/backend/detection/drift/DriftDetectionEngine.java`)
- Event service → Event repository: saves and reads (evidence: `backend/backend/src/main/java/com/driftshield/backend/service/drift/DriftEventService.java`)
- Event repository → Persistent database: persists events (evidence: `README.md`)
- Auto-revert service → Config restore: restores config (evidence: `backend/backend/src/main/java/com/driftshield/backend/remediation/drift/AutoRevertService.java`)
- Auto-revert service → Event repository: marks reverted (evidence: `backend/backend/src/main/java/com/driftshield/backend/remediation/drift/AutoRevertService.java`)
- Runtime config API → Runtime config service: gets runtime config (evidence: `backend/backend/src/main/java/com/driftshield/backend/controller/runtime/RuntimeConfigController.java`)
- Runtime config service → YAML loader: loads runtime (evidence: `backend/backend/src/main/java/com/driftshield/backend/service/runtime/RuntimeConfigService.java`)
- Alert API → Alert service: handles alerts (evidence: `backend/backend/src/main/java/com/driftshield/backend/controller/alert/AlertController.java`)
- Alert service → Alert repository: stores and lists (evidence: `backend/backend/src/main/java/com/driftshield/backend/service/alert/AlertService.java`)
- Dashboard app → Polling service: starts polling (evidence: `frontend/src/App.jsx`)
- Dashboard app → Drift API client: requests data (evidence: `frontend/src/App.jsx`)
- Drift API client → Drift API: requests drift events (evidence: `README.md`)
- Drift API client → Runtime config API: requests runtime state (evidence: `README.md`)
- Dashboard app → Monitoring views: renders events (evidence: `frontend/src/App.jsx`)
- Dashboard app → Infrastructure status: renders status (evidence: `frontend/src/App.jsx`)
- Dashboard app → Remediation timeline: renders history (evidence: `frontend/src/App.jsx`)
