| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-dockerhub |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: dockerhub |
| 7 | monitored_instance: |
| 8 | name: Docker Hub repository |
| 9 | link: https://hub.docker.com/ |
| 10 | icon_filename: docker.svg |
| 11 | categories: |
| 12 | - data-collection.containers-and-vms |
| 13 | keywords: |
| 14 | - dockerhub |
| 15 | related_resources: |
| 16 | integrations: |
| 17 | list: [] |
| 18 | info_provided_to_referring_integrations: |
| 19 | description: "" |
| 20 | overview: |
| 21 | data_collection: |
| 22 | metrics_description: | |
| 23 | This collector keeps track of DockerHub repositories statistics such as the number of stars, pulls, current status, and more. |
| 24 | method_description: "" |
| 25 | supported_platforms: |
| 26 | include: [] |
| 27 | exclude: [] |
| 28 | multi_instance: true |
| 29 | additional_permissions: |
| 30 | description: "" |
| 31 | default_behavior: |
| 32 | auto_detection: |
| 33 | description: "" |
| 34 | limits: |
| 35 | description: "" |
| 36 | performance_impact: |
| 37 | description: "" |
| 38 | setup: |
| 39 | prerequisites: |
| 40 | list: [] |
| 41 | configuration: |
| 42 | file: |
| 43 | name: go.d/dockerhub.conf |
| 44 | options: |
| 45 | description: | |
| 46 | The following options can be defined globally: update_every, autodetection_retry. |
| 47 | folding: |
| 48 | title: Config options |
| 49 | enabled: true |
| 50 | list: |
| 51 | - name: update_every |
| 52 | description: Data collection interval (seconds). |
| 53 | default_value: 5 |
| 54 | required: false |
| 55 | group: Collection |
| 56 | - name: autodetection_retry |
| 57 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 58 | default_value: 0 |
| 59 | required: false |
| 60 | group: Collection |
| 61 | |
| 62 | - name: repositories |
| 63 | description: List of Docker Hub repositories to monitor. |
| 64 | default_value: "" |
| 65 | required: true |
| 66 | group: Target |
| 67 | - name: url |
| 68 | description: DockerHub repositories endpoint URL |
| 69 | default_value: https://hub.docker.com/v2/repositories |
| 70 | required: true |
| 71 | group: Target |
| 72 | - name: timeout |
| 73 | description: HTTP request timeout (seconds). |
| 74 | default_value: 5 |
| 75 | required: false |
| 76 | group: Target |
| 77 | |
| 78 | - name: username |
| 79 | description: Username for Basic HTTP authentication. |
| 80 | default_value: "" |
| 81 | required: false |
| 82 | group: HTTP Auth |
| 83 | - name: password |
| 84 | description: Password for Basic HTTP authentication. |
| 85 | default_value: "" |
| 86 | required: false |
| 87 | group: HTTP Auth |
| 88 | - name: bearer_token_file |
| 89 | description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)." |
| 90 | default_value: "" |
| 91 | required: false |
| 92 | group: HTTP Auth |
| 93 | |
| 94 | - name: tls_skip_verify |
| 95 | description: Skip TLS certificate and hostname verification (insecure). |
| 96 | default_value: no |
| 97 | required: false |
| 98 | group: TLS |
| 99 | - name: tls_ca |
| 100 | description: Path to CA bundle used to validate the server certificate. |
| 101 | default_value: "" |
| 102 | required: false |
| 103 | group: TLS |
| 104 | - name: tls_cert |
| 105 | description: Path to client TLS certificate (for mTLS). |
| 106 | default_value: "" |
| 107 | required: false |
| 108 | group: TLS |
| 109 | - name: tls_key |
| 110 | description: Path to client TLS private key (for mTLS). |
| 111 | default_value: "" |
| 112 | required: false |
| 113 | group: TLS |
| 114 | |
| 115 | - name: proxy_url |
| 116 | description: HTTP proxy URL. |
| 117 | default_value: "" |
| 118 | required: false |
| 119 | group: Proxy |
| 120 | - name: proxy_username |
| 121 | description: Username for proxy Basic HTTP authentication. |
| 122 | default_value: "" |
| 123 | required: false |
| 124 | group: Proxy |
| 125 | - name: proxy_password |
| 126 | description: Password for proxy Basic HTTP authentication. |
| 127 | default_value: "" |
| 128 | required: false |
| 129 | group: Proxy |
| 130 | |
| 131 | - name: method |
| 132 | description: HTTP method to use. |
| 133 | default_value: "GET" |
| 134 | required: false |
| 135 | group: Request |
| 136 | - name: body |
| 137 | description: Request body (e.g., for POST/PUT). |
| 138 | default_value: "" |
| 139 | required: false |
| 140 | group: Request |
| 141 | - name: headers |
| 142 | description: "Additional HTTP headers (one per line as key: value)." |
| 143 | default_value: "" |
| 144 | required: false |
| 145 | group: Request |
| 146 | - name: not_follow_redirects |
| 147 | description: Do not follow HTTP redirects. |
| 148 | default_value: no |
| 149 | required: false |
| 150 | group: Request |
| 151 | - name: force_http2 |
| 152 | description: Force HTTP/2 (including h2c over TCP). |
| 153 | default_value: no |
| 154 | required: false |
| 155 | group: Request |
| 156 | |
| 157 | - name: vnode |
| 158 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 159 | default_value: "" |
| 160 | required: false |
| 161 | group: Virtual Node |
| 162 | examples: |
| 163 | folding: |
| 164 | title: Config |
| 165 | enabled: true |
| 166 | list: |
| 167 | - name: Basic |
| 168 | folding: |
| 169 | enabled: false |
| 170 | description: A basic example configuration. |
| 171 | config: | |
| 172 | jobs: |
| 173 | - name: dockerhub |
| 174 | repositories: |
| 175 | - 'user1/name1' |
| 176 | - 'user2/name2' |
| 177 | - 'user3/name3' |
| 178 | troubleshooting: |
| 179 | problems: |
| 180 | list: [] |
| 181 | alerts: [] |
| 182 | metrics: |
| 183 | folding: |
| 184 | title: Metrics |
| 185 | enabled: false |
| 186 | description: "" |
| 187 | availability: [] |
| 188 | scopes: |
| 189 | - name: global |
| 190 | description: These metrics refer to the entire monitored application. |
| 191 | labels: [] |
| 192 | metrics: |
| 193 | - name: dockerhub.pulls_sum |
| 194 | description: Pulls Summary |
| 195 | unit: pulls |
| 196 | chart_type: line |
| 197 | dimensions: |
| 198 | - name: sum |
| 199 | - name: dockerhub.pulls |
| 200 | description: Pulls |
| 201 | unit: pulls |
| 202 | chart_type: stacked |
| 203 | dimensions: |
| 204 | - name: a dimension per repository |
| 205 | - name: dockerhub.pulls_rate |
| 206 | description: Pulls Rate |
| 207 | unit: pulls/s |
| 208 | chart_type: stacked |
| 209 | dimensions: |
| 210 | - name: a dimension per repository |
| 211 | - name: dockerhub.stars |
| 212 | description: Stars |
| 213 | unit: stars |
| 214 | chart_type: stacked |
| 215 | dimensions: |
| 216 | - name: a dimension per repository |
| 217 | - name: dockerhub.status |
| 218 | description: Current Status |
| 219 | unit: status |
| 220 | chart_type: line |
| 221 | dimensions: |
| 222 | - name: a dimension per repository |
| 223 | - name: dockerhub.last_updated |
| 224 | description: Time Since Last Updated |
| 225 | unit: seconds |
| 226 | chart_type: line |
| 227 | dimensions: |
| 228 | - name: a dimension per repository |