8.2 节点管理 (Nodes API)

8.2 节点管理 (Nodes API)

Elasticsearch.x 节点管理 (Nodes API) 详解与实践

1. Nodes API 概述

Nodes API 是一组 RESTful 接口，用于检索集群中一个或多个节点的信息。这些信息涵盖了节点的各种层面，从基础的操作系统和 JVM 状态，到 Elasticsearch 特有的索引、分片、线程池、插件模块等运行指标。通过调用不同的 Nodes API 端点，我们可以获取不同粒度和维度的节点数据，从而全面了解集群的运行状况。

Nodes API 的主要功能包括：

• 监控节点状态: 实时获取节点的健康状态、连接信息、版本信息等。

• 检索节点统计信息: 获取节点的 CPU、内存、磁盘、网络等资源使用情况，以及索引、分片、查询、缓存等 Elasticsearch 内部指标。

• 诊断节点性能: 分析节点的活跃线程、JVM 堆栈信息，定位性能瓶颈。

• 管理节点配置: 查看节点的配置信息，例如 JVM 参数、路径配置、网络配置等。

• 触发节点操作: 执行一些节点级别的操作，例如清除缓存、重新加载安全设置等。

Nodes API 提供了丰富的接口，使得集群管理和运维工作更加高效和便捷。熟练掌握 Nodes API 的使用，是成为一名优秀的 Elasticsearch 管理员的必备技能。

2. 常用 Nodes API 详解与实践

Elasticsearch的 Nodes API 提供了众多端点，以下将对一些最常用的 API 进行详细介绍，并结合实际的代码示例进行演示。

2.1. /_nodes API - 获取节点基本信息

/_nodes API 是最基础的节点信息接口，它可以返回集群中所有节点或者指定节点的基本信息，例如节点名称、节点 ID、传输地址、版本信息、角色信息等。

请求方式: GET

端点: /_nodes 或 /_nodes/{node_id} 或 /_nodes/{nodes}

• /_nodes: 返回集群中所有节点的信息。

• /_nodes/{node_id}: 返回指定 node_id 的节点信息。可以使用逗号分隔多个 node_id。

• /_nodes/{nodes}: 可以使用节点名称或通配符来指定节点，例如 /_nodes/node-1,node-2 或 /_nodes/data-*。

代码示例 (cURL):

获取所有节点的基本信息:

curl -X GET "localhost:9200/_nodes?pretty"
​

获取指定节点 ID 的信息:

curl -X GET "localhost:9200/_nodes/node-1?pretty"
​

获取指定节点名称的信息:

curl -X GET "localhost:9200/_nodes/data-*?pretty"
​

响应示例 (部分):

{
  "_nodes" : {
    "total" : 3,
    "successful" : 3,
    "failed" : 0
  },
  "cluster_name" : "elasticsearch",
  "nodes" : {
    "node-1" : {
      "name" : "node-1",
      "transport_address" : "192.168.1.10:9300",
      "host" : "192.168.1.10",
      "ip" : "192.168.1.10",
      "version" : "8.8.0",
      "build_flavor" : "default",
      "build_type" : "tar",
      "build_hash" : "...",
      "roles" : [
        "master",
        "data",
        "ingest",
        "ml",
        "remote_cluster_client"
      ],
      "attributes" : {
        "ml.machine_memory" : "16777216000",
        "ml.max_open_jobs" : "512",
        "xpack.installed" : "true"
      },
      "settings" : { ... } // 节点配置信息
    },
    "node-2" : { ... },
    "node-3" : { ... }
  }
}
​

响应字段解释 (部分):

• _nodes.total: 集群节点总数。

• _nodes.successful: 成功获取信息的节点数。

• _nodes.failed: 获取信息失败的节点数。

• cluster_name: 集群名称。

• nodes: 节点信息列表，键为节点 ID。

• nodes.{node_id}.name: 节点名称。

• nodes.{node_id}.transport_address: 节点传输地址。

• nodes.{node_id}.host: 节点主机名。

• nodes.{node_id}.ip: 节点 IP 地址。

