Search...::Nodes(3pm)

📦 version 7.715, in ubuntu jammy

✨ Search...::Nodes ✨

okay bestie, gather round, because this is the 3pm manpage for Search::Elasticsearch::Client::7_0::Direct::Nodes and it's literally your backstage pass to everything node-level in your cluster 💅

🌸 VERSION 🌸

version 7.715 — yes, that's the one, don't @ me.

💖 DESCRIPTION 💖

This module is the plug for making node-level requests — think stuff like pulling node info and node stats. That's the whole vibe.

It does Search::Elasticsearch::Role::Client::Direct, iykyk 🫶

🎀 METHODS 🎀

info()

$response = $e->nodes->info(
    node_id => $node_id | \@node_ids       # optional
    metric  => $metric  | \@metrics        # optional
);

The info() method hands you the static information about the nodes in your cluster — like the configured max number of file handles, the max configured heap size, or the threadpool settings. It's giving "tell me about yourself" but for nodes 🌸

Allowed metrics are:

  • http
  • jvm
  • network
  • os
  • plugin
  • process
  • settings
  • thread_pool
  • timeout
  • transport

Query string parameters:

  • error_trace
  • flat_settings
  • human

See the node_info docs at http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html for more info 👑

stats()

$response = $e->nodes->stats(
    node_id      => $node_id    | \@node_ids       # optional
    metric       => $metric     | \@metrics        # optional
    index_metric => $ind_metric | \@ind_metrics    # optional
);

The stats() method spills the statistics about the nodes in your cluster — how many file handles are currently open, the current heap memory usage, the current number of threads in use. The receipts, basically 🧾✨

Stats can come back for all nodes, or you can limit it to particular nodes with the node_id parameter. By default all metrics are returned, but you can limit them to whatever you name in the metric parameter.

Allowed metrics are:

  • _all
  • breaker
  • fs
  • http
  • include_segment_file_sizes
  • indices
  • jvm
  • network
  • os
  • process
  • thread_pool
  • timeout
  • transport

If you specify the indices metric (or _all), then indices_stats information comes back on a per-node basis. Which indices stats get returned is controlled with the index_metric parameter:

$response = $e->nodes->stats(
    node_id       => 'node_1',
    metric        => ['indices','fs']
    index_metric  => ['docs','fielddata']
);

Allowed index metrics are:

  • _all
  • completion
  • docs
  • fielddata
  • filter_cache
  • flush
  • get
  • id_cache
  • indexing
  • merge
  • percolate
  • query_cache
  • refresh
  • search
  • segments
  • store
  • warmer

Query string parameters:

  • completion_fields
  • error_trace
  • fielddata_fields
  • fields
  • groups
  • human
  • level
  • types

See the stats docs at http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html for more info 🔥

hot_threads()

$response = $e->nodes->hot_threads(
    node_id => $node_id | \@node_ids       # optional
)

The hot_threads() method is the tool for diagnosing busy nodes. It takes a snapshot of which threads are eating the most CPU. Main character energy for your overloaded node, fr fr 😤

Query string parameters:

  • error_trace
  • human
  • ignore_idle_threads
  • interval
  • snapshots
  • threads
  • timeout
  • type

See the hot_threads docs at http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html for more info 💀

reload_secure_settings()

$response = $e->nodes->reload_secure_settings(
    node_id => $node_id | \@node_ids    # optional
);

The reload_secure_settings() API will reload the reloadable settings stored in the keystore on each node. Glow-up for your keystore, no restart required 🎀

Query string parameters:

  • error_trace
  • filter_path
  • human
  • timeout

See the reload-secure-settings docs at https://www.elastic.co/guide/en/elasticsearch/reference/current/secure-settings.html for more info 🔐

usage()

$response = $e->nodes->usage(
    node_id => $node_id | \@node_ids       # optional
    metric  => $metric  | \@metrics        # optional
)

The usage() API retrieve sinformation on the usage of features for each node. (that's "retrieves information", bestie, the manpage just tripped over its own feet there 😭 we're keeping it real)

Query string parameters:

  • error_trace
  • human
  • timeout

See the nodes_usage docs at https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-usage.html for more info 🌈

💜 AUTHOR 💜

Enrico Zimuel <enrico.zimuel@elastic.co> — icon, legend, the moment 👑

This software is Copyright (c) 2021 by Elasticsearch BV.

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

and that's the whole page, bestie — perl v5.32.1, dated 2021-10-23, brought to you by the good people at Search...::Nodes(3pm). go forth and query your nodes, slay 💅✨🦋

📦 where this page comes from