Pulse/docs/operations/SENSOR_PROXY_LOGS.md
courtmanr@gmail.com fd39196166 refactor: finalize documentation overhaul
- Refactor specialized docs for conciseness and clarity
- Rename files to UPPER_CASE.md convention
- Verify accuracy against codebase
- Fix broken links
2025-11-25 00:45:20 +00:00

31 lines
1.1 KiB
Markdown

# 📝 Sensor Proxy Log Forwarding
Forward `audit.log` and `proxy.log` to a central SIEM via RELP + TLS.
## 🚀 Quick Start
Run the helper script with your collector details:
```bash
sudo REMOTE_HOST=logs.example.com \
REMOTE_PORT=6514 \
CERT_DIR=/etc/pulse/log-forwarding \
CA_CERT=/path/to/ca.crt \
CLIENT_CERT=/path/to/client.crt \
CLIENT_KEY=/path/to/client.key \
/opt/pulse/scripts/setup-log-forwarding.sh
```
## 📋 What It Does
1. **Inputs**: Watches `/var/log/pulse/sensor-proxy/{audit,proxy}.log`.
2. **Queue**: Disk-backed queue (50k messages) for reliability.
3. **Output**: RELP over TLS to `REMOTE_HOST`.
4. **Mirror**: Local debug file at `/var/log/pulse/sensor-proxy/forwarding.log`.
## ✅ Verification
1. **Check Status**: `sudo systemctl status rsyslog`
2. **View Mirror**: `tail -f /var/log/pulse/sensor-proxy/forwarding.log`
3. **Test**: Restart proxy and check remote collector for `pulse.audit` tag.
## 🧹 Maintenance
* **Disable**: Remove `/etc/rsyslog.d/pulse-sensor-proxy.conf` and restart rsyslog.
* **Rotate Certs**: Replace files in `CERT_DIR` and restart rsyslog.