from .client import BaseClient
[docs]class NodesClient(BaseClient):
[docs] def node_info(self, node_id=None, metric=None, params={}, callback=None, **kwargs):
"""
The cluster nodes info API allows to retrieve one or more (or all) of
the cluster nodes information.
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-info.html>`_
:arg node_id: A comma-separated list of node IDs or names to limit the
returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all
nodes
:arg metric: A comma-separated list of metrics you wish returned. Leave
empty to return all. Choices are "settings", "os", "process",
"jvm", "thread_pool", "network", "transport", "http", "plugin"
:arg flat_settings: Return settings in flat format (default: false)
:arg human: Whether to return time and byte values in human-readable
format., default False
"""
query_params = ('flat_settings', 'human',)
params = self._filter_params(query_params, params)
url = self.mk_url(*['_nodes', node_id, metric], **params)
self.client.fetch(
self.mk_req(url, method='GET', **kwargs),
callback = callback
)
[docs] def node_shutdown(self, node_id=None, params={}, callback=None, **kwargs):
"""
The nodes shutdown API allows to shutdown one or more (or all) nodes in
the cluster.
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-shutdown.html>`_
:arg node_id: A comma-separated list of node IDs or names to perform the
operation on; use `_local` to perform the operation on the node
you're connected to, leave empty to perform the operation on all
nodes
:arg delay: Set the delay for the operation (default: 1s)
:arg exit: Exit the JVM as well (default: true)
"""
query_params = ('delay', 'exit',)
params = self._filter_params(query_params, params)
url = self.mk_url(*['_cluster', 'nodes', node_id, '_shutdown'], **params)
self.client.fetch(
self.mk_req(url, method='POST', **kwargs),
callback = callback
)
[docs] def node_stats(self, node_id=None, metric=None, index_metric=None, params={}, callback=None, **kwargs):
"""
The cluster nodes stats API allows to retrieve one or more (or all) of
the cluster nodes statistics.
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html>`_
:arg node_id: A comma-separated list of node IDs or names to limit the
returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all
nodes
:arg metric: Limit the information returned to the specified metrics.
Possible options are: "_all", "breaker", "fs", "http", "indices",
"jvm", "network", "os", "process", "thread_pool", "transport"
:arg index_metric: Limit the information returned for `indices` metric
to the specific index metrics. Isn't used if `indices` (or `all`)
metric isn't specified. Possible options are: "_all", "completion",
"docs", "fielddata", "filter_cache", "flush", "get", "id_cache",
"indexing", "merge", "percolate", "refresh", "search", "segments",
"store", "warmer"
:arg completion_fields: A comma-separated list of fields for `fielddata`
and `suggest` index metric (supports wildcards)
:arg fielddata_fields: A comma-separated list of fields for `fielddata`
index metric (supports wildcards)
:arg fields: A comma-separated list of fields for `fielddata` and
`completion` index metric (supports wildcards)
:arg groups: A comma-separated list of search groups for `search` index
metric
:arg human: Whether to return time and byte values in human-readable
format., default False
:arg level: Return indices stats aggregated at node, index or shard
level, default 'node'
:arg types: A comma-separated list of document types for the `indexing`
index metric
"""
query_params = (
'completion_fields', 'fielddata_fields', 'fields', 'groups',
'human', 'level', 'types',
)
params = self._filter_params(query_params, params)
url = self.mk_url(*[
'_nodes', node_id, 'stats', metric, index_metric
],
**params
)
self.client.fetch(
self.mk_req(url, method='GET', **kwargs),
callback = callback
)
[docs] def node_hot_threads(self, node_id=None, params={}, callback=None, **kwargs):
"""
An API allowing to get the current hot threads on each node in the cluster.
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html>`_
:arg node_id: A comma-separated list of node IDs or names to limit the
returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all
nodes
:arg type_: The type to sample (default: cpu)
:arg interval: The interval for the second sampling of threads
:arg snapshots: Number of samples of thread stacktrace (default: 10)
:arg threads: Specify the number of threads to provide information for
(default: 3)
"""
query_params = ('type_', 'interval', 'snapshots', 'threads',)
# avoid python reserved words
if params and 'type_' in params:
params['type'] = params.pop('type_')
params = self._filter_params(query_params, params)
url = self.mk_url(*['_nodes', node_id, 'hot_threads'], **params)
self.client.fetch(
self.mk_req(url, method='GET', **kwargs),
callback = callback
)