summaryrefslogtreecommitdiffstats
path: root/src/go/plugin/go.d/modules/sensors/metadata.yaml
blob: 5ea94f3982eacc3fc09a5ab6581634c17d6de851 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
plugin_name: go.d.plugin
modules:
  - meta:
      id: collector-go.d.plugin-sensors
      plugin_name: go.d.plugin
      module_name: sensors
      monitored_instance:
        name: Linux Sensors (lm-sensors)
        link: https://hwmon.wiki.kernel.org/lm_sensors
        icon_filename: "microchip.svg"
        categories:
          - data-collection.hardware-devices-and-sensors
      keywords:
        - sensors
        - temperature
        - voltage
        - current
        - power
        - fan
        - energy
        - humidity
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      most_popular: false
    overview:
      data_collection:
        metrics_description: >
          This collector gathers real-time system sensor statistics, 
          including temperature, voltage, current, power, fan speed, energy consumption, and humidity, 
          utilizing the [sensors](https://linux.die.net/man/1/sensors) binary.
        method_description: ""
      supported_platforms:
        include: []
        exclude: []
      multi_instance: false
      additional_permissions:
        description: ""
      default_behavior:
        auto_detection:
          description: |
            The following type of sensors are auto-detected:

            - temperature
            - fan
            - voltage
            - current
            - power
            - energy
            - humidity
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list:
          - title: Install lm-sensors
            description: |
              - Install `lm-sensors` using your distribution's package manager.
              - Run `sensors-detect` to detect hardware monitoring chips.
      configuration:
        file:
          name: go.d/sensors.conf
        options:
          description: |
            The following options can be defined globally: update_every.
          folding:
            title: Config options
            enabled: true
          list:
            - name: update_every
              description: Data collection frequency.
              default_value: 10
              required: false
            - name: binary_path
              description: Path to the `sensors` binary. If an absolute path is provided, the collector will use it directly; otherwise, it will search for the binary in directories specified in the PATH environment variable.
              default_value: /usr/bin/sensors
              required: true
            - name: timeout
              description: Timeout for executing the binary, specified in seconds.
              default_value: 2
              required: false
        examples:
          folding:
            title: Config
            enabled: true
          list:
            - name: Custom binary path
              description: The executable is not in the directories specified in the PATH environment variable.
              config: |
                jobs:
                  - name: sensors
                    binary_path: /usr/local/sbin/sensors
    troubleshooting:
      problems:
        list: []
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: sensor
          description: These metrics refer to the sensor.
          labels:
            - name: chip
              description: The hardware component responsible for the sensor monitoring.
            - name: feature
              description: The specific sensor or monitoring point provided by the chip.
          metrics:
            - name: sensors.sensor_temperature
              description: Sensor temperature
              unit: Celsius
              chart_type: line
              dimensions:
                - name: temperature
            - name: sensors.sensor_voltage
              description: Sensor voltage
              unit: Volts
              chart_type: line
              dimensions:
                - name: voltage
            - name: sensors.sensor_current
              description: Sensor current
              unit: Amperes
              chart_type: line
              dimensions:
                - name: current
            - name: sensors.sensor_power
              description: Sensor power
              unit: Watts
              chart_type: line
              dimensions:
                - name: power
            - name: sensors.sensor_fan_speed
              description: Sensor fan speed
              unit: RPM
              chart_type: line
              dimensions:
                - name: fan
            - name: sensors.sensor_energy
              description: Sensor energy
              unit: Joules
              chart_type: line
              dimensions:
                - name: energy
            - name: sensors.sensor_humidity
              description: Sensor humidity
              unit: percent
              chart_type: area
              dimensions:
                - name: humidity