Skip to content

docs: add new metric naming to docs #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rickstaa wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add new metric naming to docs #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 69 additions & 60 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,19 @@

Collects metrics from [liquidctl][1] supported devices and presents them for scraping


Example [Grafana][4] dashboard

![image info](./example.png)

## Usage

### Requirenments:
### Requirements:

- [liquidctl][1] is installed with support of JSON output (v1.6.x+)
- Golang if building on the same system
- Golang if building on the same system

### Build and installation on Linux:

```shell
# Clone the repository
git clone https://github.com/paha/liquidctl-exporter
Expand Down Expand Up @@ -48,30 +49,22 @@ curl http://localhost:9530/metrics | grep liquidctl
```

### Configuration

Prometheus exporter _port_, update _interval_ and _path_ to `liquidctl` can be set via environment variables:

| Variable | Description | Default |
| :--- | :---- | ---: |
| `LIQUIDCTL_EXPORTER_PORT` | Exporter port. RE: [port allocations][3] | 9530 |
| `LIQUIDCTL_EXPORTER_INTERVAL` | Update interval | 10 seconds |
| `LIQUIDCTL_EXPORTER_PATH` | Path to `liquidctl` | `/usr/local/bin/liquidctl` |
| Variable | Description | Default |
| :---------------------------- | :--------------------------------------- | -------------------------: |
| `LIQUIDCTL_EXPORTER_PORT` | Exporter port. RE: [port allocations][3] | 9530 |
| `LIQUIDCTL_EXPORTER_INTERVAL` | Update interval | 10 seconds |
| `LIQUIDCTL_EXPORTER_PATH` | Path to `liquidctl` | `/usr/local/bin/liquidctl` |

### Windows and MacOS support

Should work on Windows and MacOS as long as the proper path to the liquidctl excutable is set. _Not tested on either Windows or Mac however._

---
### TODO

- better metrics naming and labeling
- Containerized builds and delivery
- Releases, CI, container images hosting
- test on Windows and MacOS
---
Should work on Windows and MacOS as long as the proper path to the liquidctl executable is set. _Not tested on either Windows or Mac however._

### Docker container

The repository also contains a Dockerfile for building a container image. The image is not yet published to a registry, but can be built locally using the following docker compose file:
The repository also contains a Dockerfile for building a container image. The image is not yet published to a registry but can be build locally using the following docker compose file:

```shell
version: "3.8"
Expand All @@ -90,56 +83,72 @@ services:
```

> [!NOTE]\
> The container needs to be run in privileged mode to be able to access the USB devices.
> The container needs to be run in privileged mode to access the USB devices.

## Examples

Metrics exposed with a single Corsair Commander Pro device:
Metrics exposed with a single Corsair HX1200I device:

