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

plugin_name: python.d.plugin
modules:
  - meta:
      plugin_name: python.d.plugin
      module_name: boinc
      monitored_instance:
        name: BOINC
        link: "https://boinc.berkeley.edu/"
        categories:
          - data-collection.distributed-computing-systems
        icon_filename: "bolt.svg"
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      keywords:
        - boinc
        - distributed
      most_popular: false
    overview:
      data_collection:
        metrics_description: "This collector monitors task counts for the Berkeley Open Infrastructure Networking Computing (BOINC) distributed computing client."
        method_description: "It uses the same RPC interface that the BOINC monitoring GUI does."
      supported_platforms:
        include: []
        exclude: []
      multi_instance: true
      additional_permissions:
        description: ""
      default_behavior:
        auto_detection:
          description: "By default, the module will try to auto-detect the password to the RPC interface by looking in `/var/lib/boinc` for this file (this is the location most Linux distributions use for a system-wide BOINC installation), so things may just work without needing configuration for a local system."
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list:
          - title: "Boinc RPC interface"
            description: BOINC requires use of a password to access it's RPC interface. You can find this password in the `gui_rpc_auth.cfg` file in your BOINC directory.
      configuration:
        file:
          name: python.d/boinc.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: hostname
              description: Define a hostname where boinc is running.
              default_value: "localhost"
              required: false
            - name: port
              description: The port of boinc RPC interface.
              default_value: ""
              required: false
            - name: password
              description: Provide a password to connect to a boinc RPC interface.
              default_value: ""
              required: false
        examples:
          folding:
            enabled: true
            title: "Config"
          list:
            - name: Configuration of a remote boinc instance
              description: A basic JOB configuration for a remote boinc instance
              folding:
                enabled: false
              config: |
                remote:
                 hostname: '1.2.3.4'
                 port: 1234
                 password: 'some-password'
            - 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: 1234
                  password: 'some-password'
                
                remote_job:
                  name: 'remote'
                  host: '192.0.2.1'
                  port: 1234
                  password: some-other-password
    troubleshooting:
      problems:
        list: []
    alerts:
      - name: boinc_total_tasks
        link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
        metric: boinc.tasks
        info: average number of total tasks over the last 10 minutes
        os: "*"
      - name: boinc_active_tasks
        link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
        metric: boinc.tasks
        info: average number of active tasks over the last 10 minutes
        os: "*"
      - name: boinc_compute_errors
        link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
        metric: boinc.states
        info: average number of compute errors over the last 10 minutes
        os: "*"
      - name: boinc_upload_errors
        link: https://github.com/netdata/netdata/blob/master/health/health.d/boinc.conf
        metric: boinc.states
        info: average number of failed uploads over the last 10 minutes
        os: "*"
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: global
          description: "These metrics refer to the entire monitored application."
          labels: []
          metrics:
            - name: boinc.tasks
              description: Overall Tasks
              unit: "tasks"
              chart_type: line
              dimensions:
                - name: Total
                - name: Active
            - name: boinc.states
              description: Tasks per State
              unit: "tasks"
              chart_type: line
              dimensions:
                - name: New
                - name: Downloading
                - name: Ready to Run
                - name: Compute Errors
                - name: Uploading
                - name: Uploaded
                - name: Aborted
                - name: Failed Uploads
            - name: boinc.sched
              description: Tasks per Scheduler State
              unit: "tasks"
              chart_type: line
              dimensions:
                - name: Uninitialized
                - name: Preempted
                - name: Scheduled
            - name: boinc.process
              description: Tasks per Process State
              unit: "tasks"
              chart_type: line
              dimensions:
                - name: Uninitialized
                - name: Executing
                - name: Suspended
                - name: Aborted
                - name: Quit
                - name: Copy Pending