• nodes.{node_id}.version: Elasticsearch 版本。

• nodes.{node_id}.roles: 节点角色 (master, data, ingest 等)。

• nodes.{node_id}.attributes: 节点属性 (例如 ml.machine_memory, xpack.installed)。

• nodes.{node_id}.settings: 节点的配置信息 (可以通过 /_nodes/settings API 单独获取)。

应用场景:

• 集群概览: 快速了解集群中节点的数量、版本、角色分布等基本情况。

• 节点定位: 通过节点 ID 或名称查找特定节点的信息。

• 版本兼容性检查: 确认集群中所有节点版本是否一致，避免版本兼容性问题。

• 角色分布监控: 监控集群中不同角色的节点数量是否符合预期。

2.2. /_nodes/stats API - 获取节点统计信息

/_nodes/stats API 用于获取节点的详细统计信息，包括 CPU 使用率、内存使用率、磁盘空间使用率、网络流量、索引统计、分片统计、查询统计、JVM 统计、线程池统计等等。它是监控和分析节点性能的关键 API。

请求方式: GET

端点: /_nodes/stats 或 /_nodes/{node_id}/stats 或 /_nodes/stats/{metric} 或 /_nodes/{node_id}/stats/{metric}

• /_nodes/stats: 返回集群中所有节点的所有统计信息。

• /_nodes/{node_id}/stats: 返回指定 node_id 节点的全部统计信息。

• /_nodes/stats/{metric}: 返回集群中所有节点的指定 metric 统计信息。{metric} 可以是逗号分隔的指标列表，例如 jvm,fs,os。

• /_nodes/{node_id}/stats/{metric}: 返回指定 node_id 节点的指定 metric 统计信息。

常用的 {metric} 包括:

• jvm: JVM 统计信息 (内存池、垃圾回收、线程等)。

• fs: 文件系统统计信息 (磁盘空间使用率、磁盘 IO 等)。

• os: 操作系统统计信息 (CPU 使用率、内存使用率、负载均衡等)。

• indices: 索引统计信息 (索引数量、文档数量、存储大小、分片数量等)。

• thread_pool: 线程池统计信息 (活跃线程数、队列长度、拒绝任务数等)。

• process: 进程统计信息 (CPU 时间、内存使用量、打开文件描述符等)。

• http: HTTP 统计信息 (请求数、错误数等)。

• transport: 传输层统计信息 (接收/发送字节数、连接数等)。

• Breakers: 断路器统计信息 (内存使用量、限制值等)。

• adaptive_selection: 自适应选择统计信息 (仅适用于 coordinating 节点)。

代码示例 (cURL):

获取所有节点的全部统计信息:

curl -X GET "localhost:9200/_nodes/stats?pretty"
​

获取指定节点的 JVM 和 OS 统计信息:

curl -X GET "localhost:9200/_nodes/node-1/stats/jvm,os?pretty"
​

获取所有节点的索引统计信息:

curl -X GET "localhost:9200/_nodes/stats/indices?pretty"
​

响应示例 (部分 - JVM 统计):

{
  "_nodes" : { ... },
  "cluster_name" : "elasticsearch",
  "nodes" : {
    "node-1" : {
      "jvm" : {
        "timestamp" : 1678886400000,
        "uptime_in_millis" : 3600000,
        "mem" : {
          "heap_used_in_bytes" : 536870912,
          "heap_used_percent" : 30,
          "heap_committed_in_bytes" : 1782579200,
          "heap_max_in_bytes" : 1782579200,
          "non_heap_used_in_bytes" : 157286400,
          "non_heap_committed_in_bytes" : 188743680,
          "pools" : {
            "young" : { ... },
            "survivor" : { ... },
            "old" : { ... }
          }
        },
        "threads" : {
          "count" : 150,
          "peak_count" : 200
        },
        "gc" : {
          "collectors" : {
            "young" : {
              "collection_count" : 100,
              "collection_time_in_millis" : 1000
            },
            "old" : {
              "collection_count" : 10,
              "collection_time_in_millis" : 500
            }
          }
        },
        "buffer_pools" : { ... },
        "classes" : { ... }
      }
    },
    "node-2" : { ... },
    "node-3" : { ... }
  }
}
​

