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

plugin_name: python.d.plugin
modules:
  - meta:
      plugin_name: python.d.plugin
      module_name: w1sensor
      monitored_instance:
        name: 1-Wire Sensors
        link: "https://www.analog.com/en/product-category/1wire-temperature-sensors.html"
        categories:
          - data-collection.hardware-devices-and-sensors
        icon_filename: "1-wire.png"
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      keywords:
        - temperature
        - sensor
        - 1-wire
      most_popular: false
    overview:
      data_collection:
        metrics_description: "Monitor 1-Wire Sensors metrics with Netdata for optimal environmental conditions monitoring. Enhance your environmental monitoring with real-time insights and alerts."
        method_description: "The collector uses the wire, w1_gpio, and w1_therm kernel modules. Currently temperature sensors are supported and automatically detected."
      supported_platforms:
        include:
          - Linux
        exclude: []
      multi_instance: true
      additional_permissions:
        description: ""
      default_behavior:
        auto_detection:
          description: "The collector will try to auto detect available 1-Wire devices."
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list:
          - title: "Required Linux kernel modules"
            description: "Make sure `wire`, `w1_gpio`, and `w1_therm` kernel modules are loaded."
      configuration:
        file:
          name: python.d/w1sensor.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.
          folding:
            title: "Config options"
            enabled: true
          list:
            - name: update_every
              description: Sets the default data collection frequency.
              default_value: 5
              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: ""
              required: false
            - name: name_<1-Wire id>
              description: This allows associating a human readable name with a sensor's 1-Wire identifier.
              default_value: ""
              required: false
        examples:
          folding:
            enabled: false
            title: "Config"
          list:
            - name: Provide human readable names
              description: Associate two 1-Wire identifiers with human readable names.
              config: |
                sensors:
                 name_00000022276e: 'Machine room'
                 name_00000022298f: 'Rack 12'
    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: w1sensor.temp
              description: 1-Wire Temperature Sensor
              unit: "Celsius"
              chart_type: line
              dimensions:
                - name: a dimension per sensor