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