Monitoring and Alerts on SILO

Monitoring and Alerting using Prometheus

Mon, 01 Jan 0001 00:00:00 +0000

MinIO publishes cluster, node, bucket, and resource metrics using the Prometheus Data Model. The procedure on this page documents the following:

Configuring a Prometheus service to scrape and display metrics from a MinIO deployment
Configuring an Alert Rule on a MinIO Metric to trigger an AlertManager action

These instructions use version 2 metrics. For more about metrics API versions, see Metrics and alerts.

Monitoring and Alerting using InfluxDB

Mon, 01 Jan 0001 00:00:00 +0000

MinIO publishes cluster and node metrics using the Prometheus Data Model. InfluxDB supports scraping MinIO metrics data for monitoring and alerting.

The procedure on this page documents the following:

Configuring an InfluxDB service to scrape and display metrics from a MinIO deployment
Configuring an Alert on a MinIO metric

Prerequisites

This procedure requires the following:

An existing InfluxDB deployment configured with one or more notification endpoints
An existing MinIO deployment with network access to the InfluxDB deployment
An mc installation on your local host configured to access the MinIO deployment

These instructions use version 2 metrics. For more about metrics API versions, see Metrics and alerts.

Publish Server or Audit Logs to an External Service

Mon, 01 Jan 0001 00:00:00 +0000

MinIO publishes all minio server operations to the system console. Reading these logs depends on how the server process is managed. For example, if the server is managed through a systemd script, you can read the logs using journalctl -u SERVICENAME.service. Replace SERVICENAME with the name of the MinIO service.

MinIO also supports publishing server logs and audit logs to an HTTP webhook.

Server logs contain the same minio server operations logged to the system console. Server logs support general monitoring and troubleshooting of operations.
Audit logs are more granular descriptions of each operation on the MinIO deployment. Audit logging supports security standards and regulations which require detailed tracking of operations.

MinIO publishes logs as a JSON document as a PUT request to each configured endpoint. The endpoint server is responsible for processing each JSON document. MinIO requires explicit configuration of each webhook endpoint and does not publish logs to a webhook by default.

Healthcheck API

Mon, 01 Jan 0001 00:00:00 +0000

MinIO exposes unauthenticated endpoints for probing node uptime and cluster high availability for simple healthchecks. These endpoints return an HTTP status code indicating whether the underlying resource is healthy or satisfies read/write quorum. MinIO exposes no other data through these endpoints.

Node Liveness

Use the following endpoint to test if a MinIO server is online:

curl -I https://minio.example.net:9000/minio/health/live

Replace https://minio.example.net:9000 with the DNS hostname of the MinIO server to check.

Metrics version 2

Mon, 01 Jan 0001 00:00:00 +0000

MinIO publishes cluster and node metrics using the Prometheus Data Model. You can use any scraping tool to pull metrics data from MinIO for further analysis and alerting.

Version 2 Endpoints

Metrics version 2 provides metrics organized into three categories:

Each v2 endpoint returns all metrics for its category. For example, scraping the following endpoint returns all cluster metrics:

http://HOSTNAME:PORT/minio/v2/metrics/cluster

The base endpoint alone, /minio/v2/metrics/, returns cluster metrics.

Monitor a MinIO Server with Grafana

Mon, 01 Jan 0001 00:00:00 +0000

Grafana allows you to query, visualize, alert on and understand your metrics no matter where they are stored.

Prerequisites

An existing Prometheus deployment with backing Alert Manager
An existing MinIO deployment with network access to the Prometheus deployment
Grafana installed

Grafana dashboards use metrics version 2

The MinIO Grafana dashboards use metrics version 2. For more about metrics API versions, see Metrics and alerts.

Version 3 metrics require creating your own dashboard. For more information about dashboards, see the Grafana documentation.