> For the complete documentation index, see [llms.txt](https://docs.weka.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.weka.io/monitor-the-weka-cluster/the-wekaio-support-cloud/export-cluster-metrics-to-prometheus.md). # Export cluster metrics from LWH to Prometheus ## Export cluster metrics from LWH to Prometheus Local WEKA Home (LWH) exposes WEKA cluster metrics as Prometheus scrape endpoints. Configure your Prometheus server to scrape these endpoints and receive metrics in Prometheus format. For LWH access details, see [Local WEKA Home overview](/monitor-the-weka-cluster/the-wekaio-support-cloud/local-weka-home-overview.md). Use the exporter to build alerts on cluster health, track I/O performance and latency, monitor drive health, or visualize metrics in Grafana through Prometheus. ### Prometheus Exporter V2 {% hint style="warning" %} Starting with LWH 5.0, Prometheus Exporter V2 is the supported version. V1 is deprecated: it remains functional for existing configurations, but new V1 tokens cannot be generated. V1 is removed in a future release. {% endhint %} If you use the V1 exporter, move to V2. Settings do not transfer automatically. Moving to V2 requires the following updates: 1. Generate a V2 token and update the Prometheus scrape configuration. 2. Review queries and alerts. Metric names, types, and label structures differ in V2. 3. Update Grafana dashboards and other visualization tools that use V1 metric names. ### Enable the Prometheus Exporter for a cluster Access to the scrape endpoints is protected by token-based authentication. Each request to an endpoint must include a valid token in the Authorization header. Unauthenticated requests are rejected. Each cluster has one active token. The token authenticates all four scrape endpoints. **Before you begin** * Ensure you have access to LWH and the cluster you want to monitor. * Have a secure password manager or secrets vault ready to store the token. The token is shown only once. If you lose it, you must generate a new one. **Procedure** 1. In LWH, open the cluster and select the **Prometheus Exporter** tab.
2. Select **Generate Token**.\ The page displays the exporter URLs for the cluster.
3. In the **Prometheus Exporter URL v2** section, copy the endpoint URLs you intend to scrape using the copy icon next to each. Each endpoint covers a distinct area of cluster telemetry: * **Base URL**: cluster health, capacity, and S3 metrics. * **/clients**: per-client and per-filesystem I/O metrics. * **/drives**: per-drive health, I/O, and network metrics. * **/quota\_domains**: per-quota-domain I/O metrics. 4. To get the full list of available metrics, categories, and collections, select **Download YAML** under **Metric Reference**. {% hint style="info" %} Each cluster supports one active token. Generating a new token immediately invalidates the previous one. Update your Prometheus configuration with the new token as soon as possible to avoid a gap in metric collection. {% endhint %} ### Configure Prometheus Configure Prometheus to scrape metrics from LWH by adding one scrape job per endpoint. Each job authenticates using a Bearer token and targets the LWH hostname. **Before you begin** Obtain the following from the LWH token dialog: * The authentication token * The full URL for each endpoint you want to scrape (hostname and path) **Procedure** 1. Open your Prometheus configuration file. 2. Under `scrape_configs`, add one job block for each endpoint you want to collect. 3. In each job, set the following values: * `metrics_path`: the path portion of the endpoint URL copied from the token dialog * `targets`: the hostname portion of the URL from the cluster settings * `credentials`: your authentication token 4. Save the configuration file and reload Prometheus. **Example: scrape all four endpoints** {% code title="prometheus.yaml" %} ```yaml ... scrape_configs: - job_name: weka_cluster metrics_path: scheme: https authorization: credentials: static_configs: - targets: [''] - job_name: weka_clients metrics_path: /clients scheme: https authorization: credentials: static_configs: - targets: [''] - job_name: weka_drives metrics_path: /drives scheme: https authorization: credentials: static_configs: - targets: [''] - job_name: weka_quota_domains metrics_path: /quota_domains scheme: https authorization: credentials: static_configs: - targets: [''] ``` {% endcode %} Replace the placeholders with your values:
PlaceholderValue
<lwh-host>LWH hostname from the cluster settings URL
<base-url>Path portion of the endpoint URL from the token dialog
<your-token>Authentication token from the token dialog
### Selective metric collection Limit the exported metrics for this job. See [Configure selective Prometheus metric collection](/monitor-the-weka-cluster/the-wekaio-support-cloud/configure-selective-prometheus-metric-collection.md). ### Grafana dashboards Grafana dashboards are available from **Grafana Dashboards** in LWH **Settings**. Each dashboard provides default panels and imports directly into your Grafana instance. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.weka.io/monitor-the-weka-cluster/the-wekaio-support-cloud/export-cluster-metrics-to-prometheus.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.