mirror of
https://github.com/minio/minio.git
synced 2025-11-07 21:02:58 -05:00
cleanup markdown docs across multiple files (#14296)
enable markdown-linter
This commit is contained in:
Harshavardhana
GitHub
@@ -1,8 +1,8 @@
|
||||
## MinIO Monitoring Guide
|
||||
# MinIO Monitoring Guide
|
||||
|
||||
MinIO server exposes monitoring data over endpoints. Monitoring tools can pick the data from these endpoints. This document lists the monitoring endpoints and relevant documentation.
|
||||
|
||||
### Healthcheck Probe
|
||||
## Healthcheck Probe
|
||||
|
||||
MinIO server has two healthcheck related un-authenticated endpoints, a liveness probe to indicate if server is responding, cluster probe to check if server can be taken down for maintenance.
|
||||
|
||||
@@ -11,7 +11,7 @@ MinIO server has two healthcheck related un-authenticated endpoints, a liveness
|
||||
|
||||
Read more on how to use these endpoints in [MinIO healthcheck guide](https://github.com/minio/minio/blob/master/docs/metrics/healthcheck/README.md).
|
||||
|
||||
### Prometheus Probe
|
||||
## Prometheus Probe
|
||||
|
||||
MinIO allows reading metrics for the entire cluster from any single node. This allows for metrics collection for a MinIO instance across all servers. Thus, metrics collection for instances behind a load balancer can be done without any knowledge of the individual node addresses. The cluster wide metrics can be read at
|
||||
`<Address for MinIO Service>/minio/v2/metrics/cluster`.
|
||||
@@ -21,7 +21,6 @@ The additional node specific metrics which include additional go metrics or proc
|
||||
|
||||
To use this endpoint, setup Prometheus to scrape data from this endpoint. Read more on how to configure and use Prometheus to monitor MinIO server in [How to monitor MinIO server with Prometheus](https://github.com/minio/minio/blob/master/docs/metrics/prometheus/README.md).
|
||||
|
||||
**Deprecated metrics monitoring**
|
||||
### **Deprecated metrics monitoring**
|
||||
|
||||
- Prometheus' data available at `/minio/prometheus/metrics` is deprecated
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
## MinIO Healthcheck
|
||||
# MinIO Healthcheck
|
||||
|
||||
MinIO server exposes three un-authenticated, healthcheck endpoints liveness probe and a cluster probe at `/minio/health/live` and `/minio/health/cluster` respectively.
|
||||
|
||||
### Liveness probe
|
||||
## Liveness probe
|
||||
|
||||
This probe always responds with '200 OK'. Only fails if 'etcd' is configured and unreachable. This behavior is specific to gateway. When liveness probe fails, Kubernetes like platforms restart the container.
|
||||
|
||||
@@ -19,7 +19,7 @@ livenessProbe:
|
||||
failureThreshold: 3
|
||||
```
|
||||
|
||||
### Readiness probe
|
||||
## Readiness probe
|
||||
|
||||
This probe always responds with '200 OK'. Only fails if 'etcd' is configured and unreachable. This behavior is specific to gateway. When readiness probe fails, Kubernetes like platforms turn-off routing to the container.
|
||||
|
||||
@@ -36,8 +36,10 @@ readinessProbe:
|
||||
failureThreshold: 3
|
||||
```
|
||||
|
||||
### Cluster probe
|
||||
#### Cluster-writeable probe
|
||||
## Cluster probe
|
||||
|
||||
### Cluster-writeable probe
|
||||
|
||||
This probe is not useful in almost all cases, this is meant for administrators to see if write quorum is available in any given cluster. The reply is '200 OK' if cluster has write quorum if not it returns '503 Service Unavailable'.
|
||||
|
||||
```
|
||||
@@ -55,7 +57,8 @@ X-Xss-Protection: 1; mode=block
|
||||
Date: Tue, 21 Jul 2020 00:36:14 GMT
|
||||
```
|
||||
|
||||
#### Cluster-readable probe
|
||||
### Cluster-readable probe
|
||||
|
||||
This probe is not useful in almost all cases, this is meant for administrators to see if read quorum is available in any given cluster. The reply is '200 OK' if cluster has read quorum if not it returns '503 Service Unavailable'.
|
||||
|
||||
```
|
||||
@@ -73,7 +76,8 @@ X-Xss-Protection: 1; mode=block
|
||||
Date: Tue, 21 Jul 2020 00:36:14 GMT
|
||||
```
|
||||
|
||||
#### Checking cluster health for maintenance
|
||||
### Checking cluster health for maintenance
|
||||
|
||||
You may query the cluster probe endpoint to check if the node which received the request can be taken down for maintenance, if the server replies back '412 Precondition Failed' this means you will lose HA. '200 OK' means you are okay to proceed.
|
||||
|
||||
```
|
||||
|
||||
@@ -6,20 +6,8 @@ Prometheus offers a multi-dimensional data model with time series data identifie
|
||||
|
||||
MinIO exports Prometheus compatible data by default as an authorized endpoint at `/minio/v2/metrics/cluster`. Users looking to monitor their MinIO instances can point Prometheus configuration to scrape data from this endpoint. This document explains how to setup Prometheus and configure it to scrape data from MinIO servers.
|
||||
|
||||
**Table of Contents**
|
||||
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [1. Download Prometheus](#1-download-prometheus)
|
||||
- [2. Configure authentication type for Prometheus metrics](#2-configure-authentication-type-for-prometheus-metrics)
|
||||
- [3. Configuring Prometheus](#3-configuring-prometheus)
|
||||
- [3.1 Authenticated Prometheus config](#31-authenticated-prometheus-config)
|
||||
- [3.2 Public Prometheus config](#32-public-prometheus-config)
|
||||
- [4. Update `scrape_configs` section in prometheus.yml](#4-update-scrapeconfigs-section-in-prometheusyml)
|
||||
- [5. Start Prometheus](#5-start-prometheus)
|
||||
- [6. Configure Grafana](#6-configure-grafana)
|
||||
- [List of metrics exposed by MinIO](#list-of-metrics-exposed-by-minio)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
To get started with MinIO, refer [MinIO QuickStart Document](https://docs.min.io/docs/minio-quickstart-guide).
|
||||
Follow below steps to get started with MinIO monitoring using Prometheus.
|
||||
|
||||
@@ -80,6 +68,7 @@ If Prometheus endpoint authentication type is set to `public`. Following prometh
|
||||
This can be collected from any server once per collection.
|
||||
|
||||
##### Cluster
|
||||
|
||||
```yaml
|
||||
scrape_configs:
|
||||
- job_name: minio-job
|
||||
@@ -90,7 +79,9 @@ scrape_configs:
|
||||
```
|
||||
|
||||
##### Node (optional)
|
||||
|
||||
Optionally you can also collect per node metrics. This needs to be done on a per server instance.
|
||||
|
||||
```yaml
|
||||
scrape_configs:
|
||||
- job_name: minio-job
|
||||
|
||||
@@ -15,9 +15,6 @@ Refer to the dashboard [json file here](https://raw.githubusercontent.com/minio/
|
||||
|
||||
|
||||
|
||||
|
||||
Replication metrics can also be viewed in the Grafana dashboard using [json file here](https://raw.githubusercontent.com/minio/minio/master/docs/metrics/prometheus/grafana/minio-replication.json).
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user