Search::Elasticsearch::Client::1_0::Direct::Nodes - A client for running node-level requests
version 6.81
This module provides methods to make node-level requests, such as retrieving node info and stats.
It does Search::Elasticsearch::Role::Client::Direct.
info()
$response = $e->nodes->info( node_id => $node_id | \@node_ids # optional metric => $metric | \@metrics # optional );
The info() method returns static information about the nodes in the cluster, such as the configured maximum number of file handles, the maximum configured heap size or the threadpool settings.
Allowed metrics are: http, jvm, network, os, plugin, process, settings, thread_pool, transport
http
jvm
network
os
plugin
process
settings
thread_pool
transport
Query string parameters: flat_settings, human
flat_settings
human
See the node_info docs for more information.
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 returns statistics about the nodes in the cluster, such as the number of currently open file handles, the current heap memory usage or the current number of threads in use.
Stats can be returned for all nodes, or limited to particular nodes with the node_id parameter. By default all metrics are returned, but these can be limited to those specified in the metric parameter.
node_id
metric
Allowed metrics are: _all, breaker, fs, http, indices, jvm, network, os, process, thread_pool, transport
_all
breaker
fs
indices
If the indices metric (or _all) is specified, then indices_stats information is returned on a per-node basis. Which indices stats are returned can be controlled with the index_metric parameter:
index_metric
$response = $e->cluster->node_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
completion
docs
fielddata
filter_cache
flush
get
id_cache
indexing
merge
percolate
query_cache
refresh
search
segments
store
warmer
Query string parameters: completion_fields, fielddata_fields, fields, groups, human, level, types
completion_fields
fielddata_fields
fields
groups
level
types
See the node_stats docs for more information.
hot_threads()
$response = $e->nodes->hot_threads( node_id => $node_id | \@node_ids # optional )
The hot_threads() method is a useful tool for diagnosing busy nodes. It takes a snapshot of which threads are consuming the most CPU.
Query string parameters: ignore_idle_threads, interval, snapshots, threads, type
ignore_idle_threads
interval
snapshots
threads
type
See the hot_threads docs for more information.
shutdown()
$e->nodes->shutdown( node_id => $node_id | \@node_ids # optional );
The shutdown() method is used to shutdown one or more nodes, or the whole cluster.
Query string parameters: delay, exit
delay
exit
See the shutdown docs for more information.
Enrico Zimuel <enrico.zimuel@elastic.co>
This software is Copyright (c) 2020 by Elasticsearch BV.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
To install Search::Elasticsearch::Client::1_0, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Search::Elasticsearch::Client::1_0
CPAN shell
perl -MCPAN -e shell install Search::Elasticsearch::Client::1_0
For more information on module installation, please visit the detailed CPAN module installation guide.