响应字段解释 (部分 - JVM 统计):

• jvm.mem.heap_used_in_bytes: JVM 堆内存已使用字节数。

• jvm.mem.heap_used_percent: JVM 堆内存已使用百分比。

• jvm.mem.heap_committed_in_bytes: JVM 堆内存已提交字节数。

• jvm.mem.heap_max_in_bytes: JVM 堆内存最大字节数。

• jvm.threads.count: JVM 当前线程数。

• jvm.threads.peak_count: JVM 峰值线程数。

• jvm.gc.collectors.young.collection_count: Young GC 次数。

• jvm.gc.collectors.young.collection_time_in_millis: Young GC 总耗时 (毫秒)。

• jvm.gc.collectors.old.collection_count: Old GC 次数。

• jvm.gc.collectors.old.collection_time_in_millis: Old GC 总耗时 (毫秒)。

应用场景:

• 性能监控: 实时监控节点的 CPU、内存、磁盘等资源使用情况，以及 JVM 堆内存、GC 频率等指标，及时发现性能瓶颈。

• 容量规划: 根据节点的资源使用率和索引增长趋势，评估集群的容量是否足够，提前进行扩容规划。

• 故障排查: 当集群出现性能问题或异常时，通过分析节点的统计信息，定位问题根源。例如，高 CPU 使用率可能与查询负载过高有关，高 JVM 堆内存使用率可能与内存配置不足或内存泄漏有关。

• 性能优化: 通过分析节点的统计信息，识别性能瓶颈，例如慢查询、频繁 GC 等，并采取相应的优化措施，例如优化查询语句、调整 JVM 参数等。

2.3. /_nodes/hot_threads API - 获取节点热线程信息

/_nodes/hot_threads API 用于获取节点的活跃线程信息，它可以帮助我们快速定位节点上的性能瓶颈，例如哪些线程正在消耗大量的 CPU 时间，哪些线程处于阻塞状态。

请求方式: GET

端点: /_nodes/hot_threads 或 /_nodes/{node_id}/hot_threads

• /_nodes/hot_threads: 返回集群中所有节点的热线程信息。

• /_nodes/{node_id}/hot_threads: 返回指定 node_id 节点的热线程信息。

常用查询参数:

• type: 线程类型，默认为 cpu，可选值包括 cpu, wait, block.

  • cpu: 按 CPU 使用率排序。

  • wait: 按等待时间排序。

  • block: 按阻塞时间排序。

• interval: 采样间隔，默认为 500ms。

• threads: 返回的线程数，默认为 3。

• ignore_idle_threads: 是否忽略空闲线程，默认为 true。

• snapshots: 采样的快照数，默认为 10。

• timeout: 请求超时时间，默认为 10s。

代码示例 (cURL):

获取所有节点的热线程信息 (默认配置):

curl -X GET "localhost:9200/_nodes/hot_threads?pretty"
​

获取指定节点的 CPU 热线程信息，返回 10 个线程，采样间隔 1 秒:

curl -X GET "localhost:9200/_nodes/node-1/hot_threads?type=cpu&threads=10&interval=1s&pretty"
​

响应示例 (部分):

