Skip to content

Commit c9c0cae

Browse files
tosumitdhakatosumitdhaka
authored
Revise README with architecture and use cases
Updated architecture diagram and added use cases for NMS development, MIB management, integration testing, and learning. Removed 'Best For' and 'Not For' sections.
1 parent 73e37d6 commit c9c0cae

1 file changed

Lines changed: 140 additions & 37 deletions

File tree

‎README.md‎

Lines changed: 140 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -87,23 +87,99 @@ BACKEND_PORT=9000 FRONTEND_PORT=3000 ./install-trishul-snmp.sh up
8787
## 🏗️ Architecture
8888

8989
```
90-
┌─────────────────────────────────────────┐
91-
│ Web Browser (Port 8080) │
92-
└────────────────┬────────────────────────┘
93-
│
94-
┌────────────┴────────────┐
95-
│ │
96-
┌───▼────┐ ┌─────▼──────┐
97-
│ Nginx │◄────────────►│ FastAPI │
98-
│ :8080 │ API │ :8000 │
99-
└────────┘ └─────┬──────┘
100-
│
101-
┌─────────┴─────────┐
102-
│ │
103-
┌─────▼─────┐ ┌──────▼──────┐
104-
│ Simulator │ │ Receiver │
105-
│ UDP: 1061 │ │ UDP: 1162 │
106-
└───────────┘ └─────────────┘
90+
┌─────────────────────────────────────────────────────────────────────┐
91+
│ Web Browser (Port 8080) │
92+
│ │
93+
│ ┌──────────┐ ┌──────────┐ ┌───────┐ ┌──────┐ ┌────────┐ ┌─────┐ │
94+
│ │Dashboard │ │Simulator │ │Walker │ │Traps │ │Browser │ │MIBs │ │
95+
│ └──────────┘ └──────────┘ └───────┘ └──────┘ └────────┘ └─────┘ │
96+
└────────────────────────────┬────────────────────────────────────────┘
97+
│ HTTP
98+
│
99+
┌──────────────▼──────────────┐
100+
│ Nginx (Frontend) │
101+
│ • Serves static files │
102+
│ • Reverse proxy to API │
103+
└──────────────┬──────────────┘
104+
│ REST API
105+
│
106+
┌────────────────────────────▼────────────────────────────────────────┐
107+
│ FastAPI Backend (Port 8000) │
108+
│ │
109+
│ ┌───────────────────────────────────────────────────────────────┐ │
110+
│ │ API Endpoints │ │
111+
│ │ /api/simulator/* /api/walker/* /api/traps/* │ │
112+
│ │ /api/mibs/* /api/browser/* /api/settings/* │ │
113+
│ └───────────────────────────────────────────────────────────────┘ │
114+
│ │
115+
│ ┌───────────────────────────────────────────────────────────────┐ │
116+
│ │ Service Layer │ │
117+
│ │ │ │
118+
│ │ ┌─────────────────────────────────────────────────────────┐ │ │
119+
│ │ │ MIB Service (pysmi/pysnmp) │ │ │
120+
│ │ │ • Parse & validate MIB files │ │ │
121+
│ │ │ • Check syntax & dependencies │ │ │
122+
│ │ │ • Build OID tree (module/hierarchy views) │ │ │
123+
│ │ │ • Resolve OID names ↔ numeric OIDs │ │ │
124+
│ │ │ • Enumerate traps (24: 19 loaded + 5 system) │ │ │
125+
│ │ │ • Search & filter (name, OID, type, module) │ │ │
126+
│ │ └─────────────────────────────────────────────────────────┘ │ │
127+
│ │ │ │
128+
│ │ ┌─────────────────────────────────────────────────────────┐ │ │
129+
│ │ │ SNMP Service (pysnmp) │ │ │
130+
│ │ │ • Simulator: Test SNMP agent responses │ │ │
131+
│ │ │ • Walker: Test SNMP client queries │ │ │
132+
│ │ │ • Trap Sender: Send test traps (client) │ │ │
133+
│ │ │ • Trap Receiver: Receive test traps (server) │ │ │
134+
│ │ └─────────────────────────────────────────────────────────┘ │ │
135+
│ │ │ │
136+
│ │ ┌─────────────────────────────────────────────────────────┐ │ │
137+
│ │ │ Auth Service │ │ │
138+
│ │ │ • Session management (token-based) │ │ │
139+
│ │ │ • User authentication │ │ │
140+
│ │ └─────────────────────────────────────────────────────────┘ │ │
141+
│ └───────────────────────────────────────────────────────────────┘ │
142+
│ │
143+
│ ┌───────────────────────────────────────────────────────────────┐ │
144+
│ │ SNMP Network Layer │ │
145+
│ │ │ │
146+
│ │ ┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐ │ │
147+
│ │ │Simulator │ │ Sender │ │ Receiver │ │ Walker │ │ │
148+
│ │ │ (SVR) │ │ (CLI) │ │ (SVR) │ │ (CLI) │ │ │
149+
│ │ │UDP: 1061 │ │ Dynamic │ │UDP: 1162 │ │ Dynamic │ │ │
150+
│ │ │ │ │ │ │ │ │ │ │ │
151+
│ │ │Test SNMP │ │Send test │ │Receive │ │Test SNMP │ │ │
152+
│ │ │agent │ │traps to │ │test traps│ │queries │ │ │
153+
│ │ │responses │ │dev/test │ │from dev/ │ │to dev/ │ │ │
154+
│ │ │ │ │targets │ │test env │ │test env │ │ │
155+
│ │ └────┬─────┘ └────┬─────┘ └────┬─────┘ └────┬─────┘ │ │
156+
│ │ │ │ │ │ │ │
157+
│ └───────┼─────────────┼─────────────┼─────────────┼─────────────┘ │
158+
│ │ │ │ │ │
159+
│ ┌───────▼─────────────▼─────────────▼─────────────▼─────────────┐ │
160+
│ │ Data Storage (Docker Volume) │ │
161+
│ │ /app/data/ │ │
162+
│ │ ├── mibs/ (MIB files for validation) │ │
163+
│ │ ├── sessions.json (Auth tokens) │ │
164+
│ │ └── settings.json (User config) │ │
165+
│ └───────────────────────────────────────────────────────────────┘ │
166+
│ │
167+
└───────────────────────────┬─────────────────────────────────────────┘
168+
│ SNMP Protocol (UDP)
169+
│ Host Network Mode
170+
│
171+
┌──────────────┴──────────────┐
172+
│ │
173+
┌───────▼────────┐ ┌────────▼────────┐
174+
│ Test SNMP │ │ Test Trap │
175+
│ Clients/Agents │ │ Receivers │
176+
│ (Dev/Test Env) │ │ (Dev/Test Env) │
177+
│ │ │ │
178+
│ • Your NMS │ │ • Your NMS │
179+
│ • Custom apps │ │ • Trap parsers │
180+
│ • Test devices │ │ • Log servers │
181+
│ • Simulators │ │ • Test apps │
182+
└────────────────┘ └─────────────────┘
107183
```
108184

