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