Module: Elasticsearch::API::Cat::Actions

Included in:: CatClient

Defined in:: lib/elasticsearch/api/namespace/cat.rb,
lib/elasticsearch/api/actions/cat/help.rb,
lib/elasticsearch/api/actions/cat/count.rb,
lib/elasticsearch/api/actions/cat/nodes.rb,
lib/elasticsearch/api/actions/cat/health.rb,
lib/elasticsearch/api/actions/cat/master.rb,
lib/elasticsearch/api/actions/cat/shards.rb,
lib/elasticsearch/api/actions/cat/aliases.rb,
lib/elasticsearch/api/actions/cat/indices.rb,
lib/elasticsearch/api/actions/cat/recovery.rb,
lib/elasticsearch/api/actions/cat/fielddata.rb,
lib/elasticsearch/api/actions/cat/allocation.rb,
lib/elasticsearch/api/actions/cat/thread_pool.rb,
lib/elasticsearch/api/actions/cat/pending_tasks.rb

Instance Method Summary collapse

#aliases(arguments = {}) ⇒ Object

Returns information about aliases, including associated routing values and filters.
#allocation(arguments = {}) ⇒ Object

Return shard allocation information.
#count(arguments = {}) ⇒ Object

Return document counts for the entire cluster or specific indices.
#fielddata(arguments = {}) ⇒ Object

Return information about field data usage across the cluster.
#health(arguments = {}) ⇒ Object

Display a terse version of the Elasticsearch::API::Cluster::Actions#health API output.
#help(arguments = {}) ⇒ Object

Help information for the Cat API.
#indices(arguments = {}) ⇒ Object

Return the most important statistics about indices, across the cluster nodes.
#master(arguments = {}) ⇒ Object

Display basic information about the master node.
#nodes(arguments = {}) ⇒ Object

Display information about cluster topology and nodes statistics.
#pending_tasks(arguments = {}) ⇒ Object

Display the information from the Elasticsearch::API::Cluster::Actions#pending_tasks API in a tabular format.
#recovery(arguments = {}) ⇒ Object

Display information about the recovery process (allocating shards).
#shards(arguments = {}) ⇒ Object

Display shard allocation across nodes.
#thread_pool(arguments = {}) ⇒ Object