::: node-1
::: {node-1}{...}{192.168.1.10}{192.168.1.10:9300}{master}{ml.machine_memory=16777216000, ml.max_open_jobs=512, xpack.installed=true}
   7.1% cpu usage, state: RUNNABLE, 1 total snapshots, 10 samples in stack traces
     Thread "elasticsearch[node-1][generic][T#1]"
        java.base@17.0.7/java.net.SocketInputStream.socketRead0(Native Method)
        java.base@17.0.7/java.net.SocketInputStream.socketRead(SocketInputStream.java:110)
        java.base@17.0.7/java.net.SocketInputStream.read(SocketInputStream.java:168)
        java.base@17.0.7/java.net.SocketInputStream.read(SocketInputStream.java:140)
        org.elasticsearch.transport.netty4.Netty4TcpChannel.read(Netty4TcpChannel.java:115)
        org.elasticsearch.transport.netty4.Netty4TcpChannel.read(Netty4TcpChannel.java:39)
        org.elasticsearch.transport.netty4.Netty4Transport.inboundMessage(Netty4Transport.java:212)
        org.elasticsearch.transport.netty4.Netty4Transport.inboundMessage(Netty4Transport.java:76)
        org.elasticsearch.transport.netty4.Netty4Transport.lambda$handleIncomingMessage$0(Netty4Transport.java:170)
        org.elasticsearch.transport.netty4.Netty4Transport$$Lambda$2105/0x000000080146e840.handleIncomingMessage(Unknown Source)
        org.elasticsearch.common.util.concurrent.ThreadContext$ContextPreservingRunnable.run(ThreadContext.java:152)
        java.base@17.0.7/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1136)
        java.base@17.0.7/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635)
        java.base@17.0.7/java.lang.Thread.run(Thread.java:833)
​

响应字段解释 (部分):

• ::: node-{node_id}: 节点信息头部，显示节点名称、ID、地址等。

• 7.1% cpu usage: 线程的 CPU 使用率。

• state: RUNNABLE: 线程状态 (例如 RUNNABLE, WAITING, BLOCKED)。

• Thread "elasticsearch[node-1][generic][T#1]": 线程名称。

• java.base@17.0.7/java.net.SocketInputStream.socketRead0(Native Method) ... : 线程堆栈信息，显示线程正在执行的代码路径。

应用场景:

• 性能瓶颈定位: 快速定位节点上 CPU 密集型或 IO 密集型的线程，找出性能瓶颈的根源。例如，如果发现大量的线程处于 RUNNABLE 状态且 CPU 使用率很高，可能意味着查询负载过高；如果发现大量的线程处于 WAITING 或 BLOCKED 状态，可能意味着线程被锁或资源竞争。

• 死锁检测: 通过分析线程堆栈信息，可以检测集群中是否发生死锁，帮助排查死锁问题。

• 长时间运行任务监控: 监控长时间运行的任务 (例如索引构建、快照备份等) 的线程状态，了解任务的执行进度和性能状况。

2.4. 其他常用的 Nodes API

除了上述三个常用的 API 之外，Nodes API 还提供了许多其他的端点，用于获取更细粒度的节点信息。以下列举一些常用的 API 及其功能简述:

• /_nodes/settings: 获取节点的配置信息。可以指定要返回的配置项，例如 /_nodes/settings?flat_settings=true&include_defaults=true。

• /_nodes/plugins: 获取节点上安装的插件列表。

• /_nodes/modules: 获取节点上加载的模块列表。

• /_nodes/usage: 获取节点上 API 的使用统计信息。

• /_nodes/reload_secure_settings: 重新加载节点的安全设置。

• /_nodes/clear_cache: 清除节点的缓存 (例如索引缓存、查询缓存)。

• /_nodes/process: 获取节点进程信息 (例如进程 ID, CPU 时间, 内存使用量)。

• /_nodes/jvm: 获取节点的 JVM 信息 (等同于 /_nodes/stats/jvm)。

• /_nodes/os: 获取节点的操作系统信息 (等同于 /_nodes/stats/os)。

• /_nodes/thread_pool: 获取节点的线程池信息 (等同于 /_nodes/stats/thread_pool)。

• /_nodes/fs: 获取节点的文件系统信息 (等同于 /_nodes/stats/fs)。

• /_nodes/http: 获取节点的 HTTP 信息 (等同于 /_nodes/stats/http)。

• /_nodes/transport: 获取节点的传输层信息 (等同于 /_nodes/stats/transport)。

这些 API 的使用方式与上述示例类似，可以通过 cURL 或 Elasticsearch 客户端进行调用。读者可以根据实际需求，查阅 Elasticsearch 官方文档，了解更多 Nodes API 的详细信息和使用方法。

3. Nodes API 的应用场景与最佳实践

Nodes API 在 Elasticsearch 集群管理与运维中扮演着至关重要的角色。以下总结一些 Nodes API 的典型应用场景和最佳实践:

