Skip to content

The cross-harness, self-improving memory layer for AI agents. Join our community: https://discord.com/invite/zdNChS2fBu

docs: rsyslog drops to syslog only on Ubuntu

Claude292bf24cc7a2
diff --git a/docs/log-forwarding/rsyslog.mdx b/docs/log-forwarding/rsyslog.mdx
index 2011df01..8e68fcc9 100644
--- a/docs/log-forwarding/rsyslog.mdx
+++ b/docs/log-forwarding/rsyslog.mdx
@@ -142,25 +142,30 @@ rsyslog:
### With restricted log access
-If the endpoint uses [restricted log access](/security/restricted-log-access), only root and members of the `beacon-log` group can read `runtime.jsonl`. rsyslog reads the log as the account it runs under, so that account has to be able to read it:
+If the endpoint uses [restricted log access](/security/restricted-log-access), only root and members of the `beacon-log` group can read `runtime.jsonl`. rsyslog reads the log as the account it runs under, so that account has to be able to read it. To see which account that is, run:
-- **RHEL, Rocky Linux, AlmaLinux:** rsyslog runs as root. Nothing to change.
-- **Ubuntu, Debian:** rsyslog runs as the `syslog` user (the `$PrivDropToUser syslog` line in `/etc/rsyslog.conf`). Add it to `beacon-log`, then restart rsyslog so it picks up the new group:
+```bash
+ps -o user= -C rsyslogd
+```
+
+- **`root`** (RHEL, Rocky Linux, AlmaLinux, Debian and most other distributions): nothing to change.
+- **`syslog`** (Ubuntu, whose rsyslog package sets `$PrivDropToUser syslog` in `/etc/rsyslog.conf`): add `syslog` to `beacon-log`, then restart rsyslog so it picks up the new group:
```bash
sudo usermod -aG beacon-log syslog
sudo systemctl restart rsyslog
```
-Without this, rsyslog cannot open the log and no Beacon events reach your collector. To check, run:
+Without this, rsyslog on Ubuntu cannot open the log and no Beacon events reach your collector. To check, run:
```bash
sudo -u syslog test -r /var/log/beacon-agent/runtime.jsonl && echo readable
```
-With Salt, add the membership to the same state. The `beacon-log` group exists once Beacon is installed with restricted log access, so apply this state after that:
+With Salt, add the membership to the same state, limited to Ubuntu endpoints that use restricted log access. Other systems have no `syslog` account, so the membership would fail there. The `beacon-log` group exists once Beacon is installed with restricted log access, so apply this state after that:
```yaml title="beacon/rsyslog.sls"
+{% if grains['os'] == 'Ubuntu' and salt['file.file_exists']('/var/log/beacon-agent/.beacon-log-access') %}
rsyslog-reads-beacon-log:
group.present:
- name: beacon-log
@@ -168,8 +173,11 @@ rsyslog-reads-beacon-log:
- syslog
- watch_in:
- service: rsyslog
+{% endif %}
```
+The `.beacon-log-access` file is the marker Beacon writes beside the log when restricted log access is on.
+
## 4. Confirm events arrive
On an endpoint, write a test event:
diff --git a/docs/security/restricted-log-access.mdx b/docs/security/restricted-log-access.mdx
index fba32150..2c1325d3 100644
--- a/docs/security/restricted-log-access.mdx
+++ b/docs/security/restricted-log-access.mdx
@@ -155,7 +155,7 @@ Vector keeps its read position in `/var/lib/vector/beacon-sentinel`, so it resum
### Other shippers
-**rsyslog.** When rsyslog [forwards the log to your collector](/log-forwarding/rsyslog), it reads the file as root on RHEL-family systems, so nothing changes there. On Ubuntu and Debian it runs as the `syslog` user: run `sudo usermod -aG beacon-log syslog` and restart rsyslog. See [With restricted log access](/log-forwarding/rsyslog#with-restricted-log-access).
+**rsyslog.** When rsyslog [forwards the log to your collector](/log-forwarding/rsyslog), it reads the file as root on RHEL, Debian and most other distributions, so nothing changes there. On Ubuntu it runs as the `syslog` user: run `sudo usermod -aG beacon-log syslog` and restart rsyslog. See [With restricted log access](/log-forwarding/rsyslog#with-restricted-log-access).
The same rule applies to Splunk Universal Forwarder, Filebeat or Elastic Agent, the Datadog Agent, Wazuh, Rapid7, Sumo Logic and any customer-managed shipper reading the [local JSONL log](/log-forwarding/local-jsonl): running as root, nothing changes; running as its own account, add that account to `beacon-log` and restart it. Splunk HEC and Falcon LogScale HEC are sent by the collector itself and are not affected.