aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README29
1 files changed, 29 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..2889e1a
--- /dev/null
+++ b/README
@@ -0,0 +1,29 @@
+runit-otel
+==========
+
+A /etc/vlogger replacement or enhancer to send logs to an opentelemetry collector.
+
+Usage
+-----
+
+Copy the binary to `/etc/vlogger` if all stdout logs should be sent to
+opentelemetry, or add a file such as this one to both send logs to
+opentelemetry and process the logs as normal.
+
+
+```sh
+#!/usr/bin/env sh
+
+level="${2:-"level"}"
+facility="${3:-"user"}"
+tag="${1:-"${facility}"}"
+
+exec runit-otel "$tag" "$level" "$facility" | logger --tag "$tag" --priority "$facility"."$level"
+```
+
+TODO
+----
+
+- [ ] GRPC
+- [ ] Configure by environment variables
+- [ ] Syslog (through `socklog unix /dev/log`)