Merge pull request #177 from MITLibraries/add-shard-info

Index command returns shard info

Author: JPrevost

tests/test_opensearch.py

@@ -125,6 +125,8 @@ def test_get_formatted_indexes(test_opensearch_client):
         "\n  Primary store size: 208b"
         "\n  Total store size: 208b"
         "\n  UUID: 60Gq-vaAScOKGXkG_JAw5A"
+        "\n  Primary Shards: 1"
+        "\n  Replica Shards: 1"
         "\n"
         "\nName: index-with-no-aliases"
         "\n  Aliases: None"
@@ -134,6 +136,8 @@ def test_get_formatted_indexes(test_opensearch_client):
         "\n  Primary store size: 208b"
         "\n  Total store size: 208b"
         "\n  UUID: KqVlOA5lTw-fXZA2TEqi_g"
+        "\n  Primary Shards: 1"
+        "\n  Replica Shards: 1"
         "\n"
         "\nName: index-with-one-alias"
         "\n  Aliases: alias-with-multiple-indexes"
@@ -143,6 +147,8 @@ def test_get_formatted_indexes(test_opensearch_client):
         "\n  Primary store size: 208b"
         "\n  Total store size: 208b"
         "\n  UUID: q-NKXPp3SuWiDKhPkUxP-g"
+        "\n  Primary Shards: 1"
+        "\n  Replica Shards: 1"
         "\n"
     )
 

tim/cli.py

@@ -95,7 +95,7 @@ def indexes(ctx: click.Context) -> None:
 
     Prints all indexes in the cluster in alphabetical order by name. For each index,
     displays information including its status, health, number of documents, primary
-    store size, total store size, and UUID.
+    store size, total store size, UUID, primary shard count, and replica shard count.
     """
     click.echo(tim_os.get_formatted_indexes(ctx.obj["CLIENT"]))
 

tim/opensearch.py

@@ -117,6 +117,8 @@ def get_formatted_indexes(client: OpenSearch) -> str:
                 f"  Primary store size: {info['pri.store.size']}\n"
                 f"  Total store size: {info['store.size']}\n"
                 f"  UUID: {info['uuid']}\n"
+                f"  Primary Shards: {int(info['pri']):,}\n"
+                f"  Replica Shards: {int(info['rep']):,}\n"
             )
         return output
     return output + " No indexes present in OpenSearch cluster."