master
yaml 138 lines 4.31 KB
Raw
1 plugin_name: go.d.plugin
2 modules:
3 - meta:
4 id: collector-go.d.plugin-hddtemp
5 plugin_name: go.d.plugin
6 module_name: hddtemp
7 monitored_instance:
8 name: HDD temperature
9 link: https://linux.die.net/man/8/hddtemp
10 categories:
11 - data-collection.storage
12 icon_filename: "hard-drive.svg"
13 related_resources:
14 integrations:
15 list: []
16 info_provided_to_referring_integrations:
17 description: ""
18 keywords:
19 - hardware
20 - hdd temperature
21 - disk temperature
22 - temperature
23 overview:
24 data_collection:
25 metrics_description: |
26 This collector monitors disk temperatures.
27 method_description: |
28 It retrieves temperature data for attached disks by querying the hddtemp daemon at regular intervals.
29 supported_platforms:
30 include:
31 - Linux
32 exclude: []
33 multi_instance: true
34 additional_permissions:
35 description: ""
36 default_behavior:
37 auto_detection:
38 description: By default, this collector will attempt to connect to the `hddtemp` daemon on `127.0.0.1:7634`
39 limits:
40 description: ""
41 performance_impact:
42 description: ""
43 setup:
44 prerequisites:
45 list:
46 - title: Install hddtemp
47 description: |
48 Install `hddtemp` using your distribution's package manager.
49 configuration:
50 file:
51 name: go.d/hddtemp.conf
52 options:
53 description: |
54 The following options can be defined globally: update_every, autodetection_retry.
55 folding:
56 title: Config options
57 enabled: true
58 list:
59 - name: update_every
60 description: Data collection interval (seconds).
61 default_value: 1
62 required: false
63 group: Collection
64 - name: autodetection_retry
65 description: Autodetection retry interval (seconds). Set 0 to disable.
66 default_value: 0
67 required: false
68 group: Collection
69
70 - name: address
71 description: hddtemp server address (`IP:PORT`).
72 default_value: 127.0.0.1:7634
73 required: true
74 group: Target
75 - name: timeout
76 description: Connection, read, write, and name resolution timeout (seconds).
77 default_value: 1
78 required: false
79 group: Target
80 examples:
81 folding:
82 title: Config
83 enabled: true
84 list:
85 - name: Basic
86 description: A basic example configuration.
87 config: |
88 jobs:
89 - name: local
90 address: 127.0.0.1:7634
91 - name: Multi-instance
92 description: |
93 > **Note**: When you define multiple jobs, their names must be unique.
94
95 Collecting metrics from local and remote instances.
96 config: |
97 jobs:
98 - name: local
99 address: 127.0.0.1:7634
100
101 - name: remote
102 address: 203.0.113.0:7634
103 troubleshooting:
104 problems:
105 list: []
106 alerts: []
107 metrics:
108 folding:
109 title: Metrics
110 enabled: false
111 description: ""
112 availability: []
113 scopes:
114 - name: disk
115 description: These metrics refer to the Disk.
116 labels:
117 - name: disk_id
118 description: Disk identifier. It is derived from the device path (e.g. sda or ata-HUP722020APA330_BFJ0WS3F)
119 - name: model
120 description: Disk model
121 metrics:
122 - name: hddtemp.disk_temperature
123 description: Disk temperature
124 unit: Celsius
125 chart_type: line
126 dimensions:
127 - name: temperature
128 - name: hddtemp.disk_temperature_sensor_status
129 description: Disk temperature sensor status
130 unit: status
131 chart_type: line
132 dimensions:
133 - name: ok
134 - name: err
135 - name: na
136 - name: unk
137 - name: nos
138 - name: slp