Skip to content

Commit

Permalink
Add troubleshooting guide
Browse files Browse the repository at this point in the history
  • Loading branch information
SeaweedbrainCY authored Jul 6, 2024
1 parent 3278b40 commit 73a066a
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ version: '3.7'
services:
galera_health_check:
container_name: galera_health_check
image: ghcr.io/seaweedbraincy/galera_cluster_healthcheck:b0.3
image: ghcr.io/seaweedbraincy/galera_cluster_healthcheck:latest
user: 1000:1000
security_opt:
- no-new-privileges:true
Expand Down Expand Up @@ -87,6 +87,30 @@ You can use several env variable to configure the script :
| CLUSTER_MIN_SIZE | **REQUIRED** |Minimum number of nodes in the cluster. This is used to determine if the cluster is in a degraded state|
| WEBHOOK_URL | **REQUIRED** |Discord webhook URL used to send notifications|
## Troubleshooting
### Troubleshooting errors from Galera
This healthchecker monitor the 5 following variables:
- wsrep_cluster_size
- wsrep_cluster_status
- wsrep_local_state_comment
- wsrep_connected
- wsrep_incoming_addresses
In case of error with any of them, all the variable checks are reported in the notification message. Those one in error, would have the 'ERROR' mention, with a quick explanation of the issue.
You can find further troublehsooting variable and more information in the ![official galera documentation](https://galeracluster.com/library/documentation/monitoring-cluster.html).
### Troubleshooting errors from the Healthchecker
Any time the healthchecker finds an error (while checking or if the check fails), you will recieve a notification.
**If and only if all checks pass, you will recieve a notification of normal state.**
While you don't have any green notification following the error notification, that means that you still have to investigate an issue.
**All errors and messages are logged into Docker logs, they are not throttles. You can use :**
```sh
docker compose galera_cluster_healthcheck logs
```


## Contribution

Expand Down

0 comments on commit 73a066a

Please sign in to comment.