109185
**Stack:** Python 3.11 • FastAPI • pysnmp • pysmi • Nginx • Docker
@@ -141,7 +217,6 @@ Interactive tree explorer for navigating OID hierarchies and understanding MIB s
141217
- **Tree navigation** - Expandable hierarchy with configurable depth (1-5 levels)
142218
- **Details panel** - View full metadata, descriptions, and varbinds
143219
- **Integration** - Jump to Walker or Trap Sender with pre-filled data
144-
- **State persistence** - Remembers your position across page switches
145220

146221
### 📚 **MIB Manager**
147222
Upload, validate, and manage MIB files with automatic dependency resolution.
@@ -159,6 +234,53 @@ Manage authentication and system preferences.
159234

160235
---
161236

237+
## 🎯 Use Cases
238+
239+
### **For NMS Development**
240+
- ✅ Send test traps to validate receiver format/syntax
241+
- ✅ Receive test traps to validate sender implementation
242+
- ✅ Simulate SNMP agents for client testing
243+
- ✅ Test SNMP walk responses
244+
245+
### **For MIB Management**
246+
- ✅ Validate MIB syntax and dependencies
247+
- ✅ Explore MIB structures interactively
248+
- ✅ Search OIDs across multiple MIBs
249+
- ✅ Resolve OID names ↔ numeric OIDs
250+
251+
### **For Integration Testing**
252+
- ✅ Test SNMP integrations without production devices
253+
- ✅ Validate trap handling in dev environments
254+
- ✅ Simulate device responses for QA
255+
- ✅ Export walk data for automated testing
256+
257+
### **For Learning & Training**
258+
- ✅ Understand SNMP protocol behavior
259+
- ✅ Explore standard MIB structures
260+
- ✅ Practice SNMP operations safely
261+
- ✅ Learn OID hierarchies visually
262+
263+
---
264+
265+
## 👥 Best For
266+
267+
- 🔧 **Network engineers** testing devices and exploring MIB structures
268+
- 🚀 **DevOps teams** testing SNMP integrations
269+
- 📚 **Students** learning SNMP protocols and MIB hierarchies
270+
- ✅ **QA teams** validating SNMP implementations
271+
- 👥 **Small teams** needing trap monitoring and MIB browsing
272+
- 🧪 **Developers** building SNMP-enabled applications
273+
274+
---
275+
276+
## ⚠️ Not For
277+
278+
- ❌ Production 24/7 monitoring (use Zabbix, PRTG, LibreNMS)
279+
- ❌ Enterprise-scale NMS (use SolarWinds, Cisco Prime)
280+
- ❌ High-availability monitoring (use dedicated monitoring platforms)
281+
282+
---
283+
162284
## 🔧 Configuration
163285

164286
### Environment Variables
@@ -222,25 +344,6 @@ docker-compose build
222344

223345
---
224346

225-
## 👥 Best For
226-
227-
- 🔧 **Network engineers** testing devices and exploring MIB structures
228-
- 🚀 **DevOps teams** testing SNMP integrations
229-
- 📚 **Students** learning SNMP protocols and MIB hierarchies
230-
- ✅ **QA teams** validating SNMP implementations
231-
- 👥 **Small teams** needing trap monitoring and MIB browsing
232-
- 🧪 **Developers** building SNMP-enabled applications
233-
234-
---
235-
236-
## ⚠️ Not For
237-
238-
- ❌ Production 24/7 monitoring (use Zabbix, PRTG, LibreNMS)
239-
- ❌ Enterprise-scale NMS (use SolarWinds, Cisco Prime)
240-
- ❌ High-availability monitoring (use dedicated monitoring platforms)
241-
242-
---
243-
244347
## 💖 Support This Project
245348

246349
Trishul-SNMP is **100% free and open-source**. If it helps you, consider:

0 commit comments

Comments
 (0)