Skip to content

Commit 9243cc2

Browse files
committed
add further guidance on usage
1 parent efe4d07 commit 9243cc2

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

deployments/healthcheck-blackbox/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,33 @@ After deployment, you can access [Grafana](http://localhost:3200) using the defa
4141
- **Password**: `abc123`
4242

4343
Navigate to the [Tyk System Health dashboard](http://localhost:3200/d/tyk-system-health) in the [Dashboards section](http://localhost:3200/dashboards) to monitor the status of your Tyk components.
44+
45+
### Simulating Failure and Recovery
46+
47+
This section explains how to simulate a component failure and observe its recovery in the Tyk System Health dashboard.
48+
49+
#### Simulating Failure
50+
51+
1. Stop one of the monitored Tyk components by running the following command:
52+
53+
```sh
54+
docker stop tyk-demo-tyk-gateway-1
55+
```
56+
57+
Stopping this container will cause two probes to report a failure:
58+
- **Gateway Component Probe**
59+
- **Upstream API Probe**
60+
61+
2. Open the Tyk System Health dashboard. Two instances will now be displayed as down.
62+
**Note:** Probes run at 15-second intervals, so there may be a short delay before the changes appear in the dashboard.
63+
64+
#### Simulating Recovery
65+
66+
1. Start the stopped container using the command below:
67+
68+
```sh
69+
docker start tyk-demo-tyk-gateway-1
70+
```
71+
72+
2. Refresh the dashboard to confirm that the previously down components are now marked as up and operational.
73+

0 commit comments

Comments
 (0)