netdata/collectors/python.d.plugin/hddtemp/metadata.yaml

plugin_name: python.d.plugin
modules:
  - meta:
      plugin_name: python.d.plugin
      module_name: hddtemp
      monitored_instance:
        name: HDD temperature
        link: https://linux.die.net/man/8/hddtemp
        categories:
          - data-collection.hardware-devices-and-sensors
        icon_filename: "hard-drive.svg"
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      keywords:
        - hardware
        - hdd temperature
        - disk temperature
        - temperature
      most_popular: false
    overview:
      data_collection:
        metrics_description: |
          This collector monitors disk temperatures.
        method_description: |
          It uses the `hddtemp` daemon to gather the metrics.
      supported_platforms:
        include:
          - Linux
        exclude: []
      multi_instance: true
      additional_permissions:
        description: ""
      default_behavior:
        auto_detection:
          description: By default, this collector will attempt to connect to the `hddtemp` daemon on `127.0.0.1:7634`
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list:
          - title: Run `hddtemp` in daemon mode
            description: |
              You can execute `hddtemp` in TCP/IP daemon mode by using the `-d` argument.
              
              So running `hddtemp -d` would run the daemon, by default on port 7634.
      configuration:
        file:
          name: "python.d/hddtemp.conf"
        options:
          description: |
            There are 2 sections:
            
            * Global variables
            * One or more JOBS that can define multiple different instances to monitor.
            
            The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
            
            Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
            
            Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
            
            By default this collector will try to autodetect disks (autodetection works only for disk which names start with "sd"). However this can be overridden by setting the option `disks` to an array of desired disks.
          folding:
            title: "Config options"
            enabled: true
          list:
            - name: update_every
              description: Sets the default data collection frequency.
              default_value: 1
              required: false
            - name: priority
              description: Controls the order of charts at the netdata dashboard.
              default_value: 60000
              required: false
            - name: autodetection_retry
              description: Sets the job re-check interval in seconds.
              default_value: 0
              required: false
            - name: penalty
              description: Indicates whether to apply penalty to update_every in case of failures.
              default_value: yes
              required: false
            - name: name
              description: >
                Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
              default_value: "local"
              required: false
            - name: devices
              description: Array of desired disks to detect, in case their name doesn't start with `sd`.
              default_value: ""
              required: false
            - name: host
              description: The IP or HOSTNAME to connect to.
              default_value: "localhost"
              required: true
            - name: port
              description: The port to connect to.
              default_value: 7634
              required: false
        examples:
          folding:
            enabled: true
            title: "Config"
          list:
            - name: Basic
              description: A basic example configuration.
              folding:
                enabled: false
              config: |
                localhost:
                  name: 'local'
                  host: '127.0.0.1'
                  port: 7634
            - name: Custom disk names
              description: An example defining the disk names to detect.
              config: |
                localhost:
                  name: 'local'
                  host: '127.0.0.1'
                  port: 7634
                  devices:
                    - customdisk1
                    - customdisk2
            - name: Multi-instance
              description: |
                > **Note**: When you define multiple jobs, their names must be unique.
                
                Collecting metrics from local and remote instances.
              config: |
                localhost:
                  name: 'local'
                  host: '127.0.0.1'
                  port: 7634
                
                remote_job:
                  name : 'remote'
                  host  : 'http://192.0.2.1:2812'
    troubleshooting:
      problems:
        list: []
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: global
          description: "These metrics refer to the entire monitored application."
          labels: []
          metrics:
            - name: hddtemp.temperatures
              description: Disk Temperatures
              unit: "Celsius"
              chart_type: line
              dimensions:
                - name: a dimension per disk