Display thread pool statistics across nodes (use the ‘help` parameter to display a list of avaialable thread pools).

Instance Method Details

#aliases(arguments = {}) ⇒ `Object`

Returns information about aliases, including associated routing values and filters.

Examples:

Display all aliases in the cluster


puts client.cat.aliases

Display indices for the ‘year-2013’ alias


puts client.cat.aliases name: 'year-2013'

Display header names in the output


puts client.cat.aliases v: true

Return only the ‘alias’ and ‘index’ columns


puts client.cat.aliases h: ['alias', 'index']

Return only the ‘alias’ and ‘index’ columns, using short names


puts client.cat.aliases h: 'a,i'

Return the information as Ruby objects


client.cat.aliases format: 'json'

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:name (List) —

A comma-separated list of alias names to return
:h (List) —

Comma-separated list of column names to display – see the ‘help` argument
:v (Boolean) —

Display column headers as part of the output
:format (String) —

The output format. Options: ‘text’, ‘json’; default: ‘text’
:help (Boolean) —

Return information about headers
:local (Boolean) —

Return local information, do not retrieve the state from master node (default: false)
:master_timeout (Time) —

Explicit operation timeout for connection to master node

See Also:

http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-aliases.html

# File 'lib/elasticsearch/api/actions/cat/aliases.rb', line 43

def aliases(arguments={})
  valid_params = [
    :local,
    :master_timeout,
    :h,
    :help,
    :v ]

  name = arguments.delete(:name)

  method = 'GET'

  path   = Utils.__pathify '_cat/aliases', Utils.__listify(name)

  params = Utils.__validate_and_extract_params arguments, valid_params
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body   = nil

  perform_request(method, path, params, body).body
end

#allocation(arguments = {}) ⇒ `Object`

Return shard allocation information

Examples:

Display allocation for all nodes in the cluster


puts client.cat.allocation

Display allocation for node with name ‘node-1’


puts client.cat.allocation node_id: 'node-1'

Display header names in the output


puts client.cat.allocation v: true

Display only specific columns in the output (see the ‘help` parameter)


puts client.cat.allocation h: ['node', 'shards', 'disk.percent']

Display only specific columns in the output, using the short names


puts client.cat.allocation h: 'n,s,dp'

Return the information as Ruby objects


client.cat.allocation format: 'json'

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:node_id (List) —

A comma-separated list of node IDs or names to limit the returned information
:bytes (String) —

The unit in which to display byte values (options: b, k, m, g)
:h (List) —

Comma-separated list of column names to display – see the ‘help` argument
:v (Boolean) —

Display column headers as part of the output
:format (String) —

The output format. Options: ‘text’, ‘json’; default: ‘text’
:help (Boolean) —

Return information about headers
:local (Boolean) —

Return local information, do not retrieve the state from master node (default: false)
:master_timeout (Time) —

Explicit operation timeout for connection to master node

See Also:

http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-allocation.html

# File 'lib/elasticsearch/api/actions/cat/allocation.rb', line 44

def allocation(arguments={})
  valid_params = [
    :bytes,
    :local,
    :master_timeout,
    :h,
    :help,
    :v ]

  node_id = arguments.delete(:node_id)

  method = 'GET'

  path   = Utils.__pathify '_cat/allocation', Utils.__listify(node_id)

  params = Utils.__validate_and_extract_params arguments, valid_params
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body   = nil

  perform_request(method, path, params, body).body
end

#count(arguments = {}) ⇒ `Object`

Return document counts for the entire cluster or specific indices

Examples:

Display number of documents in the cluster


puts client.cat.count

Display number of documents in an index


puts client.cat.count index: 'index-a'

Display number of documents in a list of indices


puts client.cat.count index: ['index-a', 'index-b']

Display header names in the output


puts client.cat.count v: true

Return the information as Ruby objects


client.cat.count format: 'json'

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (List) —

A comma-separated list of index names to limit the returned information
:h (List) —

Comma-separated list of column names to display – see the ‘help` argument
:v (Boolean) —

Display column headers as part of the output
:format (String) —

The output format. Options: ‘text’, ‘json’; default: ‘text’
:help (Boolean) —

Return information about headers
:local (Boolean) —

Return local information, do not retrieve the state from master node (default: false)
:master_timeout (Time) —

Explicit operation timeout for connection to master node

See Also:

http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-count.html

# File 'lib/elasticsearch/api/actions/cat/count.rb', line 39

def count(arguments={})
  valid_params = [
    :local,
    :master_timeout,
    :h,
    :help,
    :v ]

  index = arguments.delete(:index)

  method = 'GET'

  path   = Utils.__pathify '_cat/count', Utils.__listify(index)

  params = Utils.__validate_and_extract_params arguments, valid_params
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body   = nil

  perform_request(method, path, params, body).body
end

#fielddata(arguments = {}) ⇒ `Object`

Return information about field data usage across the cluster

Examples:

Return the total size of field data


client.cat.fielddata

Return both the total size and size for specific fields


client.cat.fielddata fields: 'title,body'

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:fields (List) —

A comma-separated list of fields to include in the output
:bytes (String) —

The unit in which to display byte values (options: b, k, m, g)
:local (Boolean) —

Return local information, do not retrieve the state from master node (default: false)
:master_timeout (Time) —

Explicit operation timeout for connection to master node
:h (List) —

Comma-separated list of column names to display
:help (Boolean) —

Return help information
:v (Boolean) —

Verbose mode. Display column headers

See Also:

http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-fielddata.html

# File 'lib/elasticsearch/api/actions/cat/fielddata.rb', line 27

def fielddata(arguments={})
  valid_params = [
    :bytes,
    :local,
    :master_timeout,
    :h,
    :help,
    :v,
    :fields ]

  fields = arguments.delete(:fields)

  method = 'GET'
  path   = Utils.__pathify "_cat/fielddata", Utils.__listify(fields)
  params = Utils.__validate_and_extract_params arguments, valid_params
  body   = nil

  perform_request(method, path, params, body).body
end

#health(arguments = {}) ⇒ `Object`

Display a terse version of the Elasticsearch::API::Cluster::Actions#health API output

Examples:

Display cluster health


puts client.cat.health

Display header names in the output


puts client.cat.health v: true

Return the information as Ruby objects


client.cat.health format: 'json'

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:ts (Boolean) —

Whether to display timestamp information
:h (List) —

Comma-separated list of column names to display – see the ‘help` argument
:v (Boolean) —

Display column headers as part of the output
:format (String) —

The output format. Options: ‘text’, ‘json’; default: ‘text’
:help (Boolean) —

Return information about headers
:local (Boolean) —

Return local information, do not retrieve the state from master node (default: false)
:master_timeout (Time) —

Explicit operation timeout for connection to master node

See Also:

http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-health.html

# File 'lib/elasticsearch/api/actions/cat/health.rb', line 31

def health(arguments={})
  valid_params = [
    :local,
    :master_timeout,
    :h,
    :help,
    :ts,
    :v ]

  method = 'GET'
  path   = "_cat/health"
  params = Utils.__validate_and_extract_params arguments, valid_params
  params[:h] = Utils.__listify(params[:h]) if params[:h]
  body   = nil

  perform_request(method, path, params, body).body
end

#help(arguments = {}) ⇒ `Object`

Help information for the Cat API

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:help (Boolean) —

Return help information

See Also:

http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html

# File 'lib/elasticsearch/api/actions/cat/help.rb', line 12

def help(arguments={})
  valid_params = [
    :help ]
  method = 'GET'
  path   = "_cat"
  params = Utils.__validate_and_extract_params arguments, valid_params
  body   = nil

  perform_request(method, path, params, body).body
end

#indices(arguments = {}) ⇒ `Object`

Return the most important statistics about indices, across the cluster nodes

Use the ‘help` parameter to display available statistics.

Examples:

Display information for all indices


puts client.cat.indices

Display information for a specific index


puts client.cat.indices index: 'index-a'

Display information for indices matching a pattern


puts client.cat.indices index: 'index-*'

Display header names in the output


puts client.cat.indices v: true

Display only specific columns in the output (see the ‘help` parameter)


puts client.cat.indices h: ['index', 'docs.count', 'fielddata.memory_size', 'filter_cache.memory_size']

Display only specific columns in the output, using the short names


puts client.cat.indices h: 'i,dc,ss,mt', v: true

Return the information as Ruby objects


client.cat.indices format: 'json'

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (List) —

A comma-separated list of index names to limit the returned information
:bytes (String) —

The unit in which to display byte values (options: b, k, m, g)
:pri (Boolean) —

Limit the returned information on primary shards only (default: false)
:h (List) —

Comma-separated list of column names to display – see the ‘help` argument
:v (Boolean) —

Display column headers as part of the output
:format (String) —

The output format. Options: ‘text’, ‘json’; default: ‘text’
:help (Boolean) —

Return information about headers
:local (Boolean) —

Return local information, do not retrieve the state from master node (default: false)
:master_timeout (Time) —

Explicit operation timeout for connection to master node

See Also:

http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-indices.html

# File 'lib/elasticsearch/api/actions/cat/indices.rb', line 51

def indices(arguments={})
  valid_params = [
    :bytes,
    :local,
    :master_timeout,
    :h,
    :help,
    :pri,
    :v ]

  index = arguments.delete(:index)

  method = 'GET'

  path   = Utils.__pathify '_cat/indices', Utils.__listify(index)

  params = Utils.__validate_and_extract_params arguments, valid_params
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body   = nil

  perform_request(method, path, params, body).body
end

#master(arguments = {}) ⇒ `Object`

Display basic information about the master node

Examples:


puts client.cat.master

Display header names in the output


puts client.cat.master v: true

Return the information as Ruby objects


client.cat.master format: 'json'

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:h (List) —

Comma-separated list of column names to display – see the ‘help` argument
:v (Boolean) —

Display column headers as part of the output
:format (String) —

The output format. Options: ‘text’, ‘json’; default: ‘text’
:help (Boolean) —

Return information about headers
:local (Boolean) —

Return local information, do not retrieve the state from master node (default: false)
:master_timeout (Time) —

Explicit operation timeout for connection to master node

See Also:

http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-master.html

# File 'lib/elasticsearch/api/actions/cat/master.rb', line 30

def master(arguments={})
  valid_params = [
    :local,
    :master_timeout,
    :h,
    :help,
    :v ]

  method = 'GET'
  path   = "_cat/master"
  params = Utils.__validate_and_extract_params arguments, valid_params
  body   = nil

  perform_request(method, path, params, body).body
end

#nodes(arguments = {}) ⇒ `Object`

Display information about cluster topology and nodes statistics

Examples:

Display basic information about nodes in the cluster (host, node name, memory usage, master, etc.)


puts client.cat.nodes

Display header names in the output


puts client.cat.nodes v: true

Display only specific columns in the output (see the ‘help` parameter)


puts client.cat.nodes h: %w(name version jdk disk.avail heap.percent load merges.total_time), v: true

Display only specific columns in the output, using the short names


puts client.cat.nodes h: 'n,v,j,d,hp,l,mtt', v: true

Return the information as Ruby objects


client.cat.nodes format: 'json'

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:h (List) —

Comma-separated list of column names to display – see the ‘help` argument
:v (Boolean) —

Display column headers as part of the output
:format (String) —

The output format. Options: ‘text’, ‘json’; default: ‘text’
:help (Boolean) —

Return information about headers
:local (Boolean) —

Return local information, do not retrieve the state from master node (default: false)
:master_timeout (Time) —

Explicit operation timeout for connection to master node

See Also:

http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-nodes.html

# File 'lib/elasticsearch/api/actions/cat/nodes.rb', line 38

def nodes(arguments={})
  valid_params = [
    :local,
    :master_timeout,
    :h,
    :help,
    :v ]

  method = 'GET'
  path   = "_cat/nodes"

  params = Utils.__validate_and_extract_params arguments, valid_params
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body   = nil

  perform_request(method, path, params, body).body
end

#pending_tasks(arguments = {}) ⇒ `Object`

Display the information from the Elasticsearch::API::Cluster::Actions#pending_tasks API in a tabular format

Examples:


puts client.cat.pending_tasks

Display header names in the output


puts client.cat.pending_tasks v: true

Return the information as Ruby objects


client.cat.pending_tasks format: 'json'

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:h (List) —

Comma-separated list of column names to display – see the ‘help` argument
:v (Boolean) —

Display column headers as part of the output
:format (String) —

The output format. Options: ‘text’, ‘json’; default: ‘text’
:help (Boolean) —

Return information about headers
:local (Boolean) —

Return local information, do not retrieve the state from master node (default: false)
:master_timeout (Time) —

Explicit operation timeout for connection to master node

See Also:

http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-pending-tasks.html

# File 'lib/elasticsearch/api/actions/cat/pending_tasks.rb', line 30

def pending_tasks(arguments={})
  valid_params = [
    :local,
    :master_timeout,
    :h,
    :help,
    :v ]

  method = 'GET'
  path   = "_cat/pending_tasks"
  params = Utils.__validate_and_extract_params arguments, valid_params
  params[:h] = Utils.__listify(params[:h]) if params[:h]
  body   = nil

  perform_request(method, path, params, body).body
end

#recovery(arguments = {}) ⇒ `Object`

Display information about the recovery process (allocating shards)

Examples:

Display information for all indices


puts client.cat.recovery

Display information for a specific index


puts client.cat.recovery index: 'index-a'

Display information for indices matching a pattern


puts client.cat.recovery index: 'index-*'

Display header names in the output


puts client.cat.recovery v: true

Display only specific columns in the output (see the ‘help` parameter)


puts client.cat.recovery h: ['node', 'index', 'shard', 'percent']

Display only specific columns in the output, using the short names


puts client.cat.recovery h: 'n,i,s,per'

Return the information as Ruby objects


client.cat.recovery format: 'json'

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (List) —

A comma-separated list of index names to limit the returned information
:bytes (String) —

The unit in which to display byte values (options: b, k, m, g)
:h (List) —

Comma-separated list of column names to display – see the ‘help` argument
:v (Boolean) —

Display column headers as part of the output
:format (String) —

The output format. Options: ‘text’, ‘json’; default: ‘text’
:help (Boolean) —

Return information about headers
:local (Boolean) —

Return local information, do not retrieve the state from master node (default: false)
:master_timeout (Time) —

Explicit operation timeout for connection to master node

See Also:

http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-recovery.html

# File 'lib/elasticsearch/api/actions/cat/recovery.rb', line 48

def recovery(arguments={})
  valid_params = [
    :bytes,
    :local,
    :master_timeout,
    :h,
    :help,
    :v ]

  index = arguments.delete(:index)

  method = 'GET'

  path   = Utils.__pathify '_cat/recovery', Utils.__listify(index)

  params = Utils.__validate_and_extract_params arguments, valid_params
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body   = nil

  perform_request(method, path, params, body).body
end

#shards(arguments = {}) ⇒ `Object`

Display shard allocation across nodes

Examples:

Display information for all indices


puts client.cat.shards

Display information for a specific index


puts client.cat.shards index: 'index-a'

Display information for a list of indices


puts client.cat.shards index: ['index-a', 'index-b']

Display header names in the output


puts client.cat.shards v: true

Display only specific columns in the output (see the ‘help` parameter)


