socklog-conf(8)

📦
version 2.1.2 · 4 versions
, in ubuntu resolute, ubuntu stonking

✨ socklog-conf(8) ✨

okay bestie, gather round, because this is the socklog-conf page from the System Manager's Manual and she is literally the setup queen 💅

🎀 NAME 🎀

socklog-conf — sets up a socklog(8) service.

no cap, that's the whole job. she sets things up. she makes directories. she gives you a whole supervised log vibe. iconic.

🌸 SYNOPSIS 🌸

socklog-conf unix|inet|klog|ucspi-tcp acct logacct
socklog-conf notify acct grp

that's it. two shapes. pick your fighter ✨

💖 DESCRIPTION 💖

so here's the tea 🍓 — socklog-conf creates /etc/sv if it isn't already there (she's prepared like that), plus a subdirectory that runs the unix, inet, ucspi-tcp or notify service (peep below for each one, i gotchu).

with one exception — the notify service — socklog-conf also makes a log directory with subdirectories inside it. so most of these services get the full log-dir treatment, and notify is just out here living her own life 💀

⚠️ real talk: acct, logacct and grp must not contain any special characters. keep them clean, bestie.

🐚 UNIX SERVICE 🐚

socklog-conf unix acct logacct

run her with unix as the 1st argument and she creates the service directory /etc/sv/socklog-unix and the log directory /var/log/socklog 🎀

then she arranges for socklog(8) to run under the uid and gid of acct, and to listen for syslog messages on /dev/log. yes, the classic spot. the local plug. 🔌

she also creates automatically rotated log directories in /var/log/socklog. those logs are owned by logacct, and the corresponding svlogd(8) process runs under the uid and gid of logacct. everyone's got their own identity, as they should 💅

want her in system-wide service supervision? say less, use the update-service(8) program:

update-service --add /etc/sv/socklog-unix

periodt.

🌈 INET SERVICE 🌈

socklog-conf inet acct logacct

1st argument inet? she creates the service directory /etc/sv/socklog-inet and the log directory /var/log/socklog-inet ✨

socklog(8) runs under the uid and gid of acct, and listens for syslog messages on the UDP socket 0.0.0.0:514. network girlie behavior, we love to see it 🦋

automatically rotated log directories get made in /var/log/socklog-inet, the logs are owned by logacct, and the matching svlogd(8) process runs under the uid and gid of logacct.

to add her to system-wide service supervision:

update-service --add /etc/sv/socklog-inet

slay.

👑 KLOG SERVICE 👑

socklog-conf klog acct logacct

1st argument klog and boom — service directory /etc/sv/socklog-klog plus log directory /var/log/socklog-klog 🌸

this one's the kernel gossip channel, fr fr. socklog(8) runs under the uid and gid of acct and reads kernel messages from /proc/kmsg on Linux, or /dev/socklog-klog on BSD. two paths, one vibe, depending on your OS 💜

automatically rotated log directories land in /var/log/socklog-klog, logs owned by logacct, and the corresponding svlogd(8) process runs under the uid and gid of logacct.

system-wide service supervision time:

update-service --add /etc/sv/socklog-klog

no notes. perfect. 💅

🦋 UCSPI-TCP SERVICE 🦋

socklog-conf ucspi-tcp acct logacct

1st argument ucspi-tcp — service directory /etc/sv/socklog-ucspi-tcp and log directory /var/log/socklog-ucspi-tcp ✨

this one is a lil extra (affectionate): she arranges for tcpsvd(1) to run socklog(8) under the uid and gid of acct, and to listen on the TCP socket 0.0.0.0:10116. TCP! port 10116! main character energy 🔥

automatically rotated log directories in /var/log/socklog-ucspi-tcp, logs owned by logacct, and the corresponding svlogd(8) process runs under the uid and gid of logacct.

add her to system-wide service supervision with:

update-service --add /etc/sv/socklog-ucspi-tcp

obsessed.

💌 NOTIFY SERVICE 💌

socklog-conf notify acct grp

1st argument notify and she creates the service directory /etc/sv/socklog-notify. note: no log directory for this one, remember? told you she was different 🫶

she arranges for uncat(1) to run under the uid and gid of acct, and to listen on the named pipe /var/log/socklog/.notify. that named pipe gets mode 0620, the uid of acct, and the gid of grp 🔐

⚠️ important one, bestie: all uids running a log service that is configured to push log events to the socklog-notify service must be members of the group grp. no group membership, no notify. that's the rule.

system-wide service supervision:

update-service --add /etc/sv/socklog-notify

chef's kiss 😭✨

🔍 SEE ALSO 🔍

and the links, because i would never gatekeep:

🖊️ AUTHOR 🖊️

Gerrit Pape <pape@smarden.org>

and that's the whole page, bestie 🧚💜 this was the socklog-conf(8) manual page, straight out of the System Manager's Manual — go forth and supervise your services with your whole chest. bye babe, ilysm 💖✨🎀

📦 where this page comes from