应用场景:

• 集群监控系统集成: Nodes API 提供了丰富的监控指标，可以方便地集成到 Prometheus, Grafana, Zabbix 等监控系统中，实现对 Elasticsearch 集群的实时监控和告警。

• 自动化运维脚本开发: 可以使用 Nodes API 编写自动化运维脚本，例如自动扩容、自动故障转移、自动性能调优等，提高运维效率，降低人工操作风险。

• 性能分析工具开发: 基于 Nodes API 可以开发更高级的 Elasticsearch 性能分析工具，例如慢查询分析器、热点索引分析器、资源瓶颈分析器等，帮助用户深入了解集群性能状况，进行精细化调优。

• 安全审计与合规: Nodes API 可以用于审计集群的安全配置和操作行为，例如查看节点配置、插件列表、用户认证信息等，满足安全合规要求。

最佳实践:

• 按需获取指标: 避免一次性获取所有节点的全部统计信息，只获取需要的指标，减少网络传输和 Elasticsearch 集群的压力。可以使用 /_nodes/stats/{metric} 或 /_nodes/{node_id}/stats/{metric} API，并指定需要的 {metric}。

• 合理设置采样频率: 监控指标的采样频率需要根据实际需求和集群规模进行权衡。过高的采样频率会增加集群负载，过低的采样频率可能无法及时发现问题。对于实时性要求较高的指标 (例如 CPU 使用率、内存使用率)，可以设置较高的采样频率；对于变化频率较低的指标 (例如节点配置、插件列表)，可以设置较低的采样频率。

• 使用节点选择器: 当只需要获取部分节点的信息时，可以使用节点 ID 或节点名称选择器，例如 /_nodes/node-1,node-2/stats 或 /_nodes/data-*/stats，减少不必要的数据传输。

• 关注关键指标: 在监控和分析节点信息时，需要重点关注一些关键指标，例如 CPU 使用率、内存使用率、磁盘空间使用率、JVM 堆内存使用率、GC 频率、索引速率、查询延迟等。这些指标直接反映了集群的健康状况和性能水平。

• 结合其他 API 使用: Nodes API 可以与其他 Elasticsearch API 结合使用，例如 Cluster API, Indices API 等，实现更全面的集群管理和运维功能。例如，可以使用 Cluster API 获取集群健康状态，使用 Indices API 获取索引信息，再结合 Nodes API 获取节点信息，进行综合分析和决策。

• 安全访问控制: Nodes API 提供了敏感信息，例如节点配置、线程堆栈等，需要进行严格的安全访问控制。建议启用 Elasticsearch 安全功能，配置合适的角色和权限，限制对 Nodes API 的访问。

4. Nodes API 相关 Mermaid 图

以下使用 Mermaid 的 graph TD 图，简单展示 Nodes API 在 Elasticsearch 集群管理和运维中的角色和关系:

图示说明:

• Elasticsearch Cluster 代表 Elasticsearch 集群，包含多个节点 (Node A, Node B, Node C)。

• Nodes API 是 Elasticsearch 提供的节点管理接口，可以访问集群中各个节点的信息。

• Nodes API 将节点信息提供给 监控系统、自动化运维脚本、性能分析工具 以及 管理员/运维人员。

• 监控系统 可以将 Nodes API 获取的指标可视化展示，并进行告警。

• 自动化运维脚本 可以基于 Nodes API 实现集群的自动化管理和运维。

• 性能分析工具 可以利用 Nodes API 深入分析集群性能问题。

• 管理员/运维人员 可以通过 Nodes API 直接了解集群状态，进行手动管理和运维操作。

5. 总结

掌握 Nodes API 是成为一名合格 Elasticsearch 管理员的重要一步。在实际工作中，我们需要根据具体的场景和需求，灵活运用 Nodes API，结合其他 Elasticsearch 功能，构建高效、稳定、安全的 Elasticsearch 集群。建议读者深入阅读 Elasticsearch 官方文档，持续学习和实践，不断提升自身的技术水平。