From 38dc2a1fd7316e61e6d3109253d0e8682cbba26d Mon Sep 17 00:00:00 2001 From: Philip Whiteside Date: Sat, 14 Dec 2024 11:43:23 +0000 Subject: [PATCH] Change protocol backslash to forwardslash in README.md Some of the text examples used `proto:\\` instead of `proto://`. The backslash is not correct and results in "panic: invalid endpoint testgroup-|-testendpoint: unknown endpoint type". --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 677e6ddd..9facb722 100644 --- a/README.md +++ b/README.md @@ -1918,7 +1918,7 @@ To modify the timeout, see [Client configuration](#client-configuration). ### Monitoring a TCP endpoint -By prefixing `endpoints[].url` with `tcp:\\`, you can monitor TCP endpoints at a very basic level: +By prefixing `endpoints[].url` with `tcp://`, you can monitor TCP endpoints at a very basic level: ```yaml endpoints: @@ -1940,7 +1940,7 @@ This works for applications such as databases (Postgres, MySQL, etc.) and caches ### Monitoring a UDP endpoint -By prefixing `endpoints[].url` with `udp:\\`, you can monitor UDP endpoints at a very basic level: +By prefixing `endpoints[].url` with `udp://`, you can monitor UDP endpoints at a very basic level: ```yaml endpoints: @@ -1957,7 +1957,7 @@ This works for UDP based application. ### Monitoring a SCTP endpoint -By prefixing `endpoints[].url` with `sctp:\\`, you can monitor Stream Control Transmission Protocol (SCTP) endpoints at a very basic level: +By prefixing `endpoints[].url` with `sctp://`, you can monitor Stream Control Transmission Protocol (SCTP) endpoints at a very basic level: ```yaml endpoints: @@ -1991,7 +1991,7 @@ shows whether the connection was successfully established. ### Monitoring an endpoint using ICMP -By prefixing `endpoints[].url` with `icmp:\\`, you can monitor endpoints at a very basic level using ICMP, or more +By prefixing `endpoints[].url` with `icmp://`, you can monitor endpoints at a very basic level using ICMP, or more commonly known as "ping" or "echo": ```yaml @@ -2030,7 +2030,7 @@ There are two placeholders that can be used in the conditions for endpoints of t ### Monitoring an endpoint using SSH -You can monitor endpoints using SSH by prefixing `endpoints[].url` with `ssh:\\`: +You can monitor endpoints using SSH by prefixing `endpoints[].url` with `ssh://`: ```yaml endpoints: - name: ssh-example