astelm/minio
1
0
Fork 0
mirror of https://github.com/pgsty/minio.git synced 2026-08-09 15:53:28 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: rebrand the repository documentation, templates and dashboards

Browse Source 
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
2026-08-06 08:49:30 +08:00
parent 6613c2a3cb
commit fd2ca1c6d2
94 changed files with 1613 additions and 1347 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/metrics/v3.md
+17 -15
View File
@@ -11,7 +11,9 @@ Querying the base endpoint returns "404 Not Found."
Metrics are organized into groups at paths **relative** to the top-level endpoint above.
Metrics are also available using the [MinIO Admin Client](https://min.io/docs/minio/linux/reference/minio-mc-admin.html) and the `mc admin prometheus metrics` command. For more information, see [Metrics and Alerts](https://min.io/docs/minio/linux/operations/monitoring/metrics-and-alerts.html) in the MinIO Documentation.
Metrics are also available through the compatible client with
`mc admin prometheus metrics`. See the [Silo documentation](https://silo.pgsty.com/docs/)
for current monitoring guidance.
## Metrics Request Handling
@@ -29,7 +31,7 @@ For example, to query API metrics for buckets `test1` and `test2`, make a scrape
### List Available Metrics
Instead of a metrics scrape, you can list the metrics that would be returned by a path by adding a `list` query parameter. The MinIO server then lists all available metrics that could be returned. Note that during an actual metrics scrape only metrics with available _values_ are returned. Metrics with null values are omitted from the scrape results.
Instead of a metrics scrape, you can list the metrics that would be returned by a path by adding a `list` query parameter. The Silo server then lists all available metrics that could be returned. Note that during an actual metrics scrape only metrics with available _values_ are returned. Metrics with null values are omitted from the scrape results.
To set the output format, set the request `Content-Type` to the desired format. Accepted values are `application/json` for JSON output or `text/plain` for a Markdown-formatted table. The default is Markdown.
@@ -86,7 +88,7 @@ Metrics about requests served by the current node.
### Audit metrics
Metrics about the MinIO audit functionality.
Metrics about the Silo audit functionality.
| Path | Description |
|----------|-----------------------------------------|
@@ -102,7 +104,7 @@ Metrics about the MinIO audit functionality.
### Cluster metrics
Metrics about an entire MinIO cluster.
Metrics about an entire Silo cluster.
| Path | Description |
|--------------------------|--------------------------------|
@@ -201,7 +203,7 @@ Standard Go runtime metrics from the [Prometheus Go Client base collector](https
### ILM metrics
Metrics about the MinIO ILM functionality.
Metrics about the Silo ILM functionality.
| Path | Description |
|--------|---------------------------------------|
@@ -219,7 +221,7 @@ Metrics about the MinIO ILM functionality.
### Logger webhook metrics
Metrics about MinIO logger webhooks.
Metrics about Silo logger webhooks.
| Path | Description |
|-------------------|-------------------------------------|
@@ -235,7 +237,7 @@ Metrics about MinIO logger webhooks.
### Notification metrics
Metrics about the MinIO notification functionality.
Metrics about the Silo notification functionality.
| Path | Description |
|-----------------|------------------------------------------------|
@@ -252,7 +254,7 @@ Metrics about the MinIO notification functionality.
### Replication metrics
Metrics about MinIO site and bucket replication.
Metrics about Silo site and bucket replication.
| Path | Description |
|-----------------------|----------------------------------------|
@@ -302,11 +304,11 @@ Metrics about MinIO site and bucket replication.
### Scanner metrics
Metrics about the MinIO scanner.
Metrics about the Silo scanner.
| Path | Description |
|------------|---------------------------------------|
| `/scanner` | Metrics related to the MinIO scanner. |
| `/scanner` | Metrics related to the Silo scanner. |
#### `/scanner`
@@ -321,7 +323,7 @@ Metrics about the MinIO scanner.
### System metrics
Metrics about the MinIO process and the node.
Metrics about the Silo process and the node.
| Path | Description |
|-----------------------------|----------------------------------------------------|
@@ -406,10 +408,10 @@ Metrics about the MinIO process and the node.
| `minio_system_process_io_read_bytes` | Total bytes read by the process from the underlying storage system, /proc/[pid]/io read_bytes. <br><br>Type: counter | `server` |
| `minio_system_process_io_wchar_bytes` | Total bytes written by the process to the underlying storage system including page cache, /proc/[pid]/io wchar. <br><br>Type: counter | `server` |
| `minio_system_process_io_write_bytes` | Total bytes written by the process to the underlying storage system, /proc/[pid]/io write_bytes. <br><br>Type: counter | `server` |
| `minio_system_process_start_time_seconds` | Start time for MinIO process in seconds since Unix epoch. <br><br>Type: gauge | `server` |
| `minio_system_process_uptime_seconds` | Uptime for MinIO process in seconds. <br><br>Type: gauge | `server` |
| `minio_system_process_file_descriptor_limit_total` | Limit on total number of open file descriptors for the MinIO Server process. <br><br>Type: gauge | `server` |
| `minio_system_process_file_descriptor_open_total` | Total number of open file descriptors by the MinIO Server process. <br><br>Type: gauge | `server` |
| `minio_system_process_start_time_seconds` | Start time for Silo process in seconds since Unix epoch. <br><br>Type: gauge | `server` |
| `minio_system_process_uptime_seconds` | Uptime for Silo process in seconds. <br><br>Type: gauge | `server` |
| `minio_system_process_file_descriptor_limit_total` | Limit on total number of open file descriptors for the Silo Server process. <br><br>Type: gauge | `server` |
| `minio_system_process_file_descriptor_open_total` | Total number of open file descriptors by the Silo Server process. <br><br>Type: gauge | `server` |
| `minio_system_process_syscall_read_total` | Total read SysCalls to the kernel. /proc/[pid]/io syscr. <br><br>Type: counter | `server` |
| `minio_system_process_syscall_write_total` | Total write SysCalls to the kernel. /proc/[pid]/io syscw. <br><br>Type: counter | `server` |
| `minio_system_process_resident_memory_bytes` | Resident memory size in bytes. <br><br>Type: gauge | `server` |