Elastic Healthcheck Commands

The elastic subcommand in Accelo Healthcheck helps you diagnose and manage Elasticsearch-related issues. It provides commonly used Elasticsearch diagnostic and maintenance operations through a single, secure command interface.

To view all available subcommands and flags, run:

Bash
    
 
accelo admin hc elastic --help
Copy

Available Subcommands

alias
cluster-health
cluster-settings
delete
health-report
shard-count

Default Behavior

By default, the following command lists all Elasticsearch indices for the specified environment:

Bash
    
 
accelo admin hc elastic -e <environment>
Copy

Commonly Used Flags

Flag	Description
-d <hostname/ip>	Specifies a custom Elasticsearch host if it is running on a different server
-i <index-name/regex>	Filters one or more indices by name or regular expression
-w	Displays output in a wide format
-p <port>	Specifies a non-default Elasticsearch port

Sample Output: List Indices

Bash
    
 
accelo admin hc elastic -e <environment>
Copy

Example output:

Bash
    
 
╔════════╦════════════════════════════════════╦═══════════════╦══════════╦═══════════╦════════════╗║ HEALTH ║ INDEX                              ║ PRIMARY SHARD ║ REPLICAS ║ DOC COUNT ║ STORE SIZE ║╚════════╩════════════════════════════════════╩═══════════════╩══════════╩═══════════╩════════════╝
Copy

Commands

Alias

Retrieves alias information for one or more indices.

Command:

Bash
    
 
accelo admin hc elastic alias -e <environment>
Copy

Sample output:

Bash
    
 
{  "actions_service-axn-actions_service-2025.01.28": {    "aliases": {}  }}
Copy

Cluster Health

Retrieves the health status of the Elasticsearch cluster.

Command:

Bash
    
 
accelo admin hc elastic cluster-health -e <environment>
Copy

Sample output:

Bash
    
 
INFO: elastic cluster health{  "active_primary_shards": 355,  "active_shards": 355,  "active_shards_percent_as_number": 98.61111111111111,  "cluster_name": "elasticsearch",  "delayed_unassigned_shards": 0,  "initializing_shards": 0,  "number_of_data_nodes": 1,  "number_of_in_flight_fetch": 0,  "number_of_nodes": 1,  "number_of_pending_tasks": 0,  "relocating_shards": 0,  "status": "yellow",  "task_max_waiting_in_queue_millis": 0,  "timed_out": false,  "unassigned_shards": 5}
Copy

Cluster Settings

Retrieves cluster-wide persistent and transient settings.

Command:

Bash
    
 
accelo admin hc elastic cluster-settings -e <environment>
Copy

Sample output:

Bash
    
 
{  "persistent": {},  "transient": {}}
Copy

Delete Index

Deletes one or more indices from the Elasticsearch cluster.

Bash
    
 
accelo admin hc elastic delete -e XXXXXXXXXXXX -i <indexName>
Copy

To delete multiple indices, give -m flag, when -m is used -i flag can be used as regex and multiple indices can be deleted.

Sample output:

Bash
    
 
[root@odppulse201:acceldata (ad-default)]$ accelo admin hc elastic delete -e XXXXXX -i 2025.01.12 -mINFO: index 'smokey-hdfs-audit-2025.01.12' deleted successfullyINFO: index 'smokey-logs-hbase_master-warn-2025.01.12' deleted successfullyINFO: index 'smokey-logs-hive_server-warn-2025.01.12' deleted successfullyINFO: index 'smokey-logs-yarn_timelinereader-warn-2025.01.12' deleted successfullyINFO: index 'smokey-logs-yarn_timelineserver-warn-2025.01.12' deleted successfullyINFO: index 'smokey-logs-hdfs_datanode-info-2025.01.12' deleted successfullyINFO: index 'smokey-logs-oozie_server-info-2025.01.12' deleted successfullyINFO: index 'smokey-logs-hive_server-info-2025.01.12' deleted successfullyINFO: index 'smokey-logs-zookeeper-info-2025.01.12' deleted successfullyINFO: index 'smokey-logs-mapred_historyserver-info-2025.01.12' deleted successfullyINFO: index 'smokey-logs-nifi-info-2025.01.12' deleted successfullyINFO: index 'smokey-logs-kafka_server_gc-info-2025.01.12' deleted successfullyINFO: index 'smokey-logs-hdfs_namenode-info-2025.01.12' deleted successfullyINFO: index 'smokey-logs-hbase_regionserver-warn-2025.01.12' deleted successfullyINFO: index 'smokey-logs-yarn_resourcemanager-info-2025.01.12' deleted successfullyINFO: index 'smokey-logs-hbase_master-info-2025.01.12' deleted successfullyINFO: index 'smokey-logs-yarn_timelineserver-info-2025.01.12' deleted successfullyINFO: index 'smokey-logs-hbase_regionserver-info-2025.01.12' deleted successfullyINFO: index 'smokey-logs-yarn_nodemanager-info-2025.01.12' deleted successfully
Copy

Health Report

Retrieves a detailed health report for the Elasticsearch cluster.

Command:

Bash
    
 
accelo admin hc elastic health-report -e <environment>
Copy

Shard Count

Updates the number of shards configured for the Elasticsearch cluster.

Command:

Bash
    
 
accelo admin hc elastic shard-count -e <environment> -s <new-shard-count>
Copy

Sample output:

Bash
    
 
INFO: shard count altered successfully
Copy

After updating the shard count, use the cluster-settings command to verify the change.

Last updated on

Was this page helpful?