mirror of
https://github.com/pgsty/minio.git
synced 2026-08-09 15:53:28 +03:00
docs: rebrand the repository documentation, templates and dashboards
README, README_ZH, SECURITY, COMPLIANCE, CONTRIBUTING, NOTICE, code_of_conduct, the vulnerability and PR-etiquette documents, the GitHub issue and pull request templates, and the docs/ tree all present Silo as the product. The Grafana dashboards under docs/metrics/prometheus/grafana/ have their panel titles and descriptions rebranded while every minio_* query, label and expression is left alone, so existing alerts and recording rules keep matching. The distinction the review demanded is applied per hit rather than by search-and-replace: - Product and command text becomes Silo and silo: install and run instructions, systemd examples, compose services, download links, badges. - Protocol and interface text keeps MinIO: MINIO_* variables, minio_* metrics, x-minio-* headers, /minio/* routes, .minio.sys, arn:minio, and API field and error names. - Attribution keeps MinIO and gains the fork's own: the AGPL obligations, original copyright, CREDITS and NOTICE stay, with the modification notice added alongside rather than replacing them. - Historical and third-party references are left as facts, not rewritten for brand tidiness. README and README_ZH each carry an explicit non-affiliation notice, document the side-by-side package migration including the /etc/systemd/system/silo.service.d/10-legacy-user.conf drop-in for keeping a legacy UID/GID, and state that recursive chown is never performed. The trademark attribution uses the policy's approved "based on MinIO technology" wording, not the shortened form the policy rejects. github.com/pgsty/minio links are left in place and labelled transitional. The repository has not been renamed, and rewriting them now would produce documented URLs that 404 until the cutover; they change in the cutover commit together with the goreleaser release target, the OCI source label and the raw-content branch. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
Feng Ruohang
@@ -1,16 +1,16 @@
|
||||
# How to monitor MinIO server with Prometheus? [](https://slack.min.io)
|
||||
# How to monitor Silo server with Prometheus?
|
||||
|
||||
[Prometheus](https://prometheus.io) is a cloud-native monitoring platform. Prometheus offers a multi-dimensional data model with time series data identified by metric name and key/value pairs. The data collection happens via a pull model over HTTP/HTTPS. Users looking to monitor their MinIO instances can point Prometheus configuration to scrape data from following endpoints.
|
||||
[Prometheus](https://prometheus.io) is a cloud-native monitoring platform. Prometheus offers a multi-dimensional data model with time series data identified by metric name and key/value pairs. The data collection happens via a pull model over HTTP/HTTPS. Users looking to monitor their Silo instances can point Prometheus configuration to scrape data from following endpoints.
|
||||
|
||||
- MinIO exports Prometheus compatible data by default as an authorized endpoint at `/minio/v2/metrics/cluster`.
|
||||
- MinIO exports Prometheus compatible data by default which is bucket centric as an authorized endpoint at `/minio/v2/metrics/bucket`.
|
||||
- Silo exports Prometheus compatible data by default as an authorized endpoint at `/minio/v2/metrics/cluster`.
|
||||
- Silo exports Prometheus compatible data by default which is bucket centric as an authorized endpoint at `/minio/v2/metrics/bucket`.
|
||||
|
||||
This document explains how to setup Prometheus and configure it to scrape data from MinIO servers.
|
||||
This document explains how to setup Prometheus and configure it to scrape data from Silo servers.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
To get started with MinIO, refer [MinIO QuickStart Document](https://silo.pgsty.com/operations/deployments/baremetal-deploy-minio-on-redhat-linux/).
|
||||
Follow below steps to get started with MinIO monitoring using Prometheus.
|
||||
To get started with Silo, refer [Silo QuickStart Document](https://silo.pgsty.com/operations/deployments/baremetal-deploy-minio-on-redhat-linux/).
|
||||
Follow below steps to get started with Silo monitoring using Prometheus.
|
||||
|
||||
### 1. Download Prometheus
|
||||
|
||||
@@ -36,20 +36,20 @@ Refer [Prometheus documentation](https://prometheus.io/docs/introduction/first_s
|
||||
|
||||
### 2. Configure authentication type for Prometheus metrics
|
||||
|
||||
MinIO supports two authentication modes for Prometheus either `jwt` or `public`, by default MinIO runs in `jwt` mode. To allow public access without authentication for prometheus metrics set environment as follows.
|
||||
Silo supports two authentication modes for Prometheus either `jwt` or `public`, by default Silo runs in `jwt` mode. To allow public access without authentication for prometheus metrics set environment as follows.
|
||||
|
||||
```
|
||||
export MINIO_PROMETHEUS_AUTH_TYPE="public"
|
||||
minio server ~/test
|
||||
silo server ~/test
|
||||
```
|
||||
|
||||
### 3. Configuring Prometheus
|
||||
|
||||
#### 3.1 Authenticated Prometheus config
|
||||
|
||||
> If MinIO is configured to expose metrics without authentication, you don't need to use `mc` to generate prometheus config. You can skip reading further and move to 3.2 section.
|
||||
> If Silo is configured to expose metrics without authentication, you don't need to use `mc` to generate prometheus config. You can skip reading further and move to 3.2 section.
|
||||
|
||||
The Prometheus endpoint in MinIO requires authentication by default. Prometheus supports a bearer token approach to authenticate prometheus scrape requests, override the default Prometheus config with the one generated using mc. To generate a Prometheus config for an alias, use [mc](https://silo.pgsty.com/reference/minio-mc/#quickstart) as follows `mc admin prometheus generate <alias> [METRIC-TYPE]`. The valid values for METRIC-TYPE are `cluster`, `node`, `bucket` and `resource` and if not mentioned, it defaults to `cluster`.
|
||||
The Prometheus endpoint in Silo requires authentication by default. Prometheus supports a bearer token approach to authenticate prometheus scrape requests, override the default Prometheus config with the one generated using mc. To generate a Prometheus config for an alias, use [mc](https://silo.pgsty.com/reference/minio-mc/#quickstart) as follows `mc admin prometheus generate <alias> [METRIC-TYPE]`. The valid values for METRIC-TYPE are `cluster`, `node`, `bucket` and `resource` and if not mentioned, it defaults to `cluster`.
|
||||
|
||||
The command will generate the `scrape_configs` section of the prometheus.yml as follows:
|
||||
|
||||
@@ -57,7 +57,7 @@ The command will generate the `scrape_configs` section of the prometheus.yml as
|
||||
|
||||
```yaml
|
||||
scrape_configs:
|
||||
- job_name: minio-job
|
||||
- job_name: silo-job
|
||||
bearer_token: <secret>
|
||||
metrics_path: /minio/v2/metrics/cluster
|
||||
scheme: http
|
||||
@@ -68,7 +68,7 @@ scrape_configs:
|
||||
##### Bucket centric
|
||||
|
||||
```yaml
|
||||
- job_name: minio-job-bucket
|
||||
- job_name: silo-job-bucket
|
||||
bearer_token: <secret>
|
||||
metrics_path: /minio/v2/metrics/bucket
|
||||
scheme: http
|
||||
@@ -79,7 +79,7 @@ scrape_configs:
|
||||
##### Node centric (optional)
|
||||
|
||||
```yaml
|
||||
- job_name: minio-job-node
|
||||
- job_name: silo-job-node
|
||||
bearer_token: <secret>
|
||||
metrics_path: /minio/v2/metrics/node
|
||||
scheme: http
|
||||
@@ -90,7 +90,7 @@ scrape_configs:
|
||||
##### Resource centric (optional)
|
||||
|
||||
```yaml
|
||||
- job_name: minio-job-resource
|
||||
- job_name: silo-job-resource
|
||||
bearer_token: <secret>
|
||||
metrics_path: /minio/v2/metrics/resource
|
||||
scheme: http
|
||||
@@ -100,14 +100,14 @@ scrape_configs:
|
||||
|
||||
#### 3.2 Public Prometheus config
|
||||
|
||||
If Prometheus endpoint authentication type is set to `public`. Following prometheus config is sufficient to start scraping metrics data from MinIO.
|
||||
If Prometheus endpoint authentication type is set to `public`. Following prometheus config is sufficient to start scraping metrics data from Silo.
|
||||
This can be collected from any server once per collection.
|
||||
|
||||
##### Cluster
|
||||
|
||||
```yaml
|
||||
scrape_configs:
|
||||
- job_name: minio-job
|
||||
- job_name: silo-job
|
||||
metrics_path: /minio/v2/metrics/cluster
|
||||
scheme: http
|
||||
static_configs:
|
||||
@@ -118,7 +118,7 @@ scrape_configs:
|
||||
|
||||
```yaml
|
||||
scrape_configs:
|
||||
- job_name: minio-job-bucket
|
||||
- job_name: silo-job-bucket
|
||||
metrics_path: /minio/v2/metrics/bucket
|
||||
scheme: http
|
||||
static_configs:
|
||||
@@ -133,7 +133,7 @@ grafana can visualize them for all the nodes
|
||||
|
||||
```yaml
|
||||
scrape_configs:
|
||||
- job_name: minio-job
|
||||
- job_name: silo-job
|
||||
metrics_path: /minio/v2/metrics/node
|
||||
scheme: http
|
||||
static_configs:
|
||||
@@ -146,7 +146,7 @@ Optionally you can also collect resource metrics.
|
||||
|
||||
```yaml
|
||||
scrape_configs:
|
||||
- job_name: minio-job
|
||||
- job_name: silo-job
|
||||
metrics_path: /minio/v2/metrics/resource
|
||||
scheme: http
|
||||
static_configs:
|
||||
@@ -165,25 +165,26 @@ Start (or) Restart Prometheus service by running
|
||||
./prometheus --config.file=prometheus.yml
|
||||
```
|
||||
|
||||
Here `prometheus.yml` is the name of configuration file. You can now see MinIO metrics in Prometheus dashboard. By default Prometheus dashboard is accessible at `http://localhost:9090`.
|
||||
Here `prometheus.yml` is the name of configuration file. You can now see Silo metrics in Prometheus dashboard. By default Prometheus dashboard is accessible at `http://localhost:9090`.
|
||||
|
||||
Prometheus sets the `Host` header to `domain:port` as part of HTTP operations against the MinIO metrics endpoint. For MinIO deployments behind a load balancer, reverse proxy, or other control plane (HAProxy, nginx, pfsense, opnsense, etc.), ensure the network service supports routing these requests to the deployment.
|
||||
Prometheus sets the `Host` header to `domain:port` as part of HTTP operations against the Silo metrics endpoint. For Silo deployments behind a load balancer, reverse proxy, or other control plane (HAProxy, nginx, pfsense, opnsense, etc.), ensure the network service supports routing these requests to the deployment.
|
||||
|
||||
### 6. Configure Grafana
|
||||
|
||||
After Prometheus is configured, you can use Grafana to visualize MinIO metrics. Refer the [document here to setup Grafana with MinIO prometheus metrics](https://github.com/pgsty/minio/blob/master/docs/metrics/prometheus/grafana/README.md).
|
||||
After Prometheus is configured, you can use Grafana to visualize Silo metrics. Refer the [document here to setup Grafana with Silo prometheus metrics](https://github.com/pgsty/minio/blob/master/docs/metrics/prometheus/grafana/README.md).
|
||||
|
||||
## List of metrics exposed by MinIO
|
||||
## List of metrics exposed by Silo
|
||||
|
||||
- MinIO exports Prometheus compatible data by default as an authorized endpoint at `/minio/v2/metrics/cluster`.
|
||||
- MinIO exports Prometheus compatible data by default which is bucket centric as an authorized endpoint at `/minio/v2/metrics/bucket`.
|
||||
- MinIO exports Prometheus compatible data by default which is node centric as an authorized endpoint at `/minio/v2/metrics/node`.
|
||||
- MinIO exports Prometheus compatible data by default which is resource centric as an authorized endpoint at `/minio/v2/metrics/resource`.
|
||||
- Silo exports Prometheus compatible data by default as an authorized endpoint at `/minio/v2/metrics/cluster`.
|
||||
- Silo exports Prometheus compatible data by default which is bucket centric as an authorized endpoint at `/minio/v2/metrics/bucket`.
|
||||
- Silo exports Prometheus compatible data by default which is node centric as an authorized endpoint at `/minio/v2/metrics/node`.
|
||||
- Silo exports Prometheus compatible data by default which is resource centric as an authorized endpoint at `/minio/v2/metrics/resource`.
|
||||
|
||||
All of these can be accessed via Prometheus dashboard. A sample list of exposed metrics along with their definition is available on our public demo server at
|
||||
All of these can be accessed via Prometheus. For a local deployment configured
|
||||
with public metrics, inspect the compatibility route directly:
|
||||
|
||||
```sh
|
||||
curl https://play.min.io/minio/v2/metrics/cluster
|
||||
curl http://127.0.0.1:9000/minio/v2/metrics/cluster
|
||||
```
|
||||
|
||||
### List of metrics reported Cluster and Bucket level
|
||||
|
||||
@@ -44,7 +44,7 @@ rule_files:
|
||||
Here `rules.yml` is the file which should contain the alerting rules defined.
|
||||
|
||||
## Add rules for your deployment
|
||||
Below is a sample alerting rules configuration for MinIO. Refer https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/ for more instructions on writing alerting rules for Prometheus.
|
||||
Below is a sample alerting rules configuration for Silo. Refer https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/ for more instructions on writing alerting rules for Prometheus.
|
||||
|
||||
```yaml
|
||||
groups:
|
||||
@@ -57,15 +57,15 @@ groups:
|
||||
severity: critical
|
||||
annotations:
|
||||
summary: "Instance {{ $labels.server }} has lost quorum on pool {{ $labels.pool }} on set {{ $labels.set }}"
|
||||
description: "MinIO instance {{ $labels.server }} of job {{ $labels.job }} has lost quorum on pool {{ $labels.pool }} on set {{ $labels.set }} for more than 5 minutes."
|
||||
description: "Silo instance {{ $labels.server }} of job {{ $labels.job }} has lost quorum on pool {{ $labels.pool }} on set {{ $labels.set }} for more than 5 minutes."
|
||||
```
|
||||
|
||||
## Verify the configuration and alerts
|
||||
To verify the above sample alert follow below steps
|
||||
|
||||
1. Start a distributed MinIO instance (4 nodes setup)
|
||||
1. Start a distributed Silo instance (4 nodes setup)
|
||||
2. Start Prometheus server and AlertManager
|
||||
3. Bring down couple of MinIO instances to bring down the Erasure Set tolerance to -1 and verify the same with `mc admin prometheus metrics ALIAS | grep minio_cluster_health_erasure_set_status`
|
||||
3. Bring down couple of Silo instances to bring down the Erasure Set tolerance to -1 and verify the same with `mc admin prometheus metrics ALIAS | grep minio_cluster_health_erasure_set_status`
|
||||
4. Wait for 5 mins (as alert is configured to be firing after 5 mins), and verify that you see an entry in webhook for the alert as well as in Prometheus console as shown below
|
||||
|
||||
```json
|
||||
@@ -85,7 +85,7 @@ To verify the above sample alert follow below steps
|
||||
"severity": "critical"
|
||||
},
|
||||
"annotations": {
|
||||
"description": "MinIO instance 127.0.0.1:9000 of job minio-job has tolerance <=0 for more than 5 minutes.",
|
||||
"description": "Silo instance 127.0.0.1:9000 of job minio-job has tolerance <=0 for more than 5 minutes.",
|
||||
"summary": "Instance 127.0.0.1:9000 unable to tolerate node failures"
|
||||
},
|
||||
"startsAt": "2023-11-18T06:20:09.456Z",
|
||||
@@ -107,7 +107,7 @@ To verify the above sample alert follow below steps
|
||||
"severity": "critical"
|
||||
},
|
||||
"commonAnnotations": {
|
||||
"description": "MinIO instance 127.0.0.1:9000 of job minio-job has lost quorum on pool 0 on set 0 for more than 5 minutes.",
|
||||
"description": "Silo instance 127.0.0.1:9000 of job minio-job has lost quorum on pool 0 on set 0 for more than 5 minutes.",
|
||||
"summary": "Instance 127.0.0.1:9000 has lost quorum on pool 0 on set 0"
|
||||
},
|
||||
"externalURL": "http://fedora-minio:9093",
|
||||
|
||||
@@ -1,34 +1,20 @@
|
||||
# How to monitor MinIO server with Grafana [](https://slack.min.io)
|
||||
# How to monitor Silo server with Grafana
|
||||
|
||||
[Grafana](https://grafana.com/) allows you to query, visualize, alert on and understand your metrics no matter where they are stored. Create, explore, and share dashboards with your team and foster a data driven culture.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Prometheus and MinIO configured as explained in [document here](https://github.com/pgsty/minio/blob/master/docs/metrics/prometheus/README.md).
|
||||
- Prometheus and Silo configured as explained in [document here](https://github.com/pgsty/minio/blob/master/docs/metrics/prometheus/README.md).
|
||||
- Grafana installed as explained [here](https://grafana.com/grafana/download).
|
||||
|
||||
## MinIO Grafana Dashboard
|
||||
## Silo Grafana dashboards
|
||||
|
||||
Visualize MinIO metrics with our official Grafana dashboard available on the [Grafana dashboard portal](https://grafana.com/grafana/dashboards/13502).
|
||||
Import the checked-in JSON dashboards for the view you need:
|
||||
|
||||
Refer to the dashboard [json file here](https://raw.githubusercontent.com/pgsty/minio/master/docs/metrics/prometheus/grafana/minio-dashboard.json).
|
||||
- [Overview dashboard](minio-dashboard.json)
|
||||
- [Node replication dashboard](replication/minio-replication-node.json)
|
||||
- [Cluster replication dashboard](replication/minio-replication-cluster.json)
|
||||
- [Bucket dashboard](bucket/minio-bucket.json)
|
||||
- [Node dashboard](node/minio-node.json)
|
||||
|
||||
|
||||
|
||||
Node level Replication metrics can be viewed in the Grafana dashboard using [json file here](https://raw.githubusercontent.com/pgsty/minio/master/docs/metrics/prometheus/grafana/replication/minio-replication-node.json)
|
||||
|
||||
|
||||
|
||||
Cluster level Replication metrics can be viewed in the Grafana dashboard using [json file here](https://raw.githubusercontent.com/pgsty/minio/master/docs/metrics/prometheus/grafana/replication/minio-replication-cluster.json)
|
||||
|
||||
|
||||
|
||||
Bucket metrics can be viewed in the Grafana dashboard using [json file here](https://raw.githubusercontent.com/pgsty/minio/master/docs/metrics/prometheus/grafana/bucket/minio-bucket.json)
|
||||
|
||||
|
||||
|
||||
Node metrics can be viewed in the Grafana dashboard using [json file here](https://raw.githubusercontent.com/pgsty/minio/master/docs/metrics/prometheus/grafana/node/minio-node.json)
|
||||
|
||||
|
||||
|
||||
Note: All these dashboards are provided as an example and need basis they should be customized as well as new graphs should be added.
|
||||
The filenames and Prometheus query identifiers retain `minio` for monitoring compatibility. Their displayed product titles use Silo. Treat these dashboards as maintained examples and adapt thresholds, variables, and panels to your deployment.
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"description": "MinIO Grafana Dashboard - https://min.io/",
|
||||
"description": "Silo Grafana Dashboard - https://silo.pgsty.com/",
|
||||
"editable": true,
|
||||
"fiscalYearStartMonth": 0,
|
||||
"gnetId": 15306,
|
||||
@@ -4207,7 +4207,7 @@
|
||||
]
|
||||
},
|
||||
"timezone": "",
|
||||
"title": "MinIO Bucket Dashboard",
|
||||
"title": "Silo Bucket Dashboard",
|
||||
"uid": "TgmJnqnnk2",
|
||||
"version": 1,
|
||||
"weekStart": ""
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"description": "MinIO Grafana Dashboard - https://min.io/",
|
||||
"description": "Silo Grafana Dashboard - https://silo.pgsty.com/",
|
||||
"editable": true,
|
||||
"fiscalYearStartMonth": 0,
|
||||
"gnetId": 13502,
|
||||
@@ -2352,7 +2352,7 @@
|
||||
"type": "prometheus",
|
||||
"uid": "${DS_PROMETHEUS}"
|
||||
},
|
||||
"description": "Total number of bytes received and sent on MinIO cluster",
|
||||
"description": "Total number of bytes received and sent on Silo cluster",
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": {
|
||||
@@ -2596,7 +2596,7 @@
|
||||
"type": "prometheus",
|
||||
"uid": "${DS_PROMETHEUS}"
|
||||
},
|
||||
"description": "Number of online drives per MinIO Server",
|
||||
"description": "Number of online drives per Silo Server",
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": {
|
||||
@@ -3861,7 +3861,7 @@
|
||||
]
|
||||
},
|
||||
"timezone": "",
|
||||
"title": "MinIO Dashboard",
|
||||
"title": "Silo Dashboard",
|
||||
"uid": "TgmJnqnnk",
|
||||
"version": 1,
|
||||
"weekStart": ""
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"description": "MinIO Nodes Grafana Dashboard - https://min.io/",
|
||||
"description": "Silo Nodes Grafana Dashboard - https://silo.pgsty.com/",
|
||||
"editable": true,
|
||||
"fiscalYearStartMonth": 0,
|
||||
"gnetId": 15306,
|
||||
@@ -948,7 +948,7 @@
|
||||
]
|
||||
},
|
||||
"timezone": "",
|
||||
"title": "MinIO Node Dashboard",
|
||||
"title": "Silo Node Dashboard",
|
||||
"uid": "TgmJnnqn2k",
|
||||
"version": 1,
|
||||
"weekStart": ""
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"description": "MinIO Grafana Dashboard - https://min.io/",
|
||||
"description": "Silo Grafana Dashboard - https://silo.pgsty.com/",
|
||||
"editable": true,
|
||||
"fiscalYearStartMonth": 0,
|
||||
"gnetId": 15306,
|
||||
@@ -2945,7 +2945,7 @@
|
||||
]
|
||||
},
|
||||
"timezone": "",
|
||||
"title": "MinIO Cluster Replication Dashboard",
|
||||
"title": "Silo Cluster Replication Dashboard",
|
||||
"uid": "TgmJnnqnk3",
|
||||
"version": 1,
|
||||
"weekStart": ""
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"description": "MinIO Grafana Dashboard - https://min.io/",
|
||||
"description": "Silo Grafana Dashboard - https://silo.pgsty.com/",
|
||||
"editable": true,
|
||||
"fiscalYearStartMonth": 0,
|
||||
"gnetId": 15306,
|
||||
@@ -2390,7 +2390,7 @@
|
||||
]
|
||||
},
|
||||
"timezone": "",
|
||||
"title": "MinIO Node Replication Dashboard",
|
||||
"title": "Silo Node Replication Dashboard",
|
||||
"uid": "gmTJnqnnk3",
|
||||
"version": 1,
|
||||
"weekStart": ""
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
# Cluster Metrics
|
||||
|
||||
MinIO collects the following metrics at the cluster level.
|
||||
Silo collects the following metrics at the cluster level.
|
||||
Metrics may include one or more labels, such as the server that calculated that metric.
|
||||
|
||||
These metrics can be obtained from any MinIO server once per collection by using the following URL:
|
||||
These metrics can be obtained from any Silo server once per collection by using the following URL:
|
||||
|
||||
```shell
|
||||
https://HOSTNAME:PORT/minio/v2/metrics/cluster
|
||||
```
|
||||
|
||||
Replace ``HOSTNAME:PORT`` with the hostname of your MinIO deployment.
|
||||
Replace ``HOSTNAME:PORT`` with the hostname of your Silo deployment.
|
||||
For deployments behind a load balancer, use the load balancer hostname instead of a single node hostname.
|
||||
|
||||
## Audit Metrics
|
||||
@@ -66,8 +66,8 @@ For deployments behind a load balancer, use the load balancer hostname instead o
|
||||
|
||||
| Name | Description |
|
||||
|:--------------------------------------------------|:-----------------------------------------------|
|
||||
| `minio_cluster_nodes_offline_total` | Total number of MinIO nodes offline. |
|
||||
| `minio_cluster_nodes_online_total` | Total number of MinIO nodes online. |
|
||||
| `minio_cluster_nodes_offline_total` | Total number of Silo nodes offline. |
|
||||
| `minio_cluster_nodes_online_total` | Total number of Silo nodes online. |
|
||||
| `minio_cluster_write_quorum` | Maximum write quorum across all pools and sets |
|
||||
| `minio_cluster_health_status` | Get current cluster health status |
|
||||
| `minio_cluster_health_erasure_set_healing_drives` | Count of healing drives in the erasure set |
|
||||
@@ -188,8 +188,8 @@ For deployments with [bucket](https://silo.pgsty.com/administration/bucket-repli
|
||||
|
||||
| Name | Description |
|
||||
|:------------------------------|:---------------------------------------|
|
||||
| `minio_software_commit_info` | Git commit hash for the MinIO release. |
|
||||
| `minio_software_version_info` | MinIO Release tag for the server. |
|
||||
| `minio_software_commit_info` | Git commit hash for the Silo release. |
|
||||
| `minio_software_version_info` | Silo Release tag for the server. |
|
||||
|
||||
## Drive Metrics
|
||||
|
||||
@@ -246,8 +246,8 @@ For deployments with [bucket](https://silo.pgsty.com/administration/bucket-repli
|
||||
|
||||
| Name | Description |
|
||||
|:-------------------------------------------|:----------------------------------------------------------------------------------------------------------------|
|
||||
| `minio_node_file_descriptor_limit_total` | Limit on total number of open file descriptors for the MinIO Server process. |
|
||||
| `minio_node_file_descriptor_open_total` | Total number of open file descriptors by the MinIO Server process. |
|
||||
| `minio_node_file_descriptor_limit_total` | Limit on total number of open file descriptors for the Silo Server process. |
|
||||
| `minio_node_file_descriptor_open_total` | Total number of open file descriptors by the Silo Server process. |
|
||||
| `minio_node_go_routine_total` | Total number of go routines running. |
|
||||
| `minio_node_io_rchar_bytes` | Total bytes read by the process from the underlying storage system including cache, /proc/[pid]/io rchar. |
|
||||
| `minio_node_io_read_bytes` | Total bytes read by the process from the underlying storage system, /proc/[pid]/io read_bytes. |
|
||||
@@ -256,8 +256,8 @@ For deployments with [bucket](https://silo.pgsty.com/administration/bucket-repli
|
||||
| `minio_node_process_cpu_total_seconds` | Total user and system CPU time spent in seconds by the process. |
|
||||
| `minio_node_process_resident_memory_bytes` | Resident memory size in bytes. |
|
||||
| `minio_node_process_virtual_memory_bytes` | Virtual memory size in bytes. |
|
||||
| `minio_node_process_starttime_seconds` | Start time for MinIO process per node, time in seconds since Unix epoc. |
|
||||
| `minio_node_process_uptime_seconds` | Uptime for MinIO process per node in seconds. |
|
||||
| `minio_node_process_starttime_seconds` | Start time for Silo process per node, time in seconds since Unix epoc. |
|
||||
| `minio_node_process_uptime_seconds` | Uptime for Silo process per node in seconds. |
|
||||
|
||||
## Scanner Metrics
|
||||
|
||||
@@ -274,17 +274,17 @@ For deployments with [bucket](https://silo.pgsty.com/administration/bucket-repli
|
||||
|
||||
# Bucket Metrics
|
||||
|
||||
MinIO collects the following metrics at the bucket level.
|
||||
Silo collects the following metrics at the bucket level.
|
||||
Each metric includes the ``bucket`` label to identify the corresponding bucket.
|
||||
Metrics may include one or more additional labels, such as the server that calculated that metric.
|
||||
|
||||
These metrics can be obtained from any MinIO server once per collection by using the following URL:
|
||||
These metrics can be obtained from any Silo server once per collection by using the following URL:
|
||||
|
||||
```shell
|
||||
https://HOSTNAME:PORT/minio/v2/metrics/bucket
|
||||
```
|
||||
|
||||
Replace ``HOSTNAME:PORT`` with the hostname of your MinIO deployment.
|
||||
Replace ``HOSTNAME:PORT`` with the hostname of your Silo deployment.
|
||||
For deployments behind a load balancer, use the load balancer hostname instead of a single node hostname.
|
||||
|
||||
## Distribution Metrics
|
||||
@@ -354,17 +354,17 @@ For deployments with [Site Replication](https://silo.pgsty.com/operations/replic
|
||||
|
||||
# Resource Metrics
|
||||
|
||||
MinIO collects the following resource metrics at the node level.
|
||||
Silo collects the following resource metrics at the node level.
|
||||
Each metric includes the `server` label to identify the corresponding node.
|
||||
Metrics may include one or more additional labels, such as the drive path, interface name, etc.
|
||||
|
||||
These metrics can be obtained from any MinIO server once per collection by using the following URL:
|
||||
These metrics can be obtained from any Silo server once per collection by using the following URL:
|
||||
|
||||
```shell
|
||||
https://HOSTNAME:PORT/minio/v2/metrics/resource
|
||||
```
|
||||
|
||||
Replace `HOSTNAME:PORT` with the hostname of your MinIO deployment.
|
||||
Replace `HOSTNAME:PORT` with the hostname of your Silo deployment.
|
||||
For deployments behind a load balancer, use the load balancer hostname instead of a single node hostname.
|
||||
|
||||
## Drive Resource Metrics
|
||||
|
||||
Reference in New Issue
Block a user