| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-envoy |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: envoy |
| 7 | monitored_instance: |
| 8 | name: Envoy |
| 9 | link: https://www.envoyproxy.io/ |
| 10 | icon_filename: envoy.svg |
| 11 | categories: |
| 12 | - data-collection.web-servers-and-proxies |
| 13 | keywords: |
| 14 | - envoy |
| 15 | - proxy |
| 16 | related_resources: |
| 17 | integrations: |
| 18 | list: |
| 19 | - plugin_name: apps.plugin |
| 20 | module_name: apps |
| 21 | info_provided_to_referring_integrations: |
| 22 | description: "" |
| 23 | overview: |
| 24 | data_collection: |
| 25 | metrics_description: | |
| 26 | This collector monitors Envoy proxies. It collects server, cluster, and listener metrics. |
| 27 | method_description: "" |
| 28 | supported_platforms: |
| 29 | include: [] |
| 30 | exclude: [] |
| 31 | multi_instance: true |
| 32 | additional_permissions: |
| 33 | description: "" |
| 34 | default_behavior: |
| 35 | auto_detection: |
| 36 | description: | |
| 37 | By default, it detects Envoy instances running on localhost. |
| 38 | limits: |
| 39 | description: "" |
| 40 | performance_impact: |
| 41 | description: "" |
| 42 | setup: |
| 43 | prerequisites: |
| 44 | list: [] |
| 45 | configuration: |
| 46 | file: |
| 47 | name: go.d/envoy.conf |
| 48 | options: |
| 49 | description: | |
| 50 | The following options can be defined globally: update_every, autodetection_retry. |
| 51 | folding: |
| 52 | title: Config options |
| 53 | enabled: true |
| 54 | list: |
| 55 | - name: update_every |
| 56 | description: Data collection interval (seconds). |
| 57 | default_value: 1 |
| 58 | required: false |
| 59 | group: Collection |
| 60 | - name: autodetection_retry |
| 61 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 62 | default_value: 0 |
| 63 | required: false |
| 64 | group: Collection |
| 65 | |
| 66 | - name: url |
| 67 | description: Target endpoint URL. |
| 68 | default_value: http://127.0.0.1:9091/stats/prometheus |
| 69 | required: true |
| 70 | group: Target |
| 71 | - name: timeout |
| 72 | description: HTTP request timeout (seconds). |
| 73 | default_value: 1 |
| 74 | required: false |
| 75 | group: Target |
| 76 | |
| 77 | - name: username |
| 78 | description: Username for Basic HTTP authentication. |
| 79 | default_value: "" |
| 80 | required: false |
| 81 | group: HTTP Auth |
| 82 | - name: password |
| 83 | description: Password for Basic HTTP authentication. |
| 84 | default_value: "" |
| 85 | required: false |
| 86 | group: HTTP Auth |
| 87 | - name: bearer_token_file |
| 88 | description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)." |
| 89 | default_value: "" |
| 90 | required: false |
| 91 | group: HTTP Auth |
| 92 | |
| 93 | - name: tls_skip_verify |
| 94 | description: Skip TLS certificate and hostname verification (insecure). |
| 95 | default_value: no |
| 96 | required: false |
| 97 | group: TLS |
| 98 | - name: tls_ca |
| 99 | description: Path to CA bundle used to validate the server certificate. |
| 100 | default_value: "" |
| 101 | required: false |
| 102 | group: TLS |
| 103 | - name: tls_cert |
| 104 | description: Path to client TLS certificate (for mTLS). |
| 105 | default_value: "" |
| 106 | required: false |
| 107 | group: TLS |
| 108 | - name: tls_key |
| 109 | description: Path to client TLS private key (for mTLS). |
| 110 | default_value: "" |
| 111 | required: false |
| 112 | group: TLS |
| 113 | |
| 114 | - name: proxy_url |
| 115 | description: HTTP proxy URL. |
| 116 | default_value: "" |
| 117 | required: false |
| 118 | group: Proxy |
| 119 | - name: proxy_username |
| 120 | description: Username for proxy Basic HTTP authentication. |
| 121 | default_value: "" |
| 122 | required: false |
| 123 | group: Proxy |
| 124 | - name: proxy_password |
| 125 | description: Password for proxy Basic HTTP authentication. |
| 126 | default_value: "" |
| 127 | required: false |
| 128 | group: Proxy |
| 129 | |
| 130 | - name: method |
| 131 | description: HTTP method to use. |
| 132 | default_value: "GET" |
| 133 | required: false |
| 134 | group: Request |
| 135 | - name: body |
| 136 | description: Request body (e.g., for POST/PUT). |
| 137 | default_value: "" |
| 138 | required: false |
| 139 | group: Request |
| 140 | - name: headers |
| 141 | description: "Additional HTTP headers (one per line as key: value)." |
| 142 | default_value: "" |
| 143 | required: false |
| 144 | group: Request |
| 145 | - name: not_follow_redirects |
| 146 | description: Do not follow HTTP redirects. |
| 147 | default_value: no |
| 148 | required: false |
| 149 | group: Request |
| 150 | - name: force_http2 |
| 151 | description: Force HTTP/2 (including h2c over TCP). |
| 152 | default_value: no |
| 153 | required: false |
| 154 | group: Request |
| 155 | |
| 156 | - name: vnode |
| 157 | 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). |
| 158 | default_value: "" |
| 159 | required: false |
| 160 | group: Virtual Node |
| 161 | examples: |
| 162 | folding: |
| 163 | title: Config |
| 164 | enabled: true |
| 165 | list: |
| 166 | - name: Basic |
| 167 | folding: |
| 168 | enabled: false |
| 169 | description: A basic example configuration. |
| 170 | config: | |
| 171 | jobs: |
| 172 | - name: local |
| 173 | url: http://127.0.0.1:9901/stats/prometheus |
| 174 | - name: HTTP authentication |
| 175 | description: Basic HTTP authentication. |
| 176 | config: | |
| 177 | jobs: |
| 178 | - name: local |
| 179 | url: http://127.0.0.1:9901/stats/prometheus |
| 180 | username: username |
| 181 | password: password |
| 182 | - name: HTTPS with self-signed certificate |
| 183 | description: | |
| 184 | Do not validate server certificate chain and hostname. |
| 185 | config: | |
| 186 | jobs: |
| 187 | - name: local |
| 188 | url: https://127.0.0.1:9901/stats/prometheus |
| 189 | tls_skip_verify: yes |
| 190 | - name: Multi-instance |
| 191 | description: | |
| 192 | > **Note**: When you define multiple jobs, their names must be unique. |
| 193 | |
| 194 | Collecting metrics from local and remote instances. |
| 195 | config: | |
| 196 | jobs: |
| 197 | - name: local |
| 198 | url: http://127.0.0.1:9901/stats/prometheus |
| 199 | |
| 200 | - name: remote |
| 201 | url: http://192.0.2.1:9901/stats/prometheus |
| 202 | troubleshooting: |
| 203 | problems: |
| 204 | list: [] |
| 205 | alerts: [] |
| 206 | metrics: |
| 207 | folding: |
| 208 | title: Metrics |
| 209 | enabled: false |
| 210 | description: "" |
| 211 | availability: [] |
| 212 | scopes: |
| 213 | - name: global |
| 214 | description: Envoy exposes metrics in Prometheus format. All metric labels are added to charts. |
| 215 | labels: [] |
| 216 | metrics: |
| 217 | - name: envoy.server_state |
| 218 | description: Server current state |
| 219 | unit: state |
| 220 | chart_type: line |
| 221 | dimensions: |
| 222 | - name: live |
| 223 | - name: draining |
| 224 | - name: pre_initializing |
| 225 | - name: initializing |
| 226 | - name: envoy.server_connections_count |
| 227 | description: Server current connections |
| 228 | unit: connections |
| 229 | chart_type: line |
| 230 | dimensions: |
| 231 | - name: connections |
| 232 | - name: envoy.server_parent_connections_count |
| 233 | description: Server current parent connections |
| 234 | unit: connections |
| 235 | chart_type: line |
| 236 | dimensions: |
| 237 | - name: connections |
| 238 | - name: envoy.server_memory_allocated_size |
| 239 | description: Server memory allocated size |
| 240 | unit: bytes |
| 241 | chart_type: line |
| 242 | dimensions: |
| 243 | - name: allocated |
| 244 | - name: envoy.server_memory_heap_size |
| 245 | description: Server memory heap size |
| 246 | unit: bytes |
| 247 | chart_type: line |
| 248 | dimensions: |
| 249 | - name: heap |
| 250 | - name: envoy.server_memory_physical_size |
| 251 | description: Server memory physical size |
| 252 | unit: bytes |
| 253 | chart_type: line |
| 254 | dimensions: |
| 255 | - name: physical |
| 256 | - name: envoy.server_uptime |
| 257 | description: Server uptime |
| 258 | unit: seconds |
| 259 | chart_type: line |
| 260 | dimensions: |
| 261 | - name: uptime |
| 262 | - name: envoy.cluster_manager_cluster_count |
| 263 | description: Cluster manager current clusters |
| 264 | unit: clusters |
| 265 | chart_type: line |
| 266 | dimensions: |
| 267 | - name: active |
| 268 | - name: not_active |
| 269 | - name: envoy.cluster_manager_cluster_changes_rate |
| 270 | description: Cluster manager cluster changes |
| 271 | unit: clusters/s |
| 272 | chart_type: line |
| 273 | dimensions: |
| 274 | - name: added |
| 275 | - name: modified |
| 276 | - name: removed |
| 277 | - name: envoy.cluster_manager_cluster_updates_rate |
| 278 | description: Cluster manager updates |
| 279 | unit: updates/s |
| 280 | chart_type: line |
| 281 | dimensions: |
| 282 | - name: cluster |
| 283 | - name: envoy.cluster_manager_cluster_updated_via_merge_rate |
| 284 | description: Cluster manager updates applied as merged updates |
| 285 | unit: updates/s |
| 286 | chart_type: line |
| 287 | dimensions: |
| 288 | - name: via_merge |
| 289 | - name: envoy.cluster_manager_update_merge_cancelled_rate |
| 290 | description: Cluster manager cancelled merged updates |
| 291 | unit: updates/s |
| 292 | chart_type: line |
| 293 | dimensions: |
| 294 | - name: merge_cancelled |
| 295 | - name: envoy.cluster_manager_update_out_of_merge_window_rate |
| 296 | description: Cluster manager out of a merge window updates |
| 297 | unit: updates/s |
| 298 | chart_type: line |
| 299 | dimensions: |
| 300 | - name: out_of_merge_window |
| 301 | - name: envoy.cluster_membership_endpoints_count |
| 302 | description: Cluster membership current endpoints |
| 303 | unit: endpoints |
| 304 | chart_type: line |
| 305 | dimensions: |
| 306 | - name: healthy |
| 307 | - name: degraded |
| 308 | - name: excluded |
| 309 | - name: envoy.cluster_membership_changes_rate |
| 310 | description: Cluster membership changes |
| 311 | unit: changes/s |
| 312 | chart_type: line |
| 313 | dimensions: |
| 314 | - name: membership |
| 315 | - name: envoy.cluster_membership_updates_rate |
| 316 | description: Cluster membership updates |
| 317 | unit: updates/s |
| 318 | chart_type: line |
| 319 | dimensions: |
| 320 | - name: success |
| 321 | - name: failure |
| 322 | - name: empty |
| 323 | - name: no_rebuild |
| 324 | - name: envoy.cluster_upstream_cx_active_count |
| 325 | description: Cluster upstream current active connections |
| 326 | unit: connections |
| 327 | chart_type: line |
| 328 | dimensions: |
| 329 | - name: active |
| 330 | - name: envoy.cluster_upstream_cx_rate |
| 331 | description: Cluster upstream connections |
| 332 | unit: connections/s |
| 333 | chart_type: line |
| 334 | dimensions: |
| 335 | - name: created |
| 336 | - name: envoy.cluster_upstream_cx_http_rate |
| 337 | description: Cluster upstream connections by HTTP version |
| 338 | unit: connections/s |
| 339 | chart_type: line |
| 340 | dimensions: |
| 341 | - name: http1 |
| 342 | - name: http2 |
| 343 | - name: http3 |
| 344 | - name: envoy.cluster_upstream_cx_destroy_rate |
| 345 | description: Cluster upstream destroyed connections |
| 346 | unit: connections/s |
| 347 | chart_type: line |
| 348 | dimensions: |
| 349 | - name: local |
| 350 | - name: remote |
| 351 | - name: envoy.cluster_upstream_cx_connect_fail_rate |
| 352 | description: Cluster upstream failed connections |
| 353 | unit: connections/s |
| 354 | chart_type: line |
| 355 | dimensions: |
| 356 | - name: failed |
| 357 | - name: envoy.cluster_upstream_cx_connect_timeout_rate |
| 358 | description: Cluster upstream timed out connections |
| 359 | unit: connections/s |
| 360 | chart_type: line |
| 361 | dimensions: |
| 362 | - name: timeout |
| 363 | - name: envoy.cluster_upstream_cx_bytes_rate |
| 364 | description: Cluster upstream connection traffic |
| 365 | unit: bytes/s |
| 366 | chart_type: line |
| 367 | dimensions: |
| 368 | - name: received |
| 369 | - name: sent |
| 370 | - name: envoy.cluster_upstream_cx_bytes_buffered_size |
| 371 | description: Cluster upstream current connection buffered size |
| 372 | unit: bytes |
| 373 | chart_type: line |
| 374 | dimensions: |
| 375 | - name: received |
| 376 | - name: send |
| 377 | - name: envoy.cluster_upstream_rq_active_count |
| 378 | description: Cluster upstream current active requests |
| 379 | unit: requests |
| 380 | chart_type: line |
| 381 | dimensions: |
| 382 | - name: active |
| 383 | - name: envoy.cluster_upstream_rq_rate |
| 384 | description: Cluster upstream requests |
| 385 | unit: requests/s |
| 386 | chart_type: line |
| 387 | dimensions: |
| 388 | - name: requests |
| 389 | - name: envoy.cluster_upstream_rq_failed_rate |
| 390 | description: Cluster upstream failed requests |
| 391 | unit: requests/s |
| 392 | chart_type: line |
| 393 | dimensions: |
| 394 | - name: cancelled |
| 395 | - name: maintenance_mode |
| 396 | - name: timeout |
| 397 | - name: max_duration_reached |
| 398 | - name: per_try_timeout |
| 399 | - name: reset_local |
| 400 | - name: reset_remote |
| 401 | - name: envoy.cluster_upstream_rq_pending_active_count |
| 402 | description: Cluster upstream current active pending requests |
| 403 | unit: requests |
| 404 | chart_type: line |
| 405 | dimensions: |
| 406 | - name: active_pending |
| 407 | - name: envoy.cluster_upstream_rq_pending_rate |
| 408 | description: Cluster upstream pending requests |
| 409 | unit: requests/s |
| 410 | chart_type: line |
| 411 | dimensions: |
| 412 | - name: pending |
| 413 | - name: envoy.cluster_upstream_rq_pending_failed_rate |
| 414 | description: Cluster upstream failed pending requests |
| 415 | unit: requests/s |
| 416 | chart_type: line |
| 417 | dimensions: |
| 418 | - name: overflow |
| 419 | - name: failure_eject |
| 420 | - name: envoy.cluster_upstream_rq_retry_rate |
| 421 | description: Cluster upstream request retries |
| 422 | unit: retries/s |
| 423 | chart_type: line |
| 424 | dimensions: |
| 425 | - name: request |
| 426 | - name: envoy.cluster_upstream_rq_retry_success_rate |
| 427 | description: Cluster upstream request successful retries |
| 428 | unit: retries/s |
| 429 | chart_type: line |
| 430 | dimensions: |
| 431 | - name: success |
| 432 | - name: envoy.cluster_upstream_rq_retry_backoff_rate |
| 433 | description: Cluster upstream request backoff retries |
| 434 | unit: retries/s |
| 435 | chart_type: line |
| 436 | dimensions: |
| 437 | - name: exponential |
| 438 | - name: ratelimited |
| 439 | - name: envoy.listener_manager_listeners_count |
| 440 | description: Listener manager current listeners |
| 441 | unit: listeners |
| 442 | chart_type: line |
| 443 | dimensions: |
| 444 | - name: active |
| 445 | - name: warming |
| 446 | - name: draining |
| 447 | - name: envoy.listener_manager_listener_changes_rate |
| 448 | description: Listener manager listener changes |
| 449 | unit: listeners/s |
| 450 | chart_type: line |
| 451 | dimensions: |
| 452 | - name: added |
| 453 | - name: modified |
| 454 | - name: removed |
| 455 | - name: stopped |
| 456 | - name: envoy.listener_manager_listener_object_events_rate |
| 457 | description: Listener manager listener object events |
| 458 | unit: objects/s |
| 459 | chart_type: line |
| 460 | dimensions: |
| 461 | - name: create_success |
| 462 | - name: create_failure |
| 463 | - name: in_place_updated |
| 464 | - name: envoy.listener_admin_downstream_cx_active_count |
| 465 | description: Listener admin downstream current active connections |
| 466 | unit: connections |
| 467 | chart_type: line |
| 468 | dimensions: |
| 469 | - name: active |
| 470 | - name: envoy.listener_admin_downstream_cx_rate |
| 471 | description: Listener admin downstream connections |
| 472 | unit: connections/s |
| 473 | chart_type: line |
| 474 | dimensions: |
| 475 | - name: created |
| 476 | - name: envoy.listener_admin_downstream_cx_destroy_rate |
| 477 | description: Listener admin downstream destroyed connections |
| 478 | unit: connections/s |
| 479 | chart_type: line |
| 480 | dimensions: |
| 481 | - name: destroyed |
| 482 | - name: envoy.listener_admin_downstream_cx_transport_socket_connect_timeout_rate |
| 483 | description: Listener admin downstream timed out connections |
| 484 | unit: connections/s |
| 485 | chart_type: line |
| 486 | dimensions: |
| 487 | - name: timeout |
| 488 | - name: envoy.listener_admin_downstream_cx_rejected_rate |
| 489 | description: Listener admin downstream rejected connections |
| 490 | unit: connections/s |
| 491 | chart_type: line |
| 492 | dimensions: |
| 493 | - name: overflow |
| 494 | - name: overload |
| 495 | - name: global_overflow |
| 496 | - name: envoy.listener_admin_downstream_listener_filter_remote_close_rate |
| 497 | description: Listener admin downstream connections closed by remote when peek data for listener filters |
| 498 | unit: connections/s |
| 499 | chart_type: line |
| 500 | dimensions: |
| 501 | - name: closed |
| 502 | - name: envoy.listener_admin_downstream_listener_filter_error_rate |
| 503 | description: Listener admin downstream read errors when peeking data for listener filters |
| 504 | unit: errors/s |
| 505 | chart_type: line |
| 506 | dimensions: |
| 507 | - name: read |
| 508 | - name: envoy.listener_admin_downstream_pre_cx_active_count |
| 509 | description: Listener admin downstream current active sockets |
| 510 | unit: sockets |
| 511 | chart_type: line |
| 512 | dimensions: |
| 513 | - name: active |
| 514 | - name: envoy.listener_admin_downstream_pre_cx_timeout_rate |
| 515 | description: Listener admin downstream timed out sockets |
| 516 | unit: sockets/s |
| 517 | chart_type: line |
| 518 | dimensions: |
| 519 | - name: timeout |
| 520 | - name: envoy.listener_downstream_cx_active_count |
| 521 | description: Listener downstream current active connections |
| 522 | unit: connections |
| 523 | chart_type: line |
| 524 | dimensions: |
| 525 | - name: active |
| 526 | - name: envoy.listener_downstream_cx_rate |
| 527 | description: Listener downstream connections |
| 528 | unit: connections/s |
| 529 | chart_type: line |
| 530 | dimensions: |
| 531 | - name: created |
| 532 | - name: envoy.listener_downstream_cx_destroy_rate |
| 533 | description: Listener downstream destroyed connections |
| 534 | unit: connections/s |
| 535 | chart_type: line |
| 536 | dimensions: |
| 537 | - name: destroyed |
| 538 | - name: envoy.listener_downstream_cx_transport_socket_connect_timeout_rate |
| 539 | description: Listener downstream timed out connections |
| 540 | unit: connections/s |
| 541 | chart_type: line |
| 542 | dimensions: |
| 543 | - name: timeout |
| 544 | - name: envoy.listener_downstream_cx_rejected_rate |
| 545 | description: Listener downstream rejected connections |
| 546 | unit: connections/s |
| 547 | chart_type: line |
| 548 | dimensions: |
| 549 | - name: overflow |
| 550 | - name: overload |
| 551 | - name: global_overflow |
| 552 | - name: envoy.listener_downstream_listener_filter_remote_close_rate |
| 553 | description: Listener downstream connections closed by remote when peek data for listener filters |
| 554 | unit: connections/s |
| 555 | chart_type: line |
| 556 | dimensions: |
| 557 | - name: closed |
| 558 | - name: envoy.listener_downstream_listener_filter_error_rate |
| 559 | description: Listener downstream read errors when peeking data for listener filters |
| 560 | unit: errors/s |
| 561 | chart_type: line |
| 562 | dimensions: |
| 563 | - name: read |
| 564 | - name: envoy.listener_downstream_pre_cx_active_count |
| 565 | description: Listener downstream current active sockets |
| 566 | unit: sockets |
| 567 | chart_type: line |
| 568 | dimensions: |
| 569 | - name: active |
| 570 | - name: envoy.listener_downstream_pre_cx_timeout_rate |
| 571 | description: Listener downstream timed out sockets |
| 572 | unit: sockets/s |
| 573 | chart_type: line |
| 574 | dimensions: |
| 575 | - name: timeout |