| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-boinc |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: boinc |
| 7 | monitored_instance: |
| 8 | name: BOINC |
| 9 | link: https://boinc.berkeley.edu/ |
| 10 | categories: |
| 11 | - data-collection.applications |
| 12 | icon_filename: "bolt.svg" |
| 13 | related_resources: |
| 14 | integrations: |
| 15 | list: [] |
| 16 | info_provided_to_referring_integrations: |
| 17 | description: "" |
| 18 | keywords: |
| 19 | - boinc |
| 20 | - distributed |
| 21 | overview: |
| 22 | data_collection: |
| 23 | metrics_description: | |
| 24 | This collector monitors task counts for the Berkeley Open Infrastructure Networking Computing (BOINC) distributed computing client. |
| 25 | method_description: | |
| 26 | It communicates with BOING using [GIU RPC Protocol](https://boinc.berkeley.edu/trac/wiki/GuiRpcProtocol). |
| 27 | supported_platforms: |
| 28 | include: [] |
| 29 | exclude: [] |
| 30 | multi_instance: true |
| 31 | additional_permissions: |
| 32 | description: "" |
| 33 | default_behavior: |
| 34 | auto_detection: |
| 35 | description: | |
| 36 | By default, it detects BOINC client instances running on localhost that are listening on port 31416. |
| 37 | On startup, it tries to collect metrics from: |
| 38 | |
| 39 | - http://127.0.0.1:31416 |
| 40 | limits: |
| 41 | description: "" |
| 42 | performance_impact: |
| 43 | description: "" |
| 44 | setup: |
| 45 | prerequisites: |
| 46 | list: [] |
| 47 | configuration: |
| 48 | file: |
| 49 | name: go.d/boinc.conf |
| 50 | options: |
| 51 | description: | |
| 52 | The following options can be defined globally: update_every, autodetection_retry. |
| 53 | folding: |
| 54 | title: Config options |
| 55 | enabled: true |
| 56 | list: |
| 57 | - name: update_every |
| 58 | description: Data collection frequency. |
| 59 | default_value: 1 |
| 60 | required: false |
| 61 | - name: autodetection_retry |
| 62 | description: Recheck interval in seconds. Zero means no recheck will be scheduled. |
| 63 | default_value: 0 |
| 64 | required: false |
| 65 | - name: address |
| 66 | description: The IP address and port where the BOINC client listens for connections. |
| 67 | default_value: 127.0.0.1:31416 |
| 68 | required: true |
| 69 | - name: timeout |
| 70 | description: Connection, read, and write timeout duration in seconds. The timeout includes name resolution. |
| 71 | default_value: 1 |
| 72 | required: false |
| 73 | - name: password |
| 74 | description: The GUI RPC password for authentication. |
| 75 | default_value: "" |
| 76 | required: false |
| 77 | examples: |
| 78 | folding: |
| 79 | title: Config |
| 80 | enabled: true |
| 81 | list: |
| 82 | - name: Basic |
| 83 | description: A basic example configuration. |
| 84 | config: | |
| 85 | jobs: |
| 86 | - name: local |
| 87 | address: 127.0.0.1:31416 |
| 88 | - name: Multi-instance |
| 89 | description: | |
| 90 | > **Note**: When you define multiple jobs, their names must be unique. |
| 91 | |
| 92 | Collecting metrics from local and remote instances. |
| 93 | config: | |
| 94 | jobs: |
| 95 | - name: local |
| 96 | address: 127.0.0.1:31416 |
| 97 | |
| 98 | - name: remote |
| 99 | address: 203.0.113.0:31416 |
| 100 | password: somePassword |
| 101 | troubleshooting: |
| 102 | problems: |
| 103 | list: [] |
| 104 | alerts: |
| 105 | - name: boinc_total_tasks |
| 106 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/boinc.conf |
| 107 | metric: boinc.tasks |
| 108 | info: average number of total tasks over the last 10 minutes |
| 109 | - name: boinc_active_tasks |
| 110 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/boinc.conf |
| 111 | metric: boinc.tasks |
| 112 | info: average number of active tasks over the last 10 minutes |
| 113 | - name: boinc_compute_errors |
| 114 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/boinc.conf |
| 115 | metric: boinc.tasks_state |
| 116 | info: average number of compute errors over the last 10 minutes |
| 117 | - name: boinc_upload_errors |
| 118 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/boinc.conf |
| 119 | metric: boinc.tasks_state |
| 120 | info: average number of failed uploads over the last 10 minutes |
| 121 | metrics: |
| 122 | folding: |
| 123 | title: Metrics |
| 124 | enabled: false |
| 125 | description: "" |
| 126 | availability: [] |
| 127 | scopes: |
| 128 | - name: global |
| 129 | description: "These metrics refer to the entire monitored application." |
| 130 | labels: [] |
| 131 | metrics: |
| 132 | - name: boinc.tasks |
| 133 | description: Overall Tasks |
| 134 | unit: tasks |
| 135 | chart_type: line |
| 136 | dimensions: |
| 137 | - name: total |
| 138 | - name: active |
| 139 | - name: boinc.tasks_per_state |
| 140 | description: Tasks per State |
| 141 | unit: tasks |
| 142 | chart_type: line |
| 143 | dimensions: |
| 144 | - name: new |
| 145 | - name: downloading |
| 146 | - name: downloaded |
| 147 | - name: compute_error |
| 148 | - name: uploading |
| 149 | - name: uploaded |
| 150 | - name: aborted |
| 151 | - name: upload_failed |
| 152 | - name: boinc.active_tasks_per_state |
| 153 | description: Active Tasks per State |
| 154 | unit: tasks |
| 155 | chart_type: line |
| 156 | dimensions: |
| 157 | - name: uninitialized |
| 158 | - name: executing |
| 159 | - name: abort_pending |
| 160 | - name: quit_pending |
| 161 | - name: suspended |
| 162 | - name: copy_pending |
| 163 | - name: boinc.active_tasks_per_scheduler_state |
| 164 | description: Active Tasks per Scheduler State |
| 165 | unit: tasks |
| 166 | chart_type: line |
| 167 | dimensions: |
| 168 | - name: uninitialized |
| 169 | - name: preempted |
| 170 | - name: scheduled |