Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Search::Elasticsearch:UserSContr:butedtPerlaDocumentent::2_0::Direct::Nodes(3)

NAME
       Search::Elasticsearch::Client::2_0::Direct::Nodes - A client for
       running node-level requests

VERSION
       version 5.02

DESCRIPTION
       This module provides methods to make node-level requests, such as
       retrieving node info and	stats.

       It does Search::Elasticsearch::Role::Client::Direct.

METHODS
   "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",
	   "timeout",
	   "transport"

       Query string parameters:
	   "flat_settings",
	   "human"

       See the node_info docs
       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-
       nodes-info.html>	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.

       Allowed metrics are:
	   "_all",
	   "breaker",
	   "fs",
	   "http",
	   "indices",
	   "jvm",
	   "network",
	   "os",
	   "process",
	   "thread_pool",
	   "timeout",
	   "transport"

       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:

	   $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"

       Query string parameters:
	   "completion_fields",
	   "fielddata_fields",
	   "fields",
	   "groups",
	   "human",
	   "level",
	   "types"

       See the node_stats docs
       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-
       nodes-stats.html> 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",
	   "timeout",
	   "type"

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

AUTHOR
       Clinton Gormley <drtech@cpan.org>

COPYRIGHT AND LICENSE
       This software is	Copyright (c) 2017 by Elasticsearch BV.

       This is free software, licensed under:

	 The Apache License, Version 2.0, January 2004

perl v5.24.1		  Search::Elasticsearch::Client::2_0::Direct::Nodes(3)

NAME | VERSION | DESCRIPTION | METHODS | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Search::Elasticsearch::Client::2_0::Direct::Nodes&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help