minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-04-19 21:02:14 +03:00
Code
docs/source/monitoring/monitoring-overview.rst
ravindk89 9b4ec43824 Migration: Metrics and Logging 
Apply suggestions from code review via Eco

Co-authored-by: Eco <41090896+eco-minio@users.noreply.github.com>

Completing response to eco PR

Minor fixup

One more fixup
2021-06-17 09:49:27 -04:00

3.1 KiB
Raw Permalink Blame History

Monitoring

minio

Table of Contents

Metrics and Alerts

MinIO provides cluster and node-level metrics through Prometheus-compatible scraping endpoints. 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. You can alternatively use any other Prometheus-compatible metrics scraping software.

  • See minio-metrics-and-alerts for more complete documentation on MinIO Metrics and Alerts.
  • See minio-metrics-collect-using-prometheus for a tutorial on configuring Prometheus for monitoring a MinIO deployment.

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.

Bucket Notifications

MinIO supports publishing bucket or object events to the following supported targets on certain supported events.

  • minio-bucket-notifications-publish-amqp
  • minio-bucket-notifications-publish-mqtt
  • minio-bucket-notifications-publish-nats
  • minio-bucket-notifications-publish-nsq
  • minio-bucket-notifications-publish-elasticsearch
  • minio-bucket-notifications-publish-kafka
  • minio-bucket-notifications-publish-mysql
  • minio-bucket-notifications-publish-postgresql
  • minio-bucket-notifications-publish-redis
  • minio-bucket-notifications-publish-webhook

See minio-bucket-notifications for more complete documentation on MinIO Bucket Notifications.

/monitoring/metrics-alerts/minio-metrics-and-alerts /monitoring/logging/minio-logging /monitoring/healthcheck-probe /monitoring/bucket-notifications/bucket-notifications