puts client.cat.shards h: ['node', 'index', 'shard', 'prirep', 'docs', 'store', 'merges.total']

Display only specific columns in the output, using the short names


puts client.cat.shards h: 'n,i,s,p,d,sto,mt'

Return the information as Ruby objects


client.cat.shards format: 'json'

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:index (List) —

A comma-separated list of index names to limit the returned information
:bytes (String) —

The unit in which to display byte values (options: b, k, m, g)
:h (List) —

Comma-separated list of column names to display – see the ‘help` argument
:v (Boolean) —

Display column headers as part of the output
:format (String) —

The output format. Options: ‘text’, ‘json’; default: ‘text’
:help (Boolean) —

Return information about headers
:local (Boolean) —

Return local information, do not retrieve the state from master node (default: false)
:master_timeout (Time) —

Explicit operation timeout for connection to master node

See Also:

http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-shards.html

# File 'lib/elasticsearch/api/actions/cat/shards.rb', line 48

def shards(arguments={})
  valid_params = [
    :local,
    :master_timeout,
    :h,
    :help,
    :v ]

  index = arguments.delete(:index)

  method = 'GET'

  path   = Utils.__pathify '_cat/shards', Utils.__listify(index)

  params = Utils.__validate_and_extract_params arguments, valid_params
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body   = nil

  perform_request(method, path, params, body).body
end

#thread_pool(arguments = {}) ⇒ `Object`

Display thread pool statistics across nodes (use the ‘help` parameter to display a list of avaialable thread pools)

