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

plugin_name: python.d.plugin
modules:
  - meta:
      plugin_name: python.d.plugin
      module_name: adaptec_raid
      monitored_instance:
        name: AdaptecRAID
        link: "https://www.microchip.com/en-us/products/storage"
        categories:
          - data-collection.storage-mount-points-and-filesystems
        icon_filename: "adaptec.svg"
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      keywords:
        - storage
        - raid-controller
        - manage-disks
      most_popular: false
    overview:
      data_collection:
        metrics_description: |
          This collector monitors Adaptec RAID hardware storage controller metrics about both physical and logical drives.
        method_description: |
          It uses the arcconf command line utility (from adaptec) to monitor your raid controller.
          
          Executed commands:
            - sudo -n arcconf GETCONFIG 1 LD
            - sudo -n arcconf GETCONFIG 1 PD
      supported_platforms:
        include: []
        exclude: []
      multi_instance: false
      additional_permissions:
        description: "The module uses arcconf, which can only be executed by root. It uses sudo and assumes that it is configured such that the netdata user can execute arcconf as root without a password."
      default_behavior:
        auto_detection:
          description: "After all the permissions are satisfied, netdata should be to execute commands via the arcconf command line utility"
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list:
          - title: Grant permissions for netdata, to run arcconf as sudoer
            description: |
              The module uses arcconf, which can only be executed by root. It uses sudo and assumes that it is configured such that the netdata user can execute arcconf as root without a password.
              
              Add to your /etc/sudoers file:
              which arcconf shows the full path to the binary.
              
              ```bash
              netdata ALL=(root)       NOPASSWD: /path/to/arcconf
              ```
          - title: Reset Netdata's systemd unit CapabilityBoundingSet (Linux distributions with systemd)
            description: |
              The default CapabilityBoundingSet doesn't allow using sudo, and is quite strict in general. Resetting is not optimal, but a next-best solution given the inability to execute arcconf using sudo.
              
              As root user, do the following:
              
              ```bash
              mkdir /etc/systemd/system/netdata.service.d
              echo -e '[Service]\nCapabilityBoundingSet=~' | tee /etc/systemd/system/netdata.service.d/unset-capability-bounding-set.conf
              systemctl daemon-reload
              systemctl restart netdata.service
              ```
      configuration:
        file:
          name: "python.d/adaptec_raid.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
        examples:
          folding:
            enabled: true
            title: "Config"
          list:
            - name: Basic
              folding:
                enabled: false
              description: A basic example configuration per job
              config: |
                job_name:
                    name: my_job_name           
                    update_every: 1         # the JOB's data collection frequency
                    priority: 60000         # the JOB's order on the dashboard
                    penalty: yes            # the JOB's penalty
                    autodetection_retry: 0  # the JOB's re-check interval in seconds
    troubleshooting:
      problems:
        list: []
    alerts:
      - name: adaptec_raid_ld_status
        link: https://github.com/netdata/netdata/blob/master/health/health.d/adaptec_raid.conf
        metric: adaptec_raid.ld_status
        info: logical device status is failed or degraded
      - name: adaptec_raid_pd_state
        link: https://github.com/netdata/netdata/blob/master/health/health.d/adaptec_raid.conf
        metric: adaptec_raid.pd_state
        info: physical device state is not online
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: global
          description: "These metrics refer to the entire monitored application."
          labels: []
          metrics:
            - name: adaptec_raid.ld_status
              description: "Status of logical devices (1: Failed or Degraded)"
              unit: "bool"
              chart_type: line
              dimensions:
                - name: a dimension per logical device
            - name: adaptec_raid.pd_state
              description: "State of physical devices (1: not Online)"
              unit: "bool"
              chart_type: line
              dimensions:
                - name: a dimension per physical device
            - name: adaptec_raid.smart_warnings
              description: S.M.A.R.T warnings
              unit: "count"
              chart_type: line
              dimensions:
                - name: a dimension per physical device
            - name: adaptec_raid.temperature
              description: Temperature
              unit: "celsius"
              chart_type: line
              dimensions:
                - name: a dimension per physical device