```shell
# HELP liquidctl_hidraw0_12_volt_rail Corsair Commander Pro 12 volt rail (V).
# TYPE liquidctl_hidraw0_12_volt_rail gauge
liquidctl_hidraw0_12_volt_rail 11.991
# HELP liquidctl_hidraw0_33_volt_rail Corsair Commander Pro 3.3 volt rail (V).
# TYPE liquidctl_hidraw0_33_volt_rail gauge
liquidctl_hidraw0_33_volt_rail 3.341
# HELP liquidctl_hidraw0_5_volt_rail Corsair Commander Pro 5 volt rail (V).
# TYPE liquidctl_hidraw0_5_volt_rail gauge
liquidctl_hidraw0_5_volt_rail 4.968
# HELP liquidctl_hidraw0_fan_1_speed Corsair Commander Pro Fan 1 speed (rpm).
# TYPE liquidctl_hidraw0_fan_1_speed gauge
liquidctl_hidraw0_fan_1_speed 2419
# HELP liquidctl_hidraw0_fan_2_speed Corsair Commander Pro Fan 2 speed (rpm).
# TYPE liquidctl_hidraw0_fan_2_speed gauge
liquidctl_hidraw0_fan_2_speed 0
# HELP liquidctl_hidraw0_fan_3_speed Corsair Commander Pro Fan 3 speed (rpm).
# TYPE liquidctl_hidraw0_fan_3_speed gauge
liquidctl_hidraw0_fan_3_speed 4819
# HELP liquidctl_hidraw0_fan_4_speed Corsair Commander Pro Fan 4 speed (rpm).
# TYPE liquidctl_hidraw0_fan_4_speed gauge
liquidctl_hidraw0_fan_4_speed 0
# HELP liquidctl_hidraw0_fan_5_speed Corsair Commander Pro Fan 5 speed (rpm).
# TYPE liquidctl_hidraw0_fan_5_speed gauge
liquidctl_hidraw0_fan_5_speed 2419
# HELP liquidctl_hidraw0_fan_6_speed Corsair Commander Pro Fan 6 speed (rpm).
# TYPE liquidctl_hidraw0_fan_6_speed gauge
liquidctl_hidraw0_fan_6_speed 2580
# HELP liquidctl_hidraw0_temp_sensor_1 Corsair Commander Pro Temp sensor 1 (°C).
# TYPE liquidctl_hidraw0_temp_sensor_1 gauge
liquidctl_hidraw0_temp_sensor_1 47.94
# HELP liquidctl_hidraw0_temp_sensor_2 Corsair Commander Pro Temp sensor 2 (°C).
# TYPE liquidctl_hidraw0_temp_sensor_2 gauge
liquidctl_hidraw0_temp_sensor_2 0
# HELP liquidctl_hidraw0_temp_sensor_3 Corsair Commander Pro Temp sensor 3 (°C).
# TYPE liquidctl_hidraw0_temp_sensor_3 gauge
liquidctl_hidraw0_temp_sensor_3 0
# HELP liquidctl_hidraw0_temp_sensor_4 Corsair Commander Pro Temp sensor 4 (°C).
# TYPE liquidctl_hidraw0_temp_sensor_4 gauge
liquidctl_hidraw0_temp_sensor_4 0
# HELP liquidctl_12v_output_current Corsair HX1200i +12V output current (A).
# TYPE liquidctl_12v_output_current gauge
liquidctl_12v_output_current{device="hidraw4"} 4
# HELP liquidctl_12v_output_power Corsair HX1200i +12V output power (W).
# TYPE liquidctl_12v_output_power gauge
liquidctl_12v_output_power{device="hidraw4"} 48
# HELP liquidctl_12v_output_voltage Corsair HX1200i +12V output voltage (V).
# TYPE liquidctl_12v_output_voltage gauge
liquidctl_12v_output_voltage{device="hidraw4"} 12.093
# HELP liquidctl_33v_output_current Corsair HX1200i +3.3V output current (A).
# TYPE liquidctl_33v_output_current gauge
liquidctl_33v_output_current{device="hidraw4"} 3.5620000000000003
# HELP liquidctl_33v_output_power Corsair HX1200i +3.3V output power (W).
# TYPE liquidctl_33v_output_power gauge
liquidctl_33v_output_power{device="hidraw4"} 11
# HELP liquidctl_33v_output_voltage Corsair HX1200i +3.3V output voltage (V).
# TYPE liquidctl_33v_output_voltage gauge
liquidctl_33v_output_voltage{device="hidraw4"} 3.265
# HELP liquidctl_5v_output_current Corsair HX1200i +5V output current (A).
# TYPE liquidctl_5v_output_current gauge
liquidctl_5v_output_current{device="hidraw4"} 2.125
# HELP liquidctl_5v_output_power Corsair HX1200i +5V output power (W).
# TYPE liquidctl_5v_output_power gauge
liquidctl_5v_output_power{device="hidraw4"} 10.5
# HELP liquidctl_5v_output_voltage Corsair HX1200i +5V output voltage (V).
# TYPE liquidctl_5v_output_voltage gauge
liquidctl_5v_output_voltage{device="hidraw4"} 4.953
# HELP liquidctl_case_temperature Corsair HX1200i Case temperature (°C).
# TYPE liquidctl_case_temperature gauge
liquidctl_case_temperature{device="hidraw4"} 39.75
# HELP liquidctl_estimated_efficiency Corsair HX1200i Estimated efficiency (%).
# TYPE liquidctl_estimated_efficiency gauge
liquidctl_estimated_efficiency{device="hidraw4"} 81
# HELP liquidctl_estimated_input_power Corsair HX1200i Estimated input power (W).
# TYPE liquidctl_estimated_input_power gauge
liquidctl_estimated_input_power{device="hidraw4"} 84
# HELP liquidctl_fan_speed Corsair HX1200i Fan speed (rpm).
# TYPE liquidctl_fan_speed gauge
liquidctl_fan_speed{device="hidraw4"} 0
# HELP liquidctl_input_voltage Corsair HX1200i Input voltage (V).
# TYPE liquidctl_input_voltage gauge
liquidctl_input_voltage{device="hidraw4"} 230
# HELP liquidctl_total_power_output Corsair HX1200i Total power output (W).
# TYPE liquidctl_total_power_output gauge
liquidctl_total_power_output{device="hidraw4"} 68
# HELP liquidctl_vrm_temperature Corsair HX1200i VRM temperature (°C).
# TYPE liquidctl_vrm_temperature gauge
liquidctl_vrm_temperature{device="hidraw4"} 52
```

---

### TODO

- Releases, CI, container images hosting
- test on Windows and MacOS

---

[1]: https://github.com/liquidctl/liquidctl
[2]: https://prometheus.io/
[3]: https://github.com/prometheus/prometheus/wiki/Default-port-allocations
Expand Down