https://github.com/qxip/quick-snmp
Quick SNMP Helper
https://github.com/qxip/quick-snmp
Last synced: 4 months ago
JSON representation
Quick SNMP Helper
- Host: GitHub
- URL: https://github.com/qxip/quick-snmp
- Owner: QXIP
- License: apache-2.0
- Created: 2025-04-28T16:57:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-28T19:09:32.000Z (about 1 year ago)
- Last Synced: 2025-10-18T02:14:00.874Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 41 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QXIP SNMP Trap Sender
A flexible SNMP trap sender system that allows monitoring system metrics and sending SNMP traps based on configurable rules.
## Features
- Configurable OID root for all traps
- Multiple SNMP trap receivers support
- Flexible rule system for monitoring system metrics
- Support for both string and integer values
- Threshold-based monitoring with warning and critical levels
- Automatic OID file generation for SNMP receivers
- YAML-based configuration
## Installation
Download a [precompiled binary release](https://github.com/QXIP/quick-snmp/releases) or build locally:
```bash
git clone https://github.com/your-org/qxip-snmp.git
cd qxip-snmp
bun install
```
## Configuration
The system is configured using a YAML file. See `config.yaml` for a complete example.
### Configuration Structure
```yaml
# Root OID for all traps
oidRoot: "1.3.6.1.4.1.12345"
# SNMP trap receivers
receivers:
- id: "receiver1"
host: "192.168.1.100"
port: 162
community: "public"
# Monitoring rules
rules:
- id: "rule1"
oid: "1.1"
name: "Rule Name"
type: "integer" # or "string"
command: "your-command"
interval: 60
thresholds:
warning: 70
critical: 90
receivers: ["receiver1"]
```
## Usage
1. Start the SNMP trap sender:
```bash
bun src/index.js
```
2. Generate OID file for SNMP receivers:
```bash
bun src/index.js --generate-oid
```
## Rule Configuration
Each rule in the configuration defines:
- `id`: Unique identifier for the rule
- `oid`: OID suffix to append to root OID
- `name`: Human-readable name for the OID
- `type`: Type of value to return ("string" or "integer")
- `command`: System command to execute
- `interval`: Check interval in seconds
- `thresholds`: Optional thresholds for integer values
- `warning`: Warning threshold value
- `critical`: Critical threshold value
- `receivers`: List of receiver IDs to send traps to
## OID File Generation
The system can generate an SNMP MIB file that can be loaded on SNMP receivers. The generated file includes:
- Module identity
- Trap definitions
- Object type definitions
- Severity level objects (for rules with thresholds)
## License
MIT