From 911814cadbf772a4697e245e4240952a288634d4 Mon Sep 17 00:00:00 2001 From: Xuhui Zhu Date: Thu, 6 Jun 2024 09:18:17 -0400 Subject: [PATCH] Update README for smartctl exporter integration (#257) --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c8aa7134..57abdf93 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,12 @@ Use links instead. ## Overview [Charmhub Page](https://charmhub.io/hardware-observer) -Hardware-observer is a [subordinate machine charm](https://juju.is/docs/sdk/charm-taxonomy#heading--subordinate-charms) that provides monitoring and alerting of hardware resources on bare-metal infrastructure. +Hardware-observer is a [subordinate machine charm](https://juju.is/docs/sdk/charm-taxonomy#heading--subordinate-charms) that provides monitoring and alerting of hardware resources on bare-metal infrastructure. This charm leverages the following exporters to provide detailed metrics: +- **Prometheus Hardware Exporter**: For collecting metrics from BMCs and RAID controllers. +- **Smartctl Exporter**: For collecting SMART metrics from storage devices. + +### Prometheus Hardware Exporter Hardware-observer collects and exports Prometheus metrics from BMCs (using the IPMI and newer Redfish protocols) and various SAS and RAID controllers through the use of the [prometheus-hardware-exporter](https://github.com/canonical/prometheus-hardware-exporter) project. It additionally configures Prometheus alert rules that are fired when the status of any metric is suboptimal. Appropriate collectors and alert rules are installed based on the availability of one or more of the RAID/SAS controllers mentioned below: @@ -27,6 +31,9 @@ Appropriate collectors and alert rules are installed based on the availability o - LSI SAS-3 controller - HPE Smart Array controller +### Smartctl Exporter +The Smartctl Exporter integrates with the Hardware-observer to provide monitoring of storage device health via SMART data. Metrics are collected and exported to Prometheus using the [smartctl-exporter](https://github.com/prometheus-community/smartctl_exporter). + This charm is ideal for monitoring hardware resources when used in conjunction with the [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack). ## Uploading Resources