github.com/netdata/go.d.plugin@v0.58.1/modules/elasticsearch/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - &module 4 meta: &meta 5 id: collector-go.d.plugin-elasticsearch 6 module_name: elasticsearch 7 plugin_name: go.d.plugin 8 monitored_instance: 9 name: Elasticsearch 10 link: https://www.elastic.co/elasticsearch/ 11 icon_filename: elasticsearch.svg 12 categories: 13 - data-collection.search-engines 14 keywords: 15 - elastic 16 - elasticsearch 17 - opensearch 18 - search engine 19 related_resources: 20 integrations: 21 list: 22 - plugin_name: apps.plugin 23 module_name: apps 24 - plugin_name: cgroups.plugin 25 module_name: cgroups 26 info_provided_to_referring_integrations: 27 description: "" 28 most_popular: true 29 overview: 30 data_collection: 31 metrics_description: | 32 This collector monitors the performance and health of the Elasticsearch cluster. 33 method_description: | 34 It uses [Cluster APIs](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html) to collect metrics. 35 36 Used endpoints: 37 38 | Endpoint | Description | API | 39 |------------------------|----------------------|-------------------------------------------------------------------------------------------------------------| 40 | `/` | Node info | | 41 | `/_nodes/stats` | Nodes metrics | [Nodes stats API](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html) | 42 | `/_nodes/_local/stats` | Local node metrics | [Nodes stats API](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html) | 43 | `/_cluster/health` | Cluster health stats | [Cluster health API](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html) | 44 | `/_cluster/stats` | Cluster metrics | [Cluster stats API](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.html) | 45 supported_platforms: 46 include: [] 47 exclude: [] 48 multi_instance: true 49 additional_permissions: 50 description: "" 51 default_behavior: 52 auto_detection: 53 description: | 54 By default, it detects instances running on localhost by attempting to connect to port 9200: 55 56 - http://127.0.0.1:9200 57 - https://127.0.0.1:9200 58 limits: 59 description: | 60 By default, this collector monitors only the node it is connected to. To monitor all cluster nodes, set the `cluster_mode` configuration option to `yes`. 61 performance_impact: 62 description: "" 63 setup: 64 prerequisites: 65 list: [] 66 configuration: 67 file: 68 name: "go.d/elasticsearch.conf" 69 options: 70 description: | 71 The following options can be defined globally: update_every, autodetection_retry. 72 folding: 73 title: Config options 74 enabled: true 75 list: 76 - name: update_every 77 description: Data collection frequency. 78 default_value: 5 79 required: false 80 - name: autodetection_retry 81 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 82 default_value: 0 83 required: false 84 - name: url 85 description: Server URL. 86 default_value: http://127.0.0.1:9200 87 required: true 88 - name: cluster_mode 89 description: Controls whether to collect metrics for all nodes in the cluster or only for the local node. 90 default_value: "false" 91 required: false 92 - name: collect_node_stats 93 description: Controls whether to collect nodes metrics. 94 default_value: "true" 95 required: false 96 - name: collect_cluster_health 97 description: Controls whether to collect cluster health metrics. 98 default_value: "true" 99 required: false 100 - name: collect_cluster_stats 101 description: Controls whether to collect cluster stats metrics. 102 default_value: "true" 103 required: false 104 - name: collect_indices_stats 105 description: Controls whether to collect indices metrics. 106 default_value: "false" 107 required: false 108 - name: timeout 109 description: HTTP request timeout. 110 default_value: 5 111 required: false 112 - name: username 113 description: Username for basic HTTP authentication. 114 default_value: "" 115 required: false 116 - name: password 117 description: Password for basic HTTP authentication. 118 default_value: "" 119 required: false 120 - name: proxy_url 121 description: Proxy URL. 122 default_value: "" 123 required: false 124 - name: proxy_username 125 description: Username for proxy basic HTTP authentication. 126 default_value: "" 127 required: false 128 - name: proxy_password 129 description: Password for proxy basic HTTP authentication. 130 default_value: "" 131 required: false 132 - name: method 133 description: HTTP request method. 134 default_value: "GET" 135 required: false 136 - name: body 137 description: HTTP request body. 138 default_value: "" 139 required: false 140 - name: headers 141 description: HTTP request headers. 142 default_value: "" 143 required: false 144 - name: not_follow_redirects 145 description: Redirect handling policy. Controls whether the client follows redirects. 146 default_value: no 147 required: false 148 - name: tls_skip_verify 149 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 150 default_value: no 151 required: false 152 - name: tls_ca 153 description: Certification authority that the client uses when verifying the server's certificates. 154 default_value: "" 155 required: false 156 - name: tls_cert 157 description: Client TLS certificate. 158 default_value: "" 159 required: false 160 - name: tls_key 161 description: Client TLS key. 162 default_value: "" 163 required: false 164 examples: 165 folding: 166 title: Config 167 enabled: true 168 list: 169 - name: Basic single node mode 170 description: A basic example configuration. 171 folding: 172 enabled: false 173 config: | 174 jobs: 175 - name: local 176 url: http://127.0.0.1:9200 177 - name: Cluster mode 178 description: Cluster mode example configuration. 179 config: | 180 jobs: 181 - name: local 182 url: http://127.0.0.1:9200 183 cluster_mode: yes 184 - name: HTTP authentication 185 description: Basic HTTP authentication. 186 config: | 187 jobs: 188 - name: local 189 url: http://127.0.0.1:9200 190 username: username 191 password: password 192 - name: HTTPS with self-signed certificate 193 description: Elasticsearch with enabled HTTPS and self-signed certificate. 194 config: | 195 jobs: 196 - name: local 197 url: https://127.0.0.1:9200 198 tls_skip_verify: yes 199 - name: Multi-instance 200 description: | 201 > **Note**: When you define multiple jobs, their names must be unique. 202 203 Collecting metrics from local and remote instances. 204 config: | 205 jobs: 206 - name: local 207 url: http://127.0.0.1:9200 208 209 - name: remote 210 url: http://192.0.2.1:9200 211 troubleshooting: 212 problems: 213 list: [] 214 alerts: 215 - name: elasticsearch_node_indices_search_time_query 216 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/elasticsearch.conf 217 metric: elasticsearch.node_indices_search_time 218 info: search performance is degraded, queries run slowly. 219 - name: elasticsearch_node_indices_search_time_fetch 220 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/elasticsearch.conf 221 metric: elasticsearch.node_indices_search_time 222 info: search performance is degraded, fetches run slowly. 223 - name: elasticsearch_cluster_health_status_red 224 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/elasticsearch.conf 225 metric: elasticsearch.cluster_health_status 226 info: cluster health status is red. 227 - name: elasticsearch_cluster_health_status_yellow 228 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/elasticsearch.conf 229 metric: elasticsearch.cluster_health_status 230 info: cluster health status is yellow. 231 - name: elasticsearch_node_index_health_red 232 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/elasticsearch.conf 233 metric: elasticsearch.node_index_health 234 info: node index $label:index health status is red. 235 metrics: 236 folding: 237 title: Metrics 238 enabled: false 239 description: "" 240 availability: [] 241 scopes: 242 - name: node 243 description: These metrics refer to the cluster node. 244 labels: 245 - name: cluster_name 246 description: | 247 Name of the cluster. Based on the [Cluster name setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name). 248 - name: node_name 249 description: | 250 Human-readable identifier for the node. Based on the [Node name setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#node-name). 251 - name: host 252 description: | 253 Network host for the node, based on the [Network host setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#network.host). 254 metrics: 255 - name: elasticsearch.node_indices_indexing 256 description: Indexing Operations 257 unit: operations/s 258 chart_type: line 259 dimensions: 260 - name: index 261 - name: elasticsearch.node_indices_indexing_current 262 description: Indexing Operations Current 263 unit: operations 264 chart_type: line 265 dimensions: 266 - name: index 267 - name: elasticsearch.node_indices_indexing_time 268 description: Time Spent On Indexing Operations 269 unit: milliseconds 270 chart_type: line 271 dimensions: 272 - name: index 273 - name: elasticsearch.node_indices_search 274 description: Search Operations 275 unit: operations/s 276 chart_type: stacked 277 dimensions: 278 - name: queries 279 - name: fetches 280 - name: elasticsearch.node_indices_search_current 281 description: Search Operations Current 282 unit: operations 283 chart_type: stacked 284 dimensions: 285 - name: queries 286 - name: fetches 287 - name: elasticsearch.node_indices_search_time 288 description: node_indices_search_time 289 unit: milliseconds 290 chart_type: stacked 291 dimensions: 292 - name: queries 293 - name: fetches 294 - name: elasticsearch.node_indices_refresh 295 description: Refresh Operations 296 unit: operations/s 297 chart_type: line 298 dimensions: 299 - name: refresh 300 - name: elasticsearch.node_indices_refresh_time 301 description: Time Spent On Refresh Operations 302 unit: milliseconds 303 chart_type: line 304 dimensions: 305 - name: refresh 306 - name: elasticsearch.node_indices_flush 307 description: Flush Operations 308 unit: operations/s 309 chart_type: line 310 dimensions: 311 - name: flush 312 - name: elasticsearch.node_indices_flush_time 313 description: Time Spent On Flush Operations 314 unit: milliseconds 315 chart_type: line 316 dimensions: 317 - name: flush 318 - name: elasticsearch.node_indices_fielddata_memory_usage 319 description: Fielddata Cache Memory Usage 320 unit: bytes 321 chart_type: area 322 dimensions: 323 - name: used 324 - name: elasticsearch.node_indices_fielddata_evictions 325 description: Fielddata Evictions 326 unit: operations/s 327 chart_type: line 328 dimensions: 329 - name: evictions 330 - name: elasticsearch.node_indices_segments_count 331 description: Segments Count 332 unit: segments 333 chart_type: line 334 dimensions: 335 - name: segments 336 - name: elasticsearch.node_indices_segments_memory_usage_total 337 description: Segments Memory Usage Total 338 unit: bytes 339 chart_type: line 340 dimensions: 341 - name: used 342 - name: elasticsearch.node_indices_segments_memory_usage 343 description: Segments Memory Usage 344 unit: bytes 345 chart_type: stacked 346 dimensions: 347 - name: terms 348 - name: stored_fields 349 - name: term_vectors 350 - name: norms 351 - name: points 352 - name: doc_values 353 - name: index_writer 354 - name: version_map 355 - name: fixed_bit_set 356 - name: elasticsearch.node_indices_translog_operations 357 description: Translog Operations 358 unit: operations 359 chart_type: area 360 dimensions: 361 - name: total 362 - name: uncommitted 363 - name: elasticsearch.node_indices_translog_size 364 description: Translog Size 365 unit: bytes 366 chart_type: area 367 dimensions: 368 - name: total 369 - name: uncommitted 370 - name: elasticsearch.node_file_descriptors 371 description: Process File Descriptors 372 unit: fd 373 chart_type: line 374 dimensions: 375 - name: open 376 - name: elasticsearch.node_jvm_heap 377 description: JVM Heap Percentage Currently in Use 378 unit: percentage 379 chart_type: area 380 dimensions: 381 - name: inuse 382 - name: elasticsearch.node_jvm_heap_bytes 383 description: JVM Heap Commit And Usage 384 unit: bytes 385 chart_type: area 386 dimensions: 387 - name: committed 388 - name: used 389 - name: elasticsearch.node_jvm_buffer_pools_count 390 description: JVM Buffer Pools Count 391 unit: pools 392 chart_type: line 393 dimensions: 394 - name: direct 395 - name: mapped 396 - name: elasticsearch.node_jvm_buffer_pool_direct_memory 397 description: JVM Buffer Pool Direct Memory 398 unit: bytes 399 chart_type: area 400 dimensions: 401 - name: total 402 - name: used 403 - name: elasticsearch.node_jvm_buffer_pool_mapped_memory 404 description: JVM Buffer Pool Mapped Memory 405 unit: bytes 406 chart_type: area 407 dimensions: 408 - name: total 409 - name: used 410 - name: elasticsearch.node_jvm_gc_count 411 description: JVM Garbage Collections 412 unit: gc/s 413 chart_type: stacked 414 dimensions: 415 - name: young 416 - name: old 417 - name: elasticsearch.node_jvm_gc_time 418 description: JVM Time Spent On Garbage Collections 419 unit: milliseconds 420 chart_type: stacked 421 dimensions: 422 - name: young 423 - name: old 424 - name: elasticsearch.node_thread_pool_queued 425 description: Thread Pool Queued Threads Count 426 unit: threads 427 chart_type: stacked 428 dimensions: 429 - name: generic 430 - name: search 431 - name: search_throttled 432 - name: get 433 - name: analyze 434 - name: write 435 - name: snapshot 436 - name: warmer 437 - name: refresh 438 - name: listener 439 - name: fetch_shard_started 440 - name: fetch_shard_store 441 - name: flush 442 - name: force_merge 443 - name: management 444 - name: elasticsearch.node_thread_pool_rejected 445 description: Thread Pool Rejected Threads Count 446 unit: threads 447 chart_type: stacked 448 dimensions: 449 - name: generic 450 - name: search 451 - name: search_throttled 452 - name: get 453 - name: analyze 454 - name: write 455 - name: snapshot 456 - name: warmer 457 - name: refresh 458 - name: listener 459 - name: fetch_shard_started 460 - name: fetch_shard_store 461 - name: flush 462 - name: force_merge 463 - name: management 464 - name: elasticsearch.node_cluster_communication_packets 465 description: Cluster Communication 466 unit: pps 467 chart_type: line 468 dimensions: 469 - name: received 470 - name: sent 471 - name: elasticsearch.node_cluster_communication_traffic 472 description: Cluster Communication Bandwidth 473 unit: bytes/s 474 chart_type: line 475 dimensions: 476 - name: received 477 - name: sent 478 - name: elasticsearch.node_http_connections 479 description: HTTP Connections 480 unit: connections 481 chart_type: line 482 dimensions: 483 - name: open 484 - name: elasticsearch.node_breakers_trips 485 description: Circuit Breaker Trips Count 486 unit: trips/s 487 chart_type: stacked 488 dimensions: 489 - name: requests 490 - name: fielddata 491 - name: in_flight_requests 492 - name: model_inference 493 - name: accounting 494 - name: parent 495 - name: cluster 496 description: These metrics refer to the cluster. 497 labels: 498 - name: cluster_name 499 description: | 500 Name of the cluster. Based on the [Cluster name setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name). 501 metrics: 502 - name: elasticsearch.cluster_health_status 503 description: Cluster Status 504 unit: status 505 chart_type: line 506 dimensions: 507 - name: green 508 - name: yellow 509 - name: red 510 - name: elasticsearch.cluster_number_of_nodes 511 description: Cluster Nodes Count 512 unit: nodes 513 chart_type: line 514 dimensions: 515 - name: nodes 516 - name: data_nodes 517 - name: elasticsearch.cluster_shards_count 518 description: Cluster Shards Count 519 unit: shards 520 chart_type: line 521 dimensions: 522 - name: active_primary 523 - name: active 524 - name: relocating 525 - name: initializing 526 - name: unassigned 527 - name: delayed_unaasigned 528 - name: elasticsearch.cluster_pending_tasks 529 description: Cluster Pending Tasks 530 unit: tasks 531 chart_type: line 532 dimensions: 533 - name: pending 534 - name: elasticsearch.cluster_number_of_in_flight_fetch 535 description: Cluster Unfinished Fetches 536 unit: fetches 537 chart_type: line 538 dimensions: 539 - name: in_flight_fetch 540 - name: elasticsearch.cluster_indices_count 541 description: Cluster Indices Count 542 unit: indices 543 chart_type: line 544 dimensions: 545 - name: indices 546 - name: elasticsearch.cluster_indices_shards_count 547 description: Cluster Indices Shards Count 548 unit: shards 549 chart_type: line 550 dimensions: 551 - name: total 552 - name: primaries 553 - name: replication 554 - name: elasticsearch.cluster_indices_docs_count 555 description: Cluster Indices Docs Count 556 unit: docs 557 chart_type: line 558 dimensions: 559 - name: docs 560 - name: elasticsearch.cluster_indices_store_size 561 description: Cluster Indices Store Size 562 unit: bytes 563 chart_type: line 564 dimensions: 565 - name: size 566 - name: elasticsearch.cluster_indices_query_cache 567 description: Cluster Indices Query Cache 568 unit: events/s 569 chart_type: line 570 dimensions: 571 - name: hit 572 - name: miss 573 - name: elasticsearch.cluster_nodes_by_role_count 574 description: Cluster Nodes By Role Count 575 unit: nodes 576 chart_type: line 577 dimensions: 578 - name: coordinating_only 579 - name: data 580 - name: data_cold 581 - name: data_content 582 - name: data_frozen 583 - name: data_hot 584 - name: data_warm 585 - name: ingest 586 - name: master 587 - name: ml 588 - name: remote_cluster_client 589 - name: voting_only 590 - name: index 591 description: These metrics refer to the index. 592 labels: 593 - name: cluster_name 594 description: | 595 Name of the cluster. Based on the [Cluster name setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name). 596 - name: index 597 description: Name of the index. 598 metrics: 599 - name: elasticsearch.node_index_health 600 description: Index Health 601 unit: status 602 chart_type: line 603 dimensions: 604 - name: green 605 - name: yellow 606 - name: red 607 - name: elasticsearch.node_index_shards_count 608 description: Index Shards Count 609 unit: shards 610 chart_type: line 611 dimensions: 612 - name: shards 613 - name: elasticsearch.node_index_docs_count 614 description: Index Docs Count 615 unit: docs 616 chart_type: line 617 dimensions: 618 - name: docs 619 - name: elasticsearch.node_index_store_size 620 description: Index Store Size 621 unit: bytes 622 chart_type: line 623 dimensions: 624 - name: store_size 625 - <<: *module 626 meta: 627 <<: *meta 628 id: collector-go.d.plugin-opensearch 629 monitored_instance: 630 name: OpenSearch 631 link: https://opensearch.org/ 632 icon_filename: opensearch.svg 633 categories: 634 - data-collection.search-engines