Search...ct::Cat(3pm)

🎀 NAME 🎀

okay bestie, so this is the manual for Search::Elasticsearch::Client::2_0::Direct::Cat 💖 — it's part of the User Contributed Perl Documentation, and it's literally the client for running cat debugging requests ✨

---

💖 VERSION 💖

version 6.81 — periodt 💅

---

🦋 DESCRIPTION 🦋

The "cat" API in Elasticsearch is giving you all the tea about your cluster and your indices in a simple, easy-to-read text format. It's intended for human consumption, bestie — like, it's for you to read, not for a machine 🫶

These APIs have a bunch of parameters in common, so let's go:

• "help" — returns help about the API, eg:

say $e->cat->allocation(help => 1);

• "v" — includes the column headers in the output:

say $e->cat->allocation(v => 1);

• "h" — accepts a list of column names to be output, eg:

say $e->cat->indices(h => ['health','index']);

• "bytes" — formats byte-based values as bytes ("b"), kilobytes ("k"), megabytes ("m") or gigabytes ("g") 🌈

Also, it does Search::Elasticsearch::Role::Client::Direct. iconic behaviour honestly.

---

💅 METHODS 💅

help()

say $e->cat->help;

Returns the list of supported "cat" APIs 👑

aliases()

say $e->cat->aliases(
    name => 'name' | \@names    # optional
);

Returns information about index aliases, and if you want it can be optionally limited to the specified index/alias names 💜

Query string parameters: "h", "help", "local", "master_timeout", "v"

See the cat aliases docs (http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-aliases.html) for more information.

allocation()

say $e->cat->allocation(
    node_id => 'node' | \@nodes    # optional
);

Provides a snapshot of how shards have located around the cluster and the state of disk usage 🍓

Query string parameters: "bytes", "h", "help", "local", "master_timeout", "v"

See the cat allocation docs (http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-allocation.html) for more information.

count()

say $e->cat->count(
    index => 'index' | \@indices    # optional
);

Gives you quick access to the document count of the entire cluster, or of individual indices. so handy fr fr 💖

Query string parameters: "h", "help", "local", "master_timeout", "v"

See the cat count docs (http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html) for more information.

fielddata()

say $e->cat->fielddata(
    fields => 'field' | \@fields    # optional
);

Shows the amount of memory used by each of the specified fields (or all fields) loaded into fielddata 🧚

Query string parameters: "bytes", "h", "help", "local", "master_timeout", "v"

See the cat fielddata docs (http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-fielddata.html) for more information.

health()

say $e->cat->health();

Provides a snapshot of how shards have located around the cluster and the state of disk usage ✨

Query string parameters: "bytes", "h", "help", "local", "master_timeout", "ts", "v"

See the cat health docs (http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-health.html) for more information.

indices()

say $e->cat->indices(
    index => 'index' | \@indices    # optional
);

Provides a summary of index size and health for the whole cluster or for individual indices 🌸

Query string parameters: "bytes", "h", "help", "local", "master_timeout", "pri", "v"

See the cat indices docs (http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html) for more information.

master()

say $e->cat->master();

Displays the master's node ID, bound IP address, and node name 👑

Query string parameters: "h", "help", "local", "master_timeout", "v"

See the cat master docs (http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-master.html) for more information.

nodeattrs()

say $e->cat->nodeattrs();

Returns the node attributes set per node 🦋

Query string parameters: "h", "help", "local", "master_timeout", "v"

See the cat nodeattrs docs (http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodeattrs.html) for more information.

nodes()

say $e->cat->nodes();

Provides a snapshot of all of the nodes in your cluster. the whole squad 💫

Query string parameters: "h", "help", "local", "master_timeout", "v"

See the cat nodes docs (http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodes.html) for more information.

pending_tasks()

say $e->cat->pending_tasks();

Returns any cluster-level tasks which are queued on the master 😭

Query string parameters: "local", "master_timeout", "h", "help", "v"

See the cat pending-tasks docs (http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-pending-tasks.html) for more information.

plugins()

say $e->cat->plugins();

Returns information about plugins installed on each node 🎀

Query string parameters: "local", "master_timeout", "h", "help", "v"

See the cat plugins docs (http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-plugins.html) for more information.

recovery()

say $e->cat->recovery(
    index => 'index' | \@indices    # optional
);

Provides a view of shard replication. It will show information anytime data from at least one shard is copying to a different node. It can also show up on cluster restarts. If your recovery process seems stuck, try it to see if there's any movement using recovery() 🔥

Query string parameters: "bytes", "h", "help", "master_timeout", "v"

See the cat recovery docs (http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-recovery.html) for more information.

repositories()

say $e->cat->repositories()

Provides a list of registered snapshot repositories 💜

Query string parameters: "h", "help", "local", "master_timeout", "v"

See the cat repositories docs (http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-repositories.html) for more information.

segments()

say $e->cat->segments(
    index => 'index' | \@indices    # optional
);

Provides low level information about the segments in the shards of an index 🧚

Query string parameters: "h", "help", "v"

See the cat shards docs (http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-segments.html) for more information.

shards()

say $e->cat->shards(
    index => 'index' | \@indices    # optional
);

Provides a detailed view of what nodes contain which shards, plus the state and size of each shard 👑

Query string parameters: "h", "help", "local", "master_timeout", "v"

See the cat shards docs (http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-shards.html) for more information.

snapshots()

say $e->cat->snapshots(
    repository => 'repository' | \@repositories # required
)

Provides a list of all snapshots that belong to the specified repositories. note that repository is required, bestie, no skipping it 💀

Query string parameters: "h", "help", "ignore_unavailable", "master_timeout", "v"

See the cat snapshots docs (http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html) for more information.

thread_pool()

say $e->cat->thread_pool(
    index => 'index' | \@indices    # optional
);

Shows cluster wide thread pool statistics per node. By default the "active", "queue" and "rejected" statistics are returned for the "bulk", "index" and "search" thread pools 🌈

Query string parameters: "full_id", "h", "help", "local", "master_timeout", "v"

See the cat thread_pool docs (http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-thread-pool.html) for more information.

---

✨ AUTHOR ✨

Enrico Zimuel <enrico.zimuel@elastic.co> 🫶

---

👑 COPYRIGHT AND LICENSE 👑

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

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

---

and that's the whole page, bestie 🎀 this was Search...ct::Cat(3pm), straight outta perl v5.32.0, dated 2020-11-25. love that for us. bye 💅✨