rConfig - SNMP Trap Handler Supervisor Management

3 mins V8 Pro

The SNMP Trap Handler allows rConfig to receive and process SNMP traps from your network devices. This guide covers how to manage the SNMP Trap Handler service using Supervisor for reliable, production deployment.

Tip

Recommended Testing Approach: Before setting up the service with Supervisor, we recommend first testing the SNMP trap handler manually to ensure it works correctly in your environment.

Prerequisites

Ensure Supervisor is installed and running on your system. If rConfig was installed correctly, Supervisor should already be set up. If not contact support.

Initial Testing (Recommended)

Before deploying with Supervisor, test the SNMP trap handler manually:

# Test with default settings
php artisan rconfig:snmp-trap-handler --host=0.0.0.0 --port=162 --daemon

# Test with custom settings
php artisan rconfig:snmp-trap-handler --host=192.168.1.100 --port=1162 --daemon

Caution

Port 162 Requirements: The standard SNMP trap port (162) requires root privileges on most systems. Consider using a higher port (e.g., 1162) for testing, or ensure you run the command with appropriate permissions.

Managing the Service

Interactive Setup (Recommended for First-Time Users)

Launch the interactive management interface:

php artisan rconfig:snmp-trap-supervisor

This will present you with a menu to:

• 📦 Install service (add to supervisor)
• 🗑️ Uninstall service (remove from supervisor)
• 📊 Check service status
• 🔄 Restart service
• ❌ Exit

Basic Configuration

When installing, you’ll be prompted for basic settings:

• Host: IP address to bind to (default: 0.0.0.0)
• Port: SNMP trap port (default: 162)
• Community: SNMP community string (default: public)

Advanced Configuration

Select “Configure advanced settings?” to access additional options:

• Timeout: SNMP timeout in seconds
• Memory Limit: Memory limit in MB
• Base Path: Application installation path
• Supervisor Config Directory: Where to place the config file

Caution

Advanced Options: Advanced configuration options should only be modified if you know what you’re doing or are working with rConfig support. Incorrect settings may prevent the service from starting properly.

Command Line Usage

Quick Installation

# Install with defaults
php artisan rconfig:snmp-trap-supervisor install --force

# Install with custom settings
php artisan rconfig:snmp-trap-supervisor install \
  --host=192.168.1.100 \
  --port=1162 \
  --community=private

Service Management

# Check service status
php artisan rconfig:snmp-trap-supervisor status

# Restart the service
php artisan rconfig:snmp-trap-supervisor restart

# Uninstall the service
php artisan rconfig:snmp-trap-supervisor uninstall

Monitoring and Troubleshooting

Checking Service Status

# Via rConfig command
php artisan rconfig:snmp-trap-supervisor status

# Direct supervisor commands
supervisorctl status rconfig-snmp-trap
supervisorctl status  # View all services

Viewing Logs

# Follow logs in real-time (recommended for troubleshooting)
supervisorctl tail -f rconfig-snmp-trap

# View recent log entries
supervisorctl tail rconfig-snmp-trap

# View error logs
supervisorctl tail rconfig-snmp-trap stderr

Service Control

# Start the service
supervisorctl start rconfig-snmp-trap

# Stop the service
supervisorctl stop rconfig-snmp-trap

# Restart the service
supervisorctl restart rconfig-snmp-trap

# Reload supervisor configuration
supervisorctl reread
supervisorctl update

Tip

Manual Testing: If you need to run the SNMP trap handler manually for debugging, always stop the Supervisor service first to avoid port conflicts:

supervisorctl stop rconfig-snmp-trap
php artisan rconfig:snmp-trap-handler --host=0.0.0.0 --port=162 --daemon

Advanced Troubleshooting

For detailed debugging, run the command manually with verbose output:

# Stop the supervisor service first
supervisorctl stop rconfig-snmp-trap

# Run manually for detailed output
php artisan rconfig:snmp-trap-handler --host=0.0.0.0 --port=162 --daemon

Log File Locations

The service logs are automatically stored in:

• Standard Output: storage/logs/snmp-trap-handler.log
• Error Output: storage/logs/snmp-trap-handler-error.log

Testing SNMP Trap Reception

Once the service is running, test it by sending a test trap:

# Send a test SNMP v2c trap
snmptrap -v2c -c public 127.0.0.1:162 "" 1.3.6.1.4.1.9.9.43.2.0.1 \
  1.3.6.1.4.1.9.9.43.1.1.1.0 s "Configuration changed by admin"

Monitor the logs to verify the trap is received and processed correctly.

Caution

Production Deployment: Always test thoroughly in a development environment before deploying to production. Ensure your firewall allows traffic on the configured SNMP trap port.

Common Issues

Service Won’t Start

• Verify the base path exists and contains the Laravel application
• Check that the specified port is not already in use
• Ensure proper permissions for the user running the service

Permission Denied on Port 162

• Use a higher port number (e.g., 1162) or run as root
• Configure your network devices to send traps to the alternative port

Service Stops Unexpectedly

• Check error logs: supervisorctl tail rconfig-snmp-trap stderr
• Verify memory limits are appropriate for your environment
• Review application logs for PHP errors

For complex issues or advanced configuration needs, please contact rConfig support.