From 1aec43b1acf8e7669bd43f50195c0b6e8e6b6c35 Mon Sep 17 00:00:00 2001 From: rcourtman Date: Fri, 14 Nov 2025 01:01:55 +0000 Subject: [PATCH] docs: escape table pipes in sensor proxy readme --- cmd/pulse-sensor-proxy/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/cmd/pulse-sensor-proxy/README.md b/cmd/pulse-sensor-proxy/README.md index a3d0c12..c174a38 100644 --- a/cmd/pulse-sensor-proxy/README.md +++ b/cmd/pulse-sensor-proxy/README.md @@ -9,7 +9,7 @@ capabilities, and produces append-only audit logs. | Scenario | Command | | --- | --- | -| **Recommended (automated)** | `curl -fsSL https://raw.githubusercontent.com/rcourtman/Pulse/main/scripts/install-sensor-proxy.sh \`
` | bash` | +| **Recommended (automated)** | `curl -fsSL https://raw.githubusercontent.com/rcourtman/Pulse/main/scripts/install-sensor-proxy.sh \| bash` | | **Manual build** | `go build ./cmd/pulse-sensor-proxy` and `sudo install -m 0755 pulse-sensor-proxy /usr/local/bin/` | | **Prebuilt artifact** | Copy the binary from `/opt/pulse/bin/pulse-sensor-proxy-*` inside the Pulse Docker image or download via `/download/pulse-sensor-proxy?platform=linux&arch=amd64`. | @@ -88,10 +88,10 @@ truncate, restart service, reapply `+a`). Also consider forwarding with | Signal | Command | | --- | --- | -| Prometheus metrics | `curl -s http://127.0.0.1:9127/metrics | head` | -| Scheduler health (Pulse) | `curl -s http://localhost:7655/api/monitoring/scheduler/health \`
` | jq '.instances[] | select(.key | contains("temperature")) | {key, breaker: .breaker.state, deadLetter: .deadLetter.present}'` | +| Prometheus metrics | `curl -s http://127.0.0.1:9127/metrics \| head` | +| Scheduler health (Pulse) | `curl -s http://localhost:7655/api/monitoring/scheduler/health \| jq '.instances[] \| select(.key \| contains(\"temperature\")) \| {key, breaker: .breaker.state, deadLetter: .deadLetter.present}'` | | Journal logs | `journalctl -u pulse-sensor-proxy -f` | -| Rate-limit hits | `journalctl -u pulse-sensor-proxy | grep "rate limit"` | +| Rate-limit hits | `journalctl -u pulse-sensor-proxy \| grep "rate limit"` | Set alerts on: