diff options
Diffstat (limited to 'src/go/collectors/go.d.plugin/modules')
| l--------- | src/go/collectors/go.d.plugin/modules/hddtemp/README.md | 1 | ||||
| -rw-r--r-- | src/go/collectors/go.d.plugin/modules/hddtemp/integrations/hdd_temperature.md | 189 |
2 files changed, 190 insertions, 0 deletions
diff --git a/src/go/collectors/go.d.plugin/modules/hddtemp/README.md b/src/go/collectors/go.d.plugin/modules/hddtemp/README.md new file mode 120000 index 0000000000..95c7593f80 --- /dev/null +++ b/src/go/collectors/go.d.plugin/modules/hddtemp/README.md @@ -0,0 +1 @@ +integrations/hdd_temperature.md
\ No newline at end of file diff --git a/src/go/collectors/go.d.plugin/modules/hddtemp/integrations/hdd_temperature.md b/src/go/collectors/go.d.plugin/modules/hddtemp/integrations/hdd_temperature.md new file mode 100644 index 0000000000..f0f272bdbc --- /dev/null +++ b/src/go/collectors/go.d.plugin/modules/hddtemp/integrations/hdd_temperature.md @@ -0,0 +1,189 @@ +<!--startmeta +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/hddtemp/README.md" +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/hddtemp/metadata.yaml" +sidebar_label: "HDD temperature" +learn_status: "Published" +learn_rel_path: "Collecting Metrics/Hardware Devices and Sensors" +most_popular: False +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" +endmeta--> + +# HDD temperature + + +<img src="https://netdata.cloud/img/hard-drive.svg" width="150"/> + + +Plugin: go.d.plugin +Module: hddtemp + +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> + +## Overview + +This collector monitors disk temperatures. + + +It retrieves temperature data for attached disks by querying the hddtemp daemon at regular intervals. + + +This collector is only supported on the following platforms: + +- Linux + +This collector supports collecting metrics from multiple instances of this integration, including remote instances. + + +### Default Behavior + +#### Auto-Detection + +By default, this collector will attempt to connect to the `hddtemp` daemon on `127.0.0.1:7634` + +#### Limits + +The default configuration for this integration does not impose any limits on data collection. + +#### Performance Impact + +The default configuration for this integration is not expected to impose a significant performance impact on the system. + + +## Metrics + +Metrics grouped by *scope*. + +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. + + + +### Per disk + +These metrics refer to the Disk. + +Labels: + +| Label | Description | +|:-----------|:----------------| +| disk_id | Disk identifier. It is derived from the device path (e.g. sda or ata-HUP722020APA330_BFJ0WS3F) | +| model | Disk model | + +Metrics: + +| Metric | Dimensions | Unit | +|:------|:----------|:----| +| hddtemp.disk_temperature | temperature | Celsius | +| hddtemp.disk_temperature_sensor_status | ok, err, na, unk, nos, slp | status | + + + +## Alerts + +There are no alerts configured by default for this integration. + + +## Setup + +### Prerequisites + +#### Install hddtemp + +Install `hddtemp` using your distribution's package manager. + + + +### Configuration + +#### File + +The configuration file name for this integration is `go.d/hddtemp.conf`. + + +You can edit the configuration file using the `edit-config` script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory). + +```bash +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata +sudo ./edit-config go.d/hddtemp.conf +``` +#### Options + +The following options can be defined globally: update_every, autodetection_retry. + + +<details><summary>Config options</summary> + +| Name | Description | Default | Required | +|:----|:-----------|:-------|:--------:| +| update_every | Data collection frequency. | 1 | no | +| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | +| address | The IP address and port where the hddtemp daemon listens for connections. | 127.0.0.1:7634 | yes | +| timeout | Connection, read, and write timeout duration in seconds. The timeout includes name resolution. | 1 | no | + +</details> + +#### Examples + +##### Basic + +A basic example configuration. + +<details><summary>Config</summary> + +```yaml +jobs: + - name: local + address: 127.0.0.1:7634 + +``` +</details> + +##### Multi-instance + +> **Note**: When you define multiple jobs, their names must be unique. + +Collecting metrics from local and remote instances. + + +<details><summary>Config</summary> + +```yaml +jobs: + - name: local + address: 127.0.0.1:7634 + + - name: remote + address: 203.0.113.0:7634 + +``` +</details> + + + +## Troubleshooting + +### Debug Mode + +To troubleshoot issues with the `hddtemp` collector, run the `go.d.plugin` with the debug option enabled. The output +should give you clues as to why the collector isn't working. + +- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on + your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. + + ```bash + cd /usr/libexec/netdata/plugins.d/ + ``` + +- Switch to the `netdata` user. + + ```bash + sudo -u netdata -s + ``` + +- Run the `go.d.plugin` to debug the collector: + + ```bash + ./go.d.plugin -d -m hddtemp + ``` + + |