Skip to content

Commit 4e1b3b7

Browse files
Update README.md
1 parent 87adf27 commit 4e1b3b7

1 file changed

Lines changed: 159 additions & 76 deletions

File tree

README.md

Lines changed: 159 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,139 @@
1-
# SentraCore
1+
<div align="center">
22

3-
[![RepoRanker](https://reporanker.com/badge/AsieduDevelopmentHub/SentraCore)](https://reporanker.com/repos/AsieduDevelopmentHub/SentraCore)
3+
# SentraCore
44

5-
SentraCore is a local system behavior intelligence platform for Windows that continuously analyzes system telemetry to understand performance behavior, detect anomalies, explain system slowdowns, and estimate future resource pressure before it impacts usability.
5+
### System Behavior Intelligence Platform
66

7-
Unlike traditional monitoring tools that focus on raw snapshots, SentraCore interprets system behavior over time — helping users understand what is happening, why it is happening, and how it may affect overall system responsiveness.
7+
SentraCore is a local **system behavior intelligence platform** designed to continuously analyze telemetry, understand performance behavior, detect anomalies, explain slowdowns, and estimate future system pressure before it impacts responsiveness.
8+
9+
Rather than focusing on isolated resource snapshots, SentraCore interprets system activity over time to answer three critical questions:
10+
11+
**What is happening?**
12+
**Why is it happening?**
13+
**What is likely to happen next?**
14+
15+
Built for intelligent desktop observability and explainable operational insight.
16+
17+
</div>
818

919
---
1020

11-
## Current Status
21+
## Overview
22+
23+
SentraCore combines telemetry collection, behavioral modeling, anomaly detection, predictive analytics, and explainable diagnostics into a unified local intelligence system.
24+
25+
The platform continuously learns machine-specific operating patterns and transforms raw system measurements into actionable insights.
26+
27+
---
28+
29+
## Current Capabilities
1230

1331
SentraCore currently includes:
1432

1533
- Real-time telemetry monitoring
16-
- Behavioral baseline learning
34+
- Adaptive behavioral baseline learning
1735
- Statistical anomaly detection
1836
- Root cause analysis
1937
- Predictive risk estimation
20-
- Historical monitoring (Logbook)
38+
- Historical monitoring and logbook tracking
2139
- Flutter desktop dashboard
22-
- Windows installer and packaging system
40+
- Desktop packaging and installer workflow
2341

2442
---
2543

2644
## Core Features
2745

2846
### System Stability Index
29-
Unified system health scoring based on:
30-
- resource pressure
31-
- anomaly deviation
32-
- sustained stress trends
33-
- predictive degradation risk
47+
48+
Unified system health scoring generated from:
49+
50+
- Resource pressure
51+
- Behavioral deviation
52+
- Sustained stress trends
53+
- Predictive degradation indicators
3454

3555
---
3656

3757
### Behavioral Intelligence
38-
Learns normal system behavior per machine, including:
39-
- CPU usage patterns
40-
- memory behavior
41-
- disk activity trends
42-
- time-of-day workload patterns
58+
59+
Learns normal operating behavior per machine, including:
60+
61+
- CPU utilization patterns
62+
- Memory behavior
63+
- Disk activity trends
64+
- Time-based workload characteristics
65+
66+
The objective is to detect meaningful deviation rather than isolated spikes.
4367

4468
---
4569

4670
### Root Cause Analysis
47-
Analyzes:
48-
- process activity
49-
- resource contention
50-
- event timing
51-
- system degradation patterns
5271

53-
Provides ranked likely contributors instead of raw metrics alone.
72+
Correlates multiple signals to identify likely contributors to degradation.
73+
74+
Analysis includes:
75+
76+
- Process activity
77+
- Resource contention
78+
- Event timing
79+
- Performance degradation patterns
80+
81+
Outputs ranked probable causes instead of raw metric streams.
5482

5583
---
5684

5785
### Predictive Forecasting
58-
Estimates future resource exhaustion using trend analysis:
59-
- memory saturation forecasting
86+
87+
Forecasts future pressure using historical and trend-based analysis.
88+
89+
Includes:
90+
91+
- Memory saturation estimation
6092
- CPU trend projection
61-
- disk pressure estimation
62-
- ETA-style degradation warnings
93+
- Disk pressure forecasting
94+
- Estimated degradation warnings
6395

6496
---
6597

6698
### Historical Monitoring
67-
Automatically records and visualizes:
99+
100+
Continuously records and visualizes:
101+
68102
- CPU pressure
69-
- memory pressure
70-
- disk pressure
71-
- long-term behavior trends
103+
- Memory pressure
104+
- Disk pressure
105+
- Long-term behavioral trends
106+
- Historical intelligence events
72107

73108
---
74109

75110
### Alerts & Diagnostics
111+
76112
Includes:
77-
- live alerts
78-
- alert history
79-
- diagnostics timeline
113+
114+
- Live alerts
115+
- Alert history
116+
- Diagnostics timeline
80117
- Windows notifications
81-
- root cause summaries
118+
- Root cause summaries
82119

83120
---
84121

85122
## Architecture
86123

87124
```text
88125
Flutter Dashboard
89-
↕ WebSocket / REST API
126+
127+
WebSocket / REST API
128+
90129
Python Intelligence Engine
91-
├── Telemetry Collection
92-
├── Baseline Learning
93-
├── Anomaly Detection
94-
├── Correlation Engine
95-
├── Prediction Engine
96-
└── Alert System
130+
131+
├── Telemetry Collection
132+
├── Baseline Learning
133+
├── Anomaly Detection
134+
├── Correlation Engine
135+
├── Prediction Engine
136+
└── Alert System
97137
```
98138

99139
---
@@ -102,78 +142,121 @@ Python Intelligence Engine
102142

103143
| Layer | Technology |
104144
|---|---|
105-
| Engine | Python 3.11, psutil |
106-
| API | FastAPI, WebSockets |
145+
| Engine | Python 3.11 · psutil |
146+
| API | FastAPI · WebSockets |
107147
| Dashboard | Flutter Desktop |
108-
| Packaging | PyInstaller, Inno Setup |
109-
| CI/CD | GitHub Actions |
148+
| Packaging | PyInstaller · Inno Setup |
149+
| Automation | GitHub Actions |
110150

111151
---
112152

113153
## Getting Started
114154

115-
### Development
155+
### Development Environment
116156

117-
See the setup documentation below for full instructions.
157+
See project documentation for full setup instructions.
158+
159+
Start the engine:
118160

119161
```powershell
120-
# Start engine
121162
.venv\Scripts\python -m engine.main
163+
```
122164

123-
# Run dashboard
165+
Launch dashboard:
166+
167+
```powershell
124168
cd dashboard
169+
125170
flutter run -d windows
126171
```
127172

128173
---
129174

130-
### Installer
175+
## Installer
131176

132-
Download the latest installer from the [GitHub Releases](https://github.com/AsieduDevelopmentHub/SentraCore/releases) page.
177+
Download the latest desktop release from:
133178

134-
The installer:
135-
- installs SentraCore
136-
- creates shortcuts
137-
- configures optional startup launch
138-
- sets up the monitoring engine automatically
179+
```text
180+
GitHub Releases
181+
```
182+
183+
Installer capabilities:
184+
185+
- Installs SentraCore
186+
- Creates application shortcuts
187+
- Configures optional startup behavior
188+
- Deploys the monitoring engine
189+
- Prepares runtime dependencies
139190

140191
---
141192

142193
## Documentation
143194

144195
| Document | Description |
145196
|---|---|
146-
| [Development Setup](docs/setup/development_setup.md) | Full local development setup |
147-
| [Engine Setup](docs/setup/engine_setup.md) | Engine configuration and setup |
148-
| [Dashboard Setup](docs/setup/dashboard_setup.md) | Flutter dashboard setup |
149-
| [Intelligence Pipeline](docs/architecture/intelligence_layer.md) | Internal intelligence architecture |
150-
| [Building SentraCore](docs/architecture/building.md) | Packaging and installer process |
197+
| `docs/setup/development_setup.md` | Development environment setup |
198+
| `docs/setup/engine_setup.md` | Engine installation and configuration |
199+
| `docs/setup/dashboard_setup.md` | Dashboard build and execution |
200+
| `docs/architecture/intelligence_layer.md` | Intelligence pipeline internals |
201+
| `docs/architecture/building.md` | Packaging and release workflow |
151202

152203
---
153204

154-
## Philosophy
205+
## Design Principles
155206

156-
SentraCore is built around six principles:
207+
SentraCore is built around six guiding principles:
157208

158209
1. Observation
159-
2. Behavioral modeling
160-
3. Anomaly detection
161-
4. Correlation analysis
162-
5. Predictive awareness
163-
6. Forecasting
210+
2. Behavioral Modeling
211+
3. Pattern Recognition
212+
4. Correlation Analysis
213+
5. Predictive Awareness
214+
6. Explainable Intelligence
164215

165216
---
166217

167-
## Prerequisites (quick glance)
218+
## Requirements
168219

169-
| Requirement | Notes |
220+
| Requirement | Version |
170221
|---|---|
171-
| Python | 3.11+ (see `requirements.txt` / `pyproject.toml`) |
172-
| Flutter | Stable channel, 3.x+ for the desktop dashboard |
173-
| OS | Windows is the primary packaging target; Linux and macOS are supported for development |
222+
| Python | 3.11+ |
223+
| Flutter | Stable 3.x+ |
224+
| Platform | Windows (Primary) |
225+
226+
Linux and macOS currently support development workflows but Windows remains the primary runtime and packaging target.
227+
228+
---
229+
230+
## Repository Structure
231+
232+
```text
233+
engine/
234+
dashboard/
235+
docs/
236+
installer/
237+
pages/
238+
assets/
239+
tests/
240+
```
174241

175242
---
176243

177244
## License
178245

179-
Apache License 2.0
246+
Licensed under the Apache License 2.0.
247+
248+
See:
249+
250+
[LICENSE](./LICENSE)
251+
252+
---
253+
254+
<div align="center">
255+
256+
### SentraCore
257+
258+
Observe • Understand • Predict
259+
260+
Intelligence Beyond Monitoring
261+
262+
</div>

0 commit comments

Comments
 (0)