minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2026-01-04 02:44:36 +03:00
Code Activity
Files
21797d127b3f136bf273288a1e303873b1023045
docs/source/operations/monitoring.rst
Daryl White 6e7444c812 Updates documentation for Console release 0.20.0 (#601) 
Closes #535

- Updates MinIO Console doc section on the Support tab
- Adds info to several pages that Prometheus metrics displayed in the
console can now be downloaded
- Adds that bucket notification targets can now be deleted from the
console
- Updates the MinIO Console page to reflect the current navigation
layout by moving around sections and updating screenshots
2022-10-11 16:31:04 -05:00

2.9 KiB
Raw Blame History

Prometheus Monitoring

minio

Table of Contents

Metrics and Alerts

MinIO provides point-in-time metrics on cluster status and operations. MinIO publishes collected metrics data using Prometheus-compatible data structures.

For alerts, time-series metric data, or additional metrics, MinIO can leverage Prometheus. Prometheus is an Open Source systems and service monitoring system which supports analyzing and alerting based on collected metrics. The Prometheus ecosystem includes multiple integrations <operating/integrations/>, allowing wide latitude in processing and storing collected metrics.

  • MinIO publishes Prometheus-compatible scraping endpoints for cluster and node-level metrics. Any Prometheus-compatible scraping software can ingest and process MinIO metrics for analysis, visualization, and alerting. See minio-metrics-and-alerts-endpoints for more information.
  • For alerts, use Prometheus Alerting Rules <prometheus/latest/configuration/alerting_rules/> and the Alert Manager <alerting/latest/overview/> to trigger alerts based on collected metrics. See minio-metrics-and-alerts-alerting for more information.

When configured, the MinIO Console <minio-console-metrics> shows some metrics in the Monitoring > Metrics page. You can download these metrics as either .png images or .csv files.

Logging

MinIO publishes all minio server operations to the system console. MinIO also supports publishing server logs and audit logs to an HTTP webhook.

  • Server logs <minio-logging-publish-server-logs> contain the same minio server operations logged to the system console. Server logs support general monitoring and troubleshooting of operations.
  • Audit logs <minio-logging-publish-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.

See minio-logging for more complete documentation.

Healthchecks

MinIO exposes unauthenticated endpoints for probing node uptime and cluster high availability <minio-ec-parity> for simple healthchecks. These endpoints return only an HTTP status code. See minio-healthcheck-api for more information.

/operations/monitoring/collect-minio-metrics-using-prometheus /operations/monitoring/minio-logging /operations/monitoring/healthcheck-probe

View Git Blame Copy Permalink