Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add top level metrics document to summarize monitoring endpoints (#5923)
Minio server supports healthcheck and prometheus related unauthenticated endpoints. This document summarizes this information in a single place and add links for more detailed documentation if needed.
- Loading branch information
Showing
3 changed files
with
22 additions
and
38 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
## Minio Monitoring Guide | ||
|
||
Minio server exposes monitoring data over un-authenticated endpoints so monitoring tools can pick the data without you having to share Minio server credentials. This document lists the monitoring endpoints and relevant documentation. | ||
|
||
### Healthcheck Probe | ||
|
||
Minio server has two healthcheck related endpoints, a liveness probe to indicate if server is working fine and a readiness probe to indicate if server is not accepting connections due to heavy load. | ||
|
||
- Liveness probe available at `/minio/health/live` | ||
- Readiness probe available at `/minio/health/ready` | ||
|
||
Read more on how to use these endpoints in [Minio healthcheck guide](./healthcheck/README.md). | ||
|
||
### Prometheus Probe | ||
|
||
Minio server exposes Prometheus compatible data on a single endpoint. | ||
|
||
- Prometheus data available at `/minio/prometheus/metrics` | ||
|
||
To use this endpoint, setup Prometheus to scrape data from this endpoint. Read more on how to use Prometheues to monitor Minio server in [How to monitor Minio server with Prometheus](https://github.com/minio/cookbook/blob/master/docs/how-to-monitor-minio-with-prometheus.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters