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

📦

version 8.12 · 4 versions

8.12 · debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
8.12 · fedora 43
8.12 · fedora 44
8.00 · debian bookworm

, in debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

🐱 NAME 🐱

okay bestie, the whole thing is called Search::Elasticsearch::Client::8_0::Direct::Cat — and what it IS is a client for running cat debugging requests. yes really. it's giving "let the cat snoop around your cluster" energy and honestly? iconic. 🐱✨

🌸 VERSION 🌸

version 8.12 — that's the one, no cap. 💅

💖 DESCRIPTION 💖

so the cat API in Elasticsearch hands you the tea about your cluster and your indices in a simple, easy to read text format, and it's intended for human consumption. like, for actual eyeballs. not for your parser to gobble up. it's the "just show me what's happening" API and we love her for it. 🫶

These APIs have a number of parameters in common, and here they are, all of them, let's go:

help — returns help about the API. that's it, that's the vibe. eg:

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

v — includes the column headers in the output. the v stands for verbose, and also for "very helpful actually". 🌈

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

h — accepts a list of column names to be output. you pick the columns, you're the main character. 👑

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

bytes — formats byte-based values as bytes ("b"), kilobytes ("k"), megabytes ("m") or gigabytes ("g"). so you can read your numbers without your brain short-circuiting. 🍓

and one more thing before we dip: It does Search::Elasticsearch::Role::Client::Direct. periodt. 💜

okay and bestie we are NOT done yet — more of this page is coming, don't go anywhere 🦋

✨ METHODS ✨

`help()`

say $e->cat->help;

Returns the list of supported "cat" APIs. That’s it, bestie. 💅

`aliases()`

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

Returns info about index aliases, optionally limited to the specified index/alias names.

Query string params you can pass: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v".

See the cat aliases docs at <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. It’s giving cluster cartography. 🗺️

Query string params you can pass: "bytes", "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v".

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

`count()`

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

Provides quick access to the document count of the entire cluster, or individual indices. Literally just the numbers, no cap. 🔢

Query string params you can pass: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v".

See the cat count docs at <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. Memory tea, served fresh. ☕

Query string params you can pass: "bytes", "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v".

See the cat fielddata docs at <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. Yes, same vibe as allocation, but make it health. 🩺

Query string params you can pass: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "ts", "s", "v".

See the cat health docs at <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 individual indices. The index report card, periodt. 📋

Query string params you can pass: "bytes", "error_trace", "format", "h", "health", "help", "human", "local", "master_timeout", "pri", "s", "v".

See the cat indices docs at <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. The main character’s business card. 👑

Query string params you can pass: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v".

See the cat master docs at <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. All the little labels each node is wearing. 🏷️

Query string params you can pass: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v".

See the cat nodeattrs docs at <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. Every single one, no skip. 🫶

Query string params you can pass: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v".

See the cat nodes docs at <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. The master’s to-do list, basically. 📝

Query string params you can pass: "error_trace", "format", "human", "local", "master_timeout", "h", "help", "s", "v".

See the cat pending-tasks docs at <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. Plugin haul reveal. 🎁

Query string params you can pass: "error_trace", "format", "human", "local", "master_timeout", "h", "help", "s", "v".

See the cat plugins docs at <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(). Like a little shard heartbeat monitor. 💓

Query string params you can pass: "bytes", "error_trace", "format", "h", "help", "human", "master_timeout", "s", "v".

See the cat recovery docs at <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. Where all the snapshots live, iykyk. 🏠

Query string params you can pass: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v".

See the cat repositories docs at <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. Lowkey deep lore. 🕵️

Query string params you can pass: "bytes", "error_trace", "format", "h", "help", "human", "s", "v".

See the cat shards docs at <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, the state and size of each shard. The whole shard map, unlocked. 🗺️

Query string params you can pass: "bytes", "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v".

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

`snapshots()`

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

Provides a list of all snapshots that belong to the specified repositories. Your snapshot collection, served. 📸

Query string params you can pass: "error_trace", "format", "h", "help", "human", "ignore_unavailable", "master_timeout", "s", "v".

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

`tasks()`

say $e->cat->tasks()

Provides a list of node-level tasks. Little task list, but make it cluster. ✅

Query string params you can pass: "actions", "detailed", "error_trace", "format", "h", "help", "human", "node_id", "parent_node", "parent_task", "s", "v".

See the cat tasks docs at <http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html> for more information.

`templates()`

say $e->cat->templates(
    name => $name # optional
)

Provides a list of index templates. Template tea, no gatekeeping. ☕

Query string params you can pass: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "s", "v".

See the cat templates docs at <http://www.elastic.co/guide/en/elasticsearch/reference/current/templates.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. Thread pool gossip, but make it stats. 🧵

Query string params you can pass: "error_trace", "format", "h", "help", "human", "local", "master_timeout", "size", "s", "v".

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

🌸 AUTHOR 🌸

This masterpiece was authored by Enrico Zimuel <enrico.zimuel@elastic.co> 💖

📜 COPYRIGHT AND LICENSE 📜

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

That’s the whole vibe, bestie! This page came from perl v5.38.2, dated 2024-02-04, and it’s the Search...ct::Cat(3pm) man page. Stay slaying! 💅✨

📦 where this page comes from

debian trixie: libsearch-elasticsearch-perl 8.12-1 · Apache-2.0
ubuntu noble: libsearch-elasticsearch-perl 8.12-1 · Apache-2.0
ubuntu resolute: libsearch-elasticsearch-perl 8.12-1 · Apache-2.0
ubuntu stonking: libsearch-elasticsearch-perl 8.12-1 · Apache-2.0
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms