Skip to content

Commit e5d1a82

Browse files
committed
Revert "chore: remove health checks for now"
This reverts commit 529e770aa53f0c7a543b5c4d1afc8f17cf6f9dfa.
1 parent d17ac2e commit e5d1a82

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

+27-1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,22 @@ After startup, the Prometheus metrics endpoint should be available at ``localhos
2222

2323
The metrics port can be customized in the plugin's config.yml (a default config will be created after the first use).
2424

25+
## Feature Overview
26+
27+
### Prometheus Exporter
28+
29+
The plugin exports a variety of metrics about your Minecraft server to Prometheus. These metrics can be used to monitor the health and performance of your server.
30+
31+
The metrics are exposed at ``localhost:9940/metrics`` by default. See the rest of the README for more information on how to configure Prometheus to scrape these metrics.
32+
33+
### Custom Health Checks
34+
35+
The plugin can be configured to perform custom health checks on your server. These checks can be used to monitor the health of your server and alert you if something goes wrong.
36+
37+
The aggregated health checks are exposed at ``localhost:9940/health`` by default.
38+
39+
See [Health Checks](#health-checks) for more information on how to build your own health checks in your plugins.
40+
2541
## Installation & Configuration
2642

2743
### Plugin config
@@ -167,7 +183,10 @@ This doesn't support all statistics in the list because they are provided by the
167183
168184
## Plugin Integration
169185
170-
By integrating your own plugin with the Minecraft Prometheus Exporter, you can **monitor your plugin**: Collect metrics about your plugin's performance or usage.
186+
By integrating your own plugin with the Minecraft Prometheus Exporter, you can:
187+
188+
1. **Monitor your plugin's performance**: Collect metrics about your plugin's performance and resource usage.
189+
2. **Provide custom health checks**: Monitor the health of your plugin and alert you if something goes wrong.
171190
172191
### Collect metrics about your own plugin
173192
@@ -209,3 +228,10 @@ public class MyPluginCommand extends PluginCommand {
209228

210229
}
211230
```
231+
232+
233+
### Provide a health check from your own plugin
234+
235+
You can easily collect metrics about your own plugin.
236+
237+
[//]: # (TODO: Add a section about how to provide a health check from your own plugin.)

0 commit comments

Comments
 (0)