mirror of
https://github.com/pgsty/minio.git
synced 2026-08-10 00:03:29 +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,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": ""
|
||||
|
||||
Reference in New Issue
Block a user