Skip to content

Commit 1670675

Browse files
committed
Update docs
1 parent dec27d8 commit 1670675

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,31 @@
11
# HTTP Probe
22

3-
A simple tool for probing HTTP APIs in network environments like VPS, ECS, and Kubernetes.
3+
A simple tool for probing HTTP APIs in various network environments. Test the availability of your services in local networks, cloud setups, and multi-service environments like Kubernetes clusters. It also includes a Docker image for easy deployment within your infrastructure.
44

55
Pull publicly available Docker image:
66

77
```bash
88
docker pull sskender/http-probe:latest
99
```
1010

11-
Run with your HTTP API endpoint:
11+
Run with your HTTP API endpoint as target:
1212

1313
```bash
1414
docker run --rm sskender/http-probe:latest https://api.example.com/v1/health
1515
```
16+
17+
Example output:
18+
19+
```txt
20+
[2024-09-28 13:54:00] Starting the probe process
21+
[2024-09-28 13:54:00] Target endpoint: https://api.example.com/v1/health
22+
[2024-09-28 13:54:00] Sending the probe
23+
[2024-09-28 13:54:00] Trying to resolve domain: api.example.com
24+
[2024-09-28 13:54:00] Record found: 115.19.142.57
25+
[2024-09-28 13:54:00] Record found: 115.19.141.57
26+
[2024-09-28 13:54:00] Record found: 115.19.138.57
27+
[2024-09-28 13:54:00] Record found: 115.19.140.57
28+
[2024-09-28 13:54:00] Record found: 115.19.139.57
29+
[2024-09-28 13:54:01] HTTP response code: 200
30+
[2024-09-28 13:54:01] Waiting for 10s before sending the next probe
31+
```

0 commit comments

Comments
 (0)