1
0
mirror of https://github.com/TwiN/gatus.git synced 2026-02-16 10:56:11 +00:00

docs: Use working websocket example

This commit is contained in:
TwiN
2025-10-09 13:28:34 -04:00
parent ac4374b1e3
commit e37024dfc6

View File

@@ -2965,20 +2965,20 @@ This works for SCTP based application.
### Monitoring a WebSocket endpoint ### Monitoring a WebSocket endpoint
By prefixing `endpoints[].url` with `ws://` or `wss://`, you can monitor WebSocket endpoints at a very basic level: By prefixing `endpoints[].url` with `ws://` or `wss://`, you can monitor WebSocket endpoints:
```yaml ```yaml
endpoints: endpoints:
- name: example - name: example
url: "wss://example.com/" url: "wss://echo.websocket.org/"
body: "status" body: "status"
conditions: conditions:
- "[CONNECTED] == true" - "[CONNECTED] == true"
- "[BODY].result >= 0" - "[BODY] == pat(*served by*)"
``` ```
The `[BODY]` placeholder contains the output of the query, and `[CONNECTED]` The `[BODY]` placeholder contains the output of the query, and `[CONNECTED]`
shows whether the connection was successfully established. You can use Go template shows whether the connection was successfully established. You can use Go template
syntax. The functions LocalAddr and RandomString with a length can be used. syntax.
### Monitoring an endpoint using ICMP ### Monitoring an endpoint using ICMP