| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | plugin_name: go.d.plugin |
| 5 | module_name: varnish |
| 6 | monitored_instance: |
| 7 | name: Varnish |
| 8 | link: https://varnish-cache.org/ |
| 9 | categories: |
| 10 | - data-collection.web-servers-and-proxies |
| 11 | icon_filename: "varnish.svg" |
| 12 | related_resources: |
| 13 | integrations: |
| 14 | list: [] |
| 15 | info_provided_to_referring_integrations: |
| 16 | description: "" |
| 17 | keywords: |
| 18 | - varnish |
| 19 | - varnishstat |
| 20 | - varnishd |
| 21 | - cache |
| 22 | - web server |
| 23 | - web cache |
| 24 | overview: |
| 25 | data_collection: |
| 26 | metrics_description: | |
| 27 | This collector monitors Varnish instances, supporting both the open-source Varnish-Cache and the commercial Varnish-Plus. |
| 28 | |
| 29 | It tracks key performance metrics, along with detailed statistics for Backends (VBE) and Storages (SMF, SMA, MSE). |
| 30 | |
| 31 | It relies on the [`varnishstat`](https://varnish-cache.org/docs/trunk/reference/varnishstat.html) CLI tool but avoids directly executing the binary. |
| 32 | Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment. |
| 33 | This approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management. |
| 34 | method_description: "" |
| 35 | supported_platforms: |
| 36 | include: [] |
| 37 | exclude: [] |
| 38 | multi_instance: true |
| 39 | additional_permissions: |
| 40 | description: "" |
| 41 | default_behavior: |
| 42 | auto_detection: |
| 43 | description: | |
| 44 | Automatically detects and monitors Varnish instances running on the host or inside Docker containers. |
| 45 | limits: |
| 46 | description: "" |
| 47 | performance_impact: |
| 48 | description: "" |
| 49 | setup: |
| 50 | prerequisites: |
| 51 | list: [] |
| 52 | configuration: |
| 53 | file: |
| 54 | name: go.d/varnish.conf |
| 55 | options: |
| 56 | description: | |
| 57 | The following options can be defined globally: update_every. |
| 58 | folding: |
| 59 | title: Config options |
| 60 | enabled: true |
| 61 | list: |
| 62 | - name: update_every |
| 63 | description: Data collection frequency. |
| 64 | default_value: 10 |
| 65 | required: false |
| 66 | group: Collection |
| 67 | - name: timeout |
| 68 | description: Timeout for executing the binary, specified in seconds. |
| 69 | default_value: 2 |
| 70 | required: false |
| 71 | group: Collection |
| 72 | |
| 73 | - name: instance_name |
| 74 | description: "Specifies the name of the Varnish instance to collect metrics from. This corresponds to the `-n` argument used with the [varnishstat](https://varnish-cache.org/docs/trunk/reference/varnishstat.html) command." |
| 75 | default_value: "" |
| 76 | required: false |
| 77 | group: Target |
| 78 | - name: docker_container |
| 79 | description: "Specifies the name of the Docker container where the Varnish instance is running. If set, the `varnishstat` command will be executed within this container." |
| 80 | default_value: "" |
| 81 | required: false |
| 82 | group: Target |
| 83 | examples: |
| 84 | folding: |
| 85 | title: "" |
| 86 | enabled: false |
| 87 | list: |
| 88 | - name: Custom update_every |
| 89 | description: Allows you to override the default data collection interval. |
| 90 | config: | |
| 91 | jobs: |
| 92 | - name: varnish |
| 93 | update_every: 5 |
| 94 | troubleshooting: |
| 95 | problems: |
| 96 | list: [] |
| 97 | alerts: [] |
| 98 | metrics: |
| 99 | folding: |
| 100 | title: Metrics |
| 101 | enabled: false |
| 102 | description: "" |
| 103 | availability: [] |
| 104 | scopes: |
| 105 | - name: global |
| 106 | description: "These metrics refer to the entire monitored application." |
| 107 | labels: [] |
| 108 | metrics: |
| 109 | - name: varnish.client_session_connections |
| 110 | description: Connections Statistics |
| 111 | unit: "connections/s" |
| 112 | chart_type: line |
| 113 | dimensions: |
| 114 | - name: accepted |
| 115 | - name: dropped |
| 116 | - name: varnish.client_requests |
| 117 | description: Client Requests |
| 118 | unit: "requests/s" |
| 119 | chart_type: line |
| 120 | dimensions: |
| 121 | - name: received |
| 122 | - name: varnish.cache_hit_ratio_total |
| 123 | description: Cache Hit Ratio Total |
| 124 | unit: "percent" |
| 125 | chart_type: stacked |
| 126 | dimensions: |
| 127 | - name: hit |
| 128 | - name: miss |
| 129 | - name: hitpass |
| 130 | - name: hitmiss |
| 131 | - name: varnish.cache_hit_ratio_delta |
| 132 | description: Cache Hit Ratio Current Poll |
| 133 | unit: "percent" |
| 134 | chart_type: stacked |
| 135 | dimensions: |
| 136 | - name: hit |
| 137 | - name: miss |
| 138 | - name: hitpass |
| 139 | - name: hitmiss |
| 140 | - name: varnish.cache_expired_objects |
| 141 | description: Cache Expired Objects |
| 142 | unit: "objects/s" |
| 143 | chart_type: line |
| 144 | dimensions: |
| 145 | - name: expired |
| 146 | - name: varnish.cache_lru_activity |
| 147 | description: Cache LRU Activity |
| 148 | unit: "objects/s" |
| 149 | chart_type: line |
| 150 | dimensions: |
| 151 | - name: nuked |
| 152 | - name: moved |
| 153 | - name: varnish.threads |
| 154 | description: Threads In All Pools |
| 155 | unit: "threads" |
| 156 | chart_type: line |
| 157 | dimensions: |
| 158 | - name: threads |
| 159 | - name: varnish.thread_management_activity |
| 160 | description: Thread Management Activity |
| 161 | unit: "threads/s" |
| 162 | chart_type: line |
| 163 | dimensions: |
| 164 | - name: created |
| 165 | - name: failed |
| 166 | - name: destroyed |
| 167 | - name: limited |
| 168 | - name: varnish.thread_queue_len |
| 169 | description: Session Queue Length |
| 170 | unit: "threads" |
| 171 | chart_type: line |
| 172 | dimensions: |
| 173 | - name: queue_length |
| 174 | - name: varnish.backends_requests |
| 175 | description: Backend Requests |
| 176 | unit: "requests/s" |
| 177 | chart_type: line |
| 178 | dimensions: |
| 179 | - name: sent |
| 180 | - name: varnish.esi_parsing_issues |
| 181 | description: ESI Parsing Issues |
| 182 | unit: "issues/s" |
| 183 | chart_type: line |
| 184 | dimensions: |
| 185 | - name: errors |
| 186 | - name: warnings |
| 187 | - name: varnish.mgmt_process_uptime |
| 188 | description: Management Process Uptime |
| 189 | unit: "seconds" |
| 190 | chart_type: line |
| 191 | dimensions: |
| 192 | - name: uptime |
| 193 | - name: varnish.child_process_uptime |
| 194 | description: Child Process Uptime |
| 195 | unit: "seconds" |
| 196 | chart_type: line |
| 197 | dimensions: |
| 198 | - name: uptime |
| 199 | - name: Backend |
| 200 | description: "These metrics refer to the Backend (VBE)." |
| 201 | labels: [] |
| 202 | metrics: |
| 203 | - name: varnish.backend_data_transfer |
| 204 | description: Backend Data Transfer |
| 205 | unit: "bytes/s" |
| 206 | chart_type: area |
| 207 | dimensions: |
| 208 | - name: req_header |
| 209 | - name: req_body |
| 210 | - name: resp_header |
| 211 | - name: resp_body |
| 212 | - name: Storage |
| 213 | description: "These metrics refer to the Storage (SMA, SMF, MSE)." |
| 214 | labels: [] |
| 215 | metrics: |
| 216 | - name: varnish.storage_space_usage |
| 217 | description: Storage Space Usage |
| 218 | unit: "bytes" |
| 219 | chart_type: stacked |
| 220 | dimensions: |
| 221 | - name: free |
| 222 | - name: used |
| 223 | - name: varnish.storage_allocated_objects |
| 224 | description: Storage Allocated Objects |
| 225 | unit: "objects" |
| 226 | chart_type: line |
| 227 | dimensions: |
| 228 | - name: allocated |