diff --git a/manual/administration/seafile_metrics.md b/manual/administration/seafile_metrics.md index 1dd4d1c7..1522ae32 100644 --- a/manual/administration/seafile_metrics.md +++ b/manual/administration/seafile_metrics.md @@ -1,8 +1,7 @@ -# Integrate Seafile Metrics with Third-Party Monitoring Tools -Seafile provides a standardized interface to expose system operational metrics, enabling integration with third-party monitoring tools such as Prometheus and Grafana. +# Monitor Seafile with Prometheus +Seafile provides a standardized interface tailored to expose system operational metrics, enabling seamless integration with Prometheus and Grafana. This allows administrators to real-time monitor Seafile service status, including (but not limited to) I/O queue length and background task latency. - ## Configuration Steps To enable metric monitoring for Seafile, follow these steps: @@ -13,7 +12,7 @@ Edit the Seafile configuration file `seahub_settings.py` (located in the Seafile # Enable the metric exposure function (set to True to activate) ENABLE_METRIC = True -# Authentication username for monitoring tools (e.g., Prometheus) +# Authentication username # Used for HTTP Basic Authentication when accessing Seafile's metric endpoint METRIC_AUTH_USER = "your_prometheus_username" @@ -24,8 +23,8 @@ METRIC_AUTH_PWD = "your_prometheus_password" > **Note**: Replace `your_prometheus_username` and `your_prometheus_password` with custom credentials (recommend using strong, unique passwords for security). -### 2. Configure Third-Party Monitoring Tools -After completing the above Seafile configuration, monitoring tools can retrieve Seafile metrics via the `/metrics` endpoint. Key requirements for tool configuration: +### 2. Configure Prometheus +After completing the above Seafile configuration, Prometheus can retrieve Seafile metrics via the `/metrics` endpoint. Key requirements for such configuration: * Endpoint: Seafile’s metric data is accessible at `http://:/metrics` (replace `` and `` with your Seafile server’s actual IP and port). * Authentication: Use HTTP Basic Authentication and input the `METRIC_AUTH_USER` and `METRIC_AUTH_PWD` configured in Step 1. diff --git a/mkdocs.yml b/mkdocs.yml index 304c03f0..92e96c97 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -188,7 +188,7 @@ nav: - Seafile FSCK: administration/seafile_fsck.md - Seafile GC: administration/seafile_gc.md - Clean database: administration/clean_database.md - - Integrate Seafile Metrics with Third-Party Monitoring Tools: administration/seafile_metrics.md + - Monitor Seafile with Prometheus: administration/seafile_metrics.md - Upgrade: - Outline: upgrade/upgrade.md - Upgrade Seafile Docker: upgrade/upgrade_docker.md