diff --git a/README.md b/README.md index aaf14a2..58d38aa 100644 --- a/README.md +++ b/README.md @@ -433,6 +433,40 @@ $ esctl search -i hyperdrive -l 2 | jq } ``` +There are also some uniq features which are not directly available via +the ES API or GUI. Here's one example: say you have a number of +indices with ILM policies each. At some day there were a surge in +incoming data in some of them and you want to know, when the excess +data will be rolled over to cold storage: + +```console +$ esctl ilm forecast sh -f warm -w 3d +1.1 TB bytes of data in warm phase will be rolled within 72h0m0s to the next phase +``` + +You may also look at a detailed ilm forecast list: + +```console +$ esctl ilm forecast ls -f warm -w 3d +INDEX CURRENT-SIZE CURRENT-AGE VIRTUAL-AGE MIN-AGE MIN-SIZE CURRENT-PHASE NEXT-PHASE +foobar-n1-p01-elastic-000126 12 GB 2d:8h:12m 3d:5h:16m 7d 25 GB hot warm +foobar-n1-p01-misc-000070 16 GB 5d:16h:31m 4d:10h:31m 7d 25 GB hot warm +foobar-n1-q01-elastic-000122 23 GB 5d:0h:11m 6d:10h:33m 7d 25 GB hot warm +foobar-n1-q01-misc-000072 18 GB 6d:15h:21m 4d:21h:36m 7d 25 GB hot warm +delaware-f1-p01-kafka-000023 1.3 MB 15h:12m 0s 7d 25 GB hot warm +delaware-f1-p01-misc-000024 17 GB 6d:16h:1m 4d:16h:33m 7d 25 GB hot warm +delaware-f1-q01-kafka-000023 1.5 MB 15h:12m 0s 7d 25 GB hot warm +delaware-f1-q01-misc-000024 16 GB 6d:15h:31m 4d:13h:52m 7d 25 GB hot warm +delaware-n1-p01-elastic-000417 16 GB 12h:42m 4d:10h:31m 7d 25 GB hot warm +``` +So you can see, which index will be rolled over when. Note the +**VIRTUAL-AGE** field however: it is calculated from the current +storage usage of the index in relation to rollover max shard size. So +you can see, when an index will be rolled over either because it aged +out or because its storage exceeded the limit. + +--- + Please note, that `esctl` is still in its early stages and things are changing heavily every now and then. New commands are being added constantly as well.