Skip to main content
Version: NG-2.16

MinIO Monitor

Introduction​

MinIO is an open-source, high-performance, S3-compatible object storage system designed for cloud-native and Kubernetes environments. It is widely used for storing unstructured data such as backups, logs, media files, and application artifacts.

Getting Started​

Compatibility​

This source supports monitoring of MinIO deployments that expose Prometheus-compatible metrics endpoints.

It supports: *MinIO instances with Prometheus metrics enabled (/minio/v2/metrics/cluster, /minio/v2/metrics/node, etc.). *MinIO standalone and distributed cluster deployments. *MinIO deployments on: **Kubernetes **OpenShift **Virtual machines **Bare-metal servers

This source requires: *Accessible HTTP/HTTPS metrics endpoint. *Prometheus-format metrics output. *Network connectivity from Telegraf to the MinIO metrics endpoint. *Proper access permissions if authentication is enabled.

Data Collection Method​

The MinIO monitoring source collects metrics using the Prometheus exposition format over HTTP/HTTPS. The collection workflow is as follows: *Connects to the MinIO Prometheus metrics endpoint (e.g. /minio/v2/metrics/cluster or /minio/v2/metrics/node) at configured scrape intervals. *Sends HTTP/HTTPS requests to the configured MinIO service endpoint. *Retrieves metrics exposed in Prometheus text format. *Parses metric names, labels, and values using Telegraf’s Prometheus input plugin. *Converts scraped metrics into Telegraf metric objects. *Forwards processed metrics to the configured output (Kafka, InfluxDB, ClickHouse, etc.) for downstream processing, analytics, and storage.

The plugin supports scraping multiple MinIO endpoints (cluster-level and node-level) in parallel for efficient and scalable metric collection.

Prerequisites​

Dependent Configuration​

To configure this O11ySource, create a 'credential' of type 'user' under the 'Definition' tab.

Inputs for Configuring Data Source​

  • Data Source Name: A unique, descriptive name to identify this MinIO data source within vuSmartMaps. It appears in the sources list and on dashboards.
  • Endpoint URL: Full URL of the MinIO Prometheus-compatible metrics endpoint, including protocol, host, and port (e.g. http://minio-host:9000/minio/v2/metrics/cluster).
  • Polling Interval (in seconds): How frequently data is gathered. The period should be between 60 seconds – 3000 seconds.
  • Authentication Method: Choose how vuSmartMaps authenticates to the MinIO metrics endpoint: select No Authentication for open endpoints, Basic to supply a username and password, or Bearer to use a token.
  • Credential: Credentials used to access the MinIO endpoint.
  • Bearer Token: Bearer token to authenticate with the MinIO endpoint

Firewall Requirement​

To collect data from this O11ySource, ensure the following ports are opened:

Source IPDestination IPDestination PortProtocolDirection
vuSmartMaps IPMinIO endpoint9000TCPOutbound

*Before providing the firewall requirements, please update the port based on the customer environment.

Configuring the Target​

Before configuring the MinIO O11ySource, ensure that:

  • The MinIO instance is running and accessible.
  • MinIO metrics exposure is enabled (the /metrics endpoint is available).
  • Network connectivity exists between the vuSmartMaps cluster and the MinIO metrics endpoint (the HTTP/HTTPS port must be reachable).
  • The correct protocol and port are configured (e.g. http://host:port/metrics or https://host:port/metrics).
  • If HTTPS is enabled:
  • *Valid SSL certificates are configured (or certificate-verification settings are adjusted accordingly).
  • *Required authentication credentials (Basic Auth / Bearer token, if enabled) are available.

Additionally:

  • The MinIO service account or user has permission to access the metrics endpoints (if access control is enforced).
  • Firewall rules, security groups, and OpenShift/Kubernetes network policies allow scraping from the Telegraf collector.
  • For distributed deployments, ensure all nodes are reachable if node-level metrics are being scraped.

Configuration Steps​

  • Enable the O11ySource.
  • Select the Sources tab and press the + button to add a new instance to monitor.
  • Provide the required configurations:
  • *Data Source Name
  • *Endpoint URL
  • *Polling Interval (in seconds)
  • *Authentication Method
  • *Credential
  • Click Save to close the data source window.

Metrics Collected​

The metrics are based on the input data collected.