github.com/netdata/go.d.plugin@v0.58.1/modules/nginxplus/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-nginxplus 5 plugin_name: go.d.plugin 6 module_name: nginxplus 7 monitored_instance: 8 name: NGINX Plus 9 link: https://www.nginx.com/products/nginx/ 10 icon_filename: nginxplus.svg 11 categories: 12 - data-collection.web-servers-and-web-proxies 13 keywords: 14 - nginxplus 15 - nginx 16 - web 17 - webserver 18 - http 19 - proxy 20 related_resources: 21 integrations: 22 list: [] 23 info_provided_to_referring_integrations: 24 description: "" 25 most_popular: false 26 overview: 27 data_collection: 28 metrics_description: | 29 This collector monitors NGINX Plus servers. 30 method_description: "" 31 supported_platforms: 32 include: [] 33 exclude: [] 34 multi_instance: true 35 additional_permissions: 36 description: "" 37 default_behavior: 38 auto_detection: 39 description: "" 40 limits: 41 description: "" 42 performance_impact: 43 description: "" 44 setup: 45 prerequisites: 46 list: 47 - title: Config API 48 description: | 49 To configure API, see the [official documentation](https://docs.nginx.com/nginx/admin-guide/monitoring/live-activity-monitoring/#configuring-the-api). 50 configuration: 51 file: 52 name: go.d/nginxplus.conf 53 options: 54 description: | 55 The following options can be defined globally: update_every, autodetection_retry. 56 folding: 57 title: Config options 58 enabled: true 59 list: 60 - name: update_every 61 description: Data collection frequency. 62 default_value: 1 63 required: false 64 - name: autodetection_retry 65 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 66 default_value: 0 67 required: false 68 - name: url 69 description: Server URL. 70 default_value: http://127.0.0.1 71 required: true 72 - name: timeout 73 description: HTTP request timeout. 74 default_value: 1 75 required: false 76 - name: username 77 description: Username for basic HTTP authentication. 78 default_value: "" 79 required: false 80 - name: password 81 description: Password for basic HTTP authentication. 82 default_value: "" 83 required: false 84 - name: proxy_url 85 description: Proxy URL. 86 default_value: "" 87 required: false 88 - name: proxy_username 89 description: Username for proxy basic HTTP authentication. 90 default_value: "" 91 required: false 92 - name: proxy_password 93 description: Password for proxy basic HTTP authentication. 94 default_value: "" 95 required: false 96 - name: method 97 description: HTTP request method. 98 default_value: GET 99 required: false 100 - name: body 101 description: HTTP request body. 102 default_value: "" 103 required: false 104 - name: headers 105 description: HTTP request headers. 106 default_value: "" 107 required: false 108 - name: not_follow_redirects 109 description: Redirect handling policy. Controls whether the client follows redirects. 110 default_value: false 111 required: false 112 - name: tls_skip_verify 113 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 114 default_value: false 115 required: false 116 - name: tls_ca 117 description: Certification authority that the client uses when verifying the server's certificates. 118 default_value: "" 119 required: false 120 - name: tls_cert 121 description: Client TLS certificate. 122 default_value: "" 123 required: false 124 - name: tls_key 125 description: Client TLS key. 126 default_value: "" 127 required: false 128 examples: 129 folding: 130 title: Config 131 enabled: true 132 list: 133 - name: Basic 134 description: A basic example configuration. 135 config: | 136 jobs: 137 - name: local 138 url: http://127.0.0.1 139 - name: HTTP authentication 140 description: Basic HTTP authentication. 141 config: | 142 jobs: 143 - name: local 144 url: http://127.0.0.1 145 username: username 146 password: password 147 - name: HTTPS with self-signed certificate 148 description: NGINX Plus with enabled HTTPS and self-signed certificate. 149 config: | 150 jobs: 151 - name: local 152 url: https://127.0.0.1 153 tls_skip_verify: yes 154 - name: Multi-instance 155 description: | 156 > **Note**: When you define multiple jobs, their names must be unique. 157 158 Collecting metrics from local and remote instances. 159 config: | 160 jobs: 161 - name: local 162 url: http://127.0.0.1 163 164 - name: remote 165 url: http://192.0.2.1 166 troubleshooting: 167 problems: 168 list: [] 169 alerts: [] 170 metrics: 171 folding: 172 title: Metrics 173 enabled: false 174 description: "" 175 availability: [] 176 scopes: 177 - name: global 178 description: These metrics refer to the entire monitored application. 179 labels: [] 180 metrics: 181 - name: nginxplus.client_connections_rate 182 description: Client connections rate 183 unit: connections/s 184 chart_type: line 185 dimensions: 186 - name: accepted 187 - name: dropped 188 - name: nginxplus.client_connections_count 189 description: Client connections 190 unit: connections 191 chart_type: line 192 dimensions: 193 - name: active 194 - name: idle 195 - name: nginxplus.ssl_handshakes_rate 196 description: SSL handshakes rate 197 unit: handshakes/s 198 chart_type: line 199 dimensions: 200 - name: successful 201 - name: failed 202 - name: nginxplus.ssl_handshakes_failures_rate 203 description: SSL handshakes failures rate 204 unit: failures/s 205 chart_type: stacked 206 dimensions: 207 - name: no_common_protocol 208 - name: no_common_cipher 209 - name: timeout 210 - name: peer_rejected_cert 211 - name: nginxplus.ssl_verification_errors_rate 212 description: SSL verification errors rate 213 unit: errors/s 214 chart_type: stacked 215 dimensions: 216 - name: no_cert 217 - name: expired_cert 218 - name: revoked_cert 219 - name: hostname_mismatch 220 - name: other 221 - name: nginxplus.ssl_session_reuses_rate 222 description: Session reuses during SSL handshak 223 unit: reuses/s 224 chart_type: line 225 dimensions: 226 - name: ssl_session 227 - name: nginxplus.http_requests_rate 228 description: HTTP requests rate 229 unit: requests/s 230 chart_type: line 231 dimensions: 232 - name: requests 233 - name: nginxplus.http_requests_count 234 description: HTTP requests 235 unit: requests 236 chart_type: line 237 dimensions: 238 - name: requests 239 - name: nginxplus.uptime 240 description: Uptime 241 unit: seconds 242 chart_type: line 243 dimensions: 244 - name: uptime 245 - name: http server zone 246 description: These metrics refer to the HTTP server zone. 247 labels: 248 - name: http_server_zone 249 description: HTTP server zone name 250 metrics: 251 - name: nginxplus.http_server_zone_requests_rate 252 description: HTTP Server Zone requests rate 253 unit: requests/s 254 chart_type: line 255 dimensions: 256 - name: requests 257 - name: nginxplus.http_server_zone_responses_per_code_class_rate 258 description: HTTP Server Zone responses rate 259 unit: responses/s 260 chart_type: stacked 261 dimensions: 262 - name: 1xx 263 - name: 2xx 264 - name: 3xx 265 - name: 4xx 266 - name: 5xx 267 - name: nginxplus.http_server_zone_traffic_rate 268 description: HTTP Server Zone traffic 269 unit: bytes/s 270 chart_type: area 271 dimensions: 272 - name: received 273 - name: sent 274 - name: nginxplus.http_server_zone_requests_processing_count 275 description: HTTP Server Zone currently processed requests 276 unit: requests 277 chart_type: line 278 dimensions: 279 - name: processing 280 - name: nginxplus.http_server_zone_requests_discarded_rate 281 description: HTTP Server Zone requests discarded rate 282 unit: requests/s 283 chart_type: line 284 dimensions: 285 - name: discarded 286 - name: http location zone 287 description: These metrics refer to the HTTP location zone. 288 labels: 289 - name: http_location_zone 290 description: HTTP location zone name 291 metrics: 292 - name: nginxplus.http_location_zone_requests_rate 293 description: HTTP Location Zone requests rate 294 unit: requests/s 295 chart_type: line 296 dimensions: 297 - name: requests 298 - name: nginxplus.http_location_zone_responses_per_code_class_rate 299 description: HTTP Location Zone responses rate 300 unit: responses/s 301 chart_type: stacked 302 dimensions: 303 - name: 1xx 304 - name: 2xx 305 - name: 3xx 306 - name: 4xx 307 - name: 5xx 308 - name: nginxplus.http_location_zone_traffic_rate 309 description: HTTP Location Zone traffic rate 310 unit: bytes/s 311 chart_type: area 312 dimensions: 313 - name: received 314 - name: sent 315 - name: nginxplus.http_location_zone_requests_discarded_rate 316 description: HTTP Location Zone requests discarded rate 317 unit: requests/s 318 chart_type: line 319 dimensions: 320 - name: discarded 321 - name: http upstream 322 description: These metrics refer to the HTTP upstream. 323 labels: 324 - name: http_upstream_name 325 description: HTTP upstream name 326 - name: http_upstream_zone 327 description: HTTP upstream zone name 328 metrics: 329 - name: nginxplus.http_upstream_peers_count 330 description: HTTP Upstream peers 331 unit: peers 332 chart_type: line 333 dimensions: 334 - name: peers 335 - name: nginxplus.http_upstream_zombies_count 336 description: HTTP Upstream zombies 337 unit: servers 338 chart_type: line 339 dimensions: 340 - name: zombie 341 - name: nginxplus.http_upstream_keepalive_count 342 description: HTTP Upstream keepalive 343 unit: connections 344 chart_type: line 345 dimensions: 346 - name: keepalive 347 - name: http upstream server 348 description: These metrics refer to the HTTP upstream server. 349 labels: 350 - name: http_upstream_name 351 description: HTTP upstream name 352 - name: http_upstream_zone 353 description: HTTP upstream zone name 354 - name: http_upstream_server_address 355 description: HTTP upstream server address (e.g. 127.0.0.1:81) 356 - name: http_upstream_server_name 357 description: HTTP upstream server name 358 metrics: 359 - name: nginxplus.http_upstream_server_requests_rate 360 description: HTTP Upstream Server requests 361 unit: requests/s 362 chart_type: line 363 dimensions: 364 - name: requests 365 - name: nginxplus.http_upstream_server_responses_per_code_class_rate 366 description: HTTP Upstream Server responses 367 unit: responses/s 368 chart_type: stacked 369 dimensions: 370 - name: 1xx 371 - name: 2xx 372 - name: 3xx 373 - name: 4xx 374 - name: 5xx 375 - name: nginxplus.http_upstream_server_response_time 376 description: HTTP Upstream Server average response time 377 unit: milliseconds 378 chart_type: line 379 dimensions: 380 - name: response 381 - name: nginxplus.http_upstream_server_response_header_time 382 description: HTTP Upstream Server average response header time 383 unit: milliseconds 384 chart_type: line 385 dimensions: 386 - name: header 387 - name: nginxplus.http_upstream_server_traffic_rate 388 description: HTTP Upstream Server traffic rate 389 unit: bytes/s 390 chart_type: area 391 dimensions: 392 - name: received 393 - name: sent 394 - name: nginxplus.http_upstream_server_state 395 description: HTTP Upstream Server state 396 unit: state 397 chart_type: line 398 dimensions: 399 - name: up 400 - name: down 401 - name: draining 402 - name: unavail 403 - name: checking 404 - name: unhealthy 405 - name: nginxplus.http_upstream_server_connections_count 406 description: HTTP Upstream Server connections 407 unit: connections 408 chart_type: line 409 dimensions: 410 - name: active 411 - name: nginxplus.http_upstream_server_downtime 412 description: HTTP Upstream Server downtime 413 unit: seconds 414 chart_type: line 415 dimensions: 416 - name: downtime 417 - name: http cache 418 description: These metrics refer to the HTTP cache. 419 labels: 420 - name: http_cache 421 description: HTTP cache name 422 metrics: 423 - name: nginxplus.http_cache_state 424 description: HTTP Cache state 425 unit: state 426 chart_type: line 427 dimensions: 428 - name: warm 429 - name: cold 430 - name: nginxplus.http_cache_iops 431 description: HTTP Cache size 432 unit: responses/s 433 chart_type: line 434 dimensions: 435 - name: served 436 - name: written 437 - name: bypass 438 - name: nginxplus.http_cache_io 439 description: HTTP Cache IOPS 440 unit: bytes/s 441 chart_type: line 442 dimensions: 443 - name: served 444 - name: written 445 - name: bypass 446 - name: nginxplus.http_cache_size 447 description: HTTP Cache IO 448 unit: bytes 449 chart_type: line 450 dimensions: 451 - name: size 452 - name: stream server zone 453 description: These metrics refer to the Stream server zone. 454 labels: 455 - name: stream_server_zone 456 description: Stream server zone name 457 metrics: 458 - name: nginxplus.stream_server_zone_connections_rate 459 description: Stream Server Zone connections rate 460 unit: connections/s 461 chart_type: line 462 dimensions: 463 - name: accepted 464 - name: nginxplus.stream_server_zone_sessions_per_code_class_rate 465 description: Stream Server Zone sessions rate 466 unit: sessions/s 467 chart_type: stacked 468 dimensions: 469 - name: 2xx 470 - name: 4xx 471 - name: 5xx 472 - name: nginxplus.stream_server_zone_traffic_rate 473 description: Stream Server Zone traffic rate 474 unit: bytes/s 475 chart_type: area 476 dimensions: 477 - name: received 478 - name: sent 479 - name: nginxplus.stream_server_zone_connections_processing_count 480 description: Stream Server Zone connections processed 481 unit: connections 482 chart_type: line 483 dimensions: 484 - name: processing 485 - name: nginxplus.stream_server_zone_connections_discarded_rate 486 description: Stream Server Zone connections discarded 487 unit: connections/s 488 chart_type: line 489 dimensions: 490 - name: discarded 491 - name: stream upstream 492 description: These metrics refer to the Stream upstream. 493 labels: 494 - name: stream_upstream_name 495 description: Stream upstream name 496 - name: stream_upstream_zone 497 description: Stream upstream zone name 498 metrics: 499 - name: nginxplus.stream_upstream_peers_count 500 description: Stream Upstream peers 501 unit: peers 502 chart_type: line 503 dimensions: 504 - name: peers 505 - name: nginxplus.stream_upstream_zombies_count 506 description: Stream Upstream zombies 507 unit: servers 508 chart_type: line 509 dimensions: 510 - name: zombie 511 - name: stream upstream server 512 description: These metrics refer to the Stream upstream server. 513 labels: 514 - name: stream_upstream_name 515 description: Stream upstream name 516 - name: stream_upstream_zone 517 description: Stream upstream zone name 518 - name: stream_upstream_server_address 519 description: Stream upstream server address (e.g. 127.0.0.1:12346) 520 - name: stream_upstream_server_name 521 description: Stream upstream server name 522 metrics: 523 - name: nginxplus.stream_upstream_server_connections_rate 524 description: Stream Upstream Server connections 525 unit: connections/s 526 chart_type: line 527 dimensions: 528 - name: forwarded 529 - name: nginxplus.stream_upstream_server_traffic_rate 530 description: Stream Upstream Server traffic rate 531 unit: bytes/s 532 chart_type: area 533 dimensions: 534 - name: received 535 - name: sent 536 - name: nginxplus.stream_upstream_server_state 537 description: Stream Upstream Server state 538 unit: state 539 chart_type: line 540 dimensions: 541 - name: up 542 - name: down 543 - name: unavail 544 - name: checking 545 - name: unhealthy 546 - name: nginxplus.stream_upstream_server_downtime 547 description: Stream Upstream Server downtime 548 unit: seconds 549 chart_type: line 550 dimensions: 551 - name: downtime 552 - name: nginxplus.stream_upstream_server_connections_count 553 description: Stream Upstream Server connections 554 unit: connections 555 chart_type: line 556 dimensions: 557 - name: active 558 - name: resolver zone 559 description: These metrics refer to the resolver zone. 560 labels: 561 - name: resolver_zone 562 description: resolver zone name 563 metrics: 564 - name: nginxplus.resolver_zone_requests_rate 565 description: Resolver requests rate 566 unit: requests/s 567 chart_type: stacked 568 dimensions: 569 - name: name 570 - name: srv 571 - name: addr 572 - name: nginxplus.resolver_zone_responses_rate 573 description: Resolver responses rate 574 unit: responses/s 575 chart_type: stacked 576 dimensions: 577 - name: noerror 578 - name: formerr 579 - name: servfail 580 - name: nxdomain 581 - name: notimp 582 - name: refused 583 - name: timedout 584 - name: unknown