Examples:

Display information about all thread pools across nodes


puts client.cat.thread_pool

Display header names in the output


puts client.cat.thread_pool v: true

Display information about the indexing thread pool


puts client.cat.thread_pool h: %w(h ip index.active index.size index.queue index.rejected), v: true

Display information about the indexing and search threads, using the short names


puts client.cat.thread_pool h: 'host,ia,is,iq,ir,sa,ss,sq,sr', v: true

Parameters:

arguments (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (arguments):

:full_id (Boolean) —

Display the complete node ID
:h (List) —

Comma-separated list of column names to display – see the ‘help` argument
:v (Boolean) —

Display column headers as part of the output
:format (String) —

The output format. Options: ‘text’, ‘json’; default: ‘text’
:help (Boolean) —

Return information about headers
:local (Boolean) —

Return local information, do not retrieve the state from master node (default: false)
:master_timeout (Time) —

Explicit operation timeout for connection to master node

See Also:

http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html

# File 'lib/elasticsearch/api/actions/cat/thread_pool.rb', line 36

def thread_pool(arguments={})
  valid_params = [
    :full_id,
    :local,
    :master_timeout,
    :h,
    :help,
    :v ]

  method = 'GET'
  path   = "_cat/thread_pool"
  params = Utils.__validate_and_extract_params arguments, valid_params
  params[:h] = Utils.__listify(params[:h]) if params[:h]
  body   = nil

  perform_request(method, path, params, body).body
end

Module: Elasticsearch::API::Cat::Actions

Instance Method Summary collapse

Instance Method Details

#aliases(arguments = {}) ⇒ Object

#allocation(arguments = {}) ⇒ Object

#count(arguments = {}) ⇒ Object

#fielddata(arguments = {}) ⇒ Object

#health(arguments = {}) ⇒ Object

#help(arguments = {}) ⇒ Object

#indices(arguments = {}) ⇒ Object

#master(arguments = {}) ⇒ Object

#nodes(arguments = {}) ⇒ Object

#pending_tasks(arguments = {}) ⇒ Object

#recovery(arguments = {}) ⇒ Object

#shards(arguments = {}) ⇒ Object

#thread_pool(arguments = {}) ⇒ Object

#aliases(arguments = {}) ⇒ `Object`

#allocation(arguments = {}) ⇒ `Object`

#count(arguments = {}) ⇒ `Object`

#fielddata(arguments = {}) ⇒ `Object`

#health(arguments = {}) ⇒ `Object`

#help(arguments = {}) ⇒ `Object`

#indices(arguments = {}) ⇒ `Object`

#master(arguments = {}) ⇒ `Object`

#nodes(arguments = {}) ⇒ `Object`

#pending_tasks(arguments = {}) ⇒ `Object`

#recovery(arguments = {}) ⇒ `Object`

#shards(arguments = {}) ⇒ `Object`

#thread_pool(arguments = {}) ⇒ `Object`