github.com/netdata/go.d.plugin@v0.58.1/modules/nginxvts/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-nginxvts 5 plugin_name: go.d.plugin 6 module_name: nginxvts 7 monitored_instance: 8 name: NGINX VTS 9 link: https://www.nginx.com/ 10 icon_filename: nginx.svg 11 categories: 12 - data-collection.web-servers-and-web-proxies 13 keywords: 14 - webserver 15 related_resources: 16 integrations: 17 list: 18 - plugin_name: go.d.plugin 19 module_name: weblog 20 - plugin_name: go.d.plugin 21 module_name: httpcheck 22 - plugin_name: apps.plugin 23 module_name: apps 24 info_provided_to_referring_integrations: 25 description: "" 26 most_popular: true 27 overview: 28 data_collection: 29 metrics_description: | 30 This collector monitors NGINX servers with [virtual host traffic status module](https://github.com/vozlt/nginx-module-vts). 31 method_description: | 32 It sends HTTP requests to the NGINX VTS location [status](https://github.com/vozlt/nginx-module-vts#synopsis), 33 which is a built-in location that provides metrics about the NGINX VTS server. 34 supported_platforms: 35 include: [] 36 exclude: [] 37 multi_instance: true 38 additional_permissions: 39 description: "" 40 default_behavior: 41 auto_detection: 42 description: | 43 By default, it detects NGINX instances running on localhost. 44 limits: 45 description: "" 46 performance_impact: 47 description: "" 48 setup: 49 prerequisites: 50 list: 51 - title: Configure nginx-vts module 52 description: | 53 To configure nginx-vts, see the [https://github.com/vozlt/nginx-module-vts#installation). 54 configuration: 55 file: 56 name: go.d/nginxvts.conf 57 options: 58 description: | 59 The following options can be defined globally: update_every, autodetection_retry. 60 folding: 61 title: Config options 62 enabled: true 63 list: 64 - name: update_every 65 description: Data collection frequency. 66 default_value: 1 67 required: false 68 - name: autodetection_retry 69 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 70 default_value: 0 71 required: false 72 - name: url 73 description: Server URL. 74 default_value: http://127.0.0.1/status/format/json 75 required: true 76 - name: timeout 77 description: HTTP request timeout. 78 default_value: 1 79 required: false 80 - name: username 81 description: Username for basic HTTP authentication. 82 default_value: "" 83 required: false 84 - name: password 85 description: Password for basic HTTP authentication. 86 default_value: "" 87 required: false 88 - name: proxy_url 89 description: Proxy URL. 90 default_value: "" 91 required: false 92 - name: proxy_username 93 description: Username for proxy basic HTTP authentication. 94 default_value: "" 95 required: false 96 - name: proxy_password 97 description: Password for proxy basic HTTP authentication. 98 default_value: "" 99 required: false 100 - name: method 101 description: HTTP request method. 102 default_value: GET 103 required: false 104 - name: body 105 description: HTTP request body. 106 default_value: "" 107 required: false 108 - name: headers 109 description: HTTP request headers. 110 default_value: "" 111 required: false 112 - name: not_follow_redirects 113 description: Redirect handling policy. Controls whether the client follows redirects. 114 default_value: no 115 required: false 116 - name: tls_skip_verify 117 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 118 default_value: no 119 required: false 120 - name: tls_ca 121 description: Certification authority that the client uses when verifying the server's certificates. 122 default_value: "" 123 required: false 124 - name: tls_cert 125 description: Client TLS certificate. 126 default_value: "" 127 required: false 128 - name: tls_key 129 description: Client TLS key. 130 default_value: "" 131 required: false 132 examples: 133 folding: 134 title: Config 135 enabled: true 136 list: 137 - name: Basic 138 folding: 139 enabled: false 140 description: A basic example configuration. 141 config: | 142 jobs: 143 - name: local 144 url: http://127.0.0.1/status/format/json 145 - name: HTTP authentication 146 description: Basic HTTP authentication. 147 config: | 148 jobs: 149 - name: local 150 url: http://127.0.0.1/server-status?auto 151 username: username 152 password: password 153 - name: HTTPS with self-signed certificate 154 description: | 155 Do not validate server certificate chain and hostname. 156 config: | 157 jobs: 158 - name: local 159 url: https://127.0.0.1/status/format/json 160 tls_skip_verify: yes 161 - name: Multi-instance 162 description: | 163 > **Note**: When you define multiple jobs, their names must be unique. 164 165 Collecting metrics from local and remote instances. 166 config: | 167 jobs: 168 - name: local 169 url: http://127.0.0.1/status/format/json 170 171 - name: remote 172 url: http://192.0.2.1/status/format/json 173 troubleshooting: 174 problems: 175 list: [] 176 alerts: [] 177 metrics: 178 folding: 179 title: Metrics 180 enabled: false 181 description: "" 182 availability: [] 183 scopes: 184 - name: global 185 description: These metrics refer to the entire monitored application. 186 labels: [] 187 metrics: 188 - name: nginxvts.requests_total 189 description: Total requests 190 unit: requests/s 191 chart_type: line 192 dimensions: 193 - name: requests 194 - name: nginxvts.active_connections 195 description: Active connections 196 unit: connections 197 chart_type: line 198 dimensions: 199 - name: active 200 - name: nginxvts.connections_total 201 description: Total connections 202 unit: connections/s 203 chart_type: line 204 dimensions: 205 - name: reading 206 - name: writing 207 - name: waiting 208 - name: accepted 209 - name: handled 210 - name: nginxvts.uptime 211 description: Uptime 212 unit: seconds 213 chart_type: line 214 dimensions: 215 - name: uptime 216 - name: nginxvts.shm_usage 217 description: Shared memory size 218 unit: bytes 219 chart_type: line 220 dimensions: 221 - name: max 222 - name: used 223 - name: nginxvts.shm_used_node 224 description: Number of node using shared memory 225 unit: nodes 226 chart_type: line 227 dimensions: 228 - name: used 229 - name: nginxvts.server_requests_total 230 description: Total number of client requests 231 unit: requests/s 232 chart_type: line 233 dimensions: 234 - name: requests 235 - name: nginxvts.server_responses_total 236 description: Total number of responses by code class 237 unit: responses/s 238 chart_type: line 239 dimensions: 240 - name: 1xx 241 - name: 2xx 242 - name: 3xx 243 - name: 4xx 244 - name: 5xx 245 - name: nginxvts.server_traffic_total 246 description: Total amount of data transferred to and from the server 247 unit: bytes/s 248 chart_type: line 249 dimensions: 250 - name: in 251 - name: out 252 - name: nginxvts.server_cache_total 253 description: Total server cache 254 unit: events/s 255 chart_type: line 256 dimensions: 257 - name: miss 258 - name: bypass 259 - name: expired 260 - name: stale 261 - name: updating 262 - name: revalidated 263 - name: hit 264 - name: scarce