Merge branch 'master' into filter-by-ilm-policy

Author: breml

cmd_ilm_list.go

@@ -16,6 +16,8 @@ import (
 	"github.com/elastic/go-elasticsearch/v8/typedapi/types"
 	"github.com/elastic/go-elasticsearch/v8/typedapi/types/enums/bytes"
 	"github.com/olekukonko/tablewriter"
+	"github.com/olekukonko/tablewriter/renderer"
+	"github.com/olekukonko/tablewriter/tw"
 	"github.com/urfave/cli/v3"
 )
 
@@ -25,11 +27,14 @@ func ilmList(ctx context.Context, cmd *cli.Command) error {
 	username := cmd.String("username")
 	password := cmd.String("password")
 
+	action := cmd.String("action")
 	phase := cmd.String("phase")
 	ilmPolicy := cmd.String("ilm-policy")
 	sortColumns := cmd.StringSlice("sort")
-	minSizeStr := cmd.String("min-size")
+	minPriSizeStr := cmd.String("min-pri-size")
+	minTotalSizeStr := cmd.String("min-total-size")
 	minAge := time.Duration(cmd.Int("min-age-days")) * 24 * time.Hour
+	format := cmd.String("format")
 
 	if !isRegionValid(region) {
 		return fmt.Errorf("region %q is not a known Elastic Cloud region", region)
@@ -40,17 +45,25 @@ func ilmList(ctx context.Context, cmd *cli.Command) error {
 		return fmt.Errorf(`invalid region, expected format "<provider>-<region>", e.g. "azure-westeurope"`)
 	}
 
-	allowedSortColumns := []string{"age", "size"}
+	allowedSortColumns := []string{"age", "pri-size", "total-size"}
 	for _, sortColumn := range sortColumns {
 		if !slices.Contains(allowedSortColumns, sortColumn) {
 			return fmt.Errorf("column %q is not allowed for sorting, use one of %v", sortColumn, allowedSortColumns)
 		}
 	}
 
-	var minSize int64
 	var err error
-	if minSizeStr != "" {
-		minSize, err = units.FromHumanSize(minSizeStr)
+	var minPriSize int64
+	if minPriSizeStr != "" {
+		minPriSize, err = units.FromHumanSize(minPriSizeStr)
+		if err != nil {
+			return fmt.Errorf("failed to parse minimum size: %w", err)
+		}
+	}
+
+	var minTotalSize int64
+	if minTotalSizeStr != "" {
+		minTotalSize, err = units.FromHumanSize(minTotalSizeStr)
 		if err != nil {
 			return fmt.Errorf("failed to parse minimum size: %w", err)
 		}
@@ -72,20 +85,28 @@ func ilmList(ctx context.Context, cmd *cli.Command) error {
 		return err
 	}
 
-	indices, err := client.Cat.Indices().H("index", "store.size").Bytes(bytes.B).Do(ctx)
+	indices, err := client.Cat.Indices().H("index", "store.size", "pri.store.size").Bytes(bytes.B).Do(ctx)
 	if err != nil {
 		return err
 	}
 
-	sizes := make(map[string]int64, len(indices))
+	totalSizes := make(map[string]int64, len(indices))
+	priSizes := make(map[string]int64, len(indices))
 
 	for _, index := range indices {
-		size, err := strconv.ParseInt(*index.StoreSize, 10, 64)
+		totalSize, err := strconv.ParseInt(*index.StoreSize, 10, 64)
+		if err != nil {
+			return err
+		}
+
+		totalSizes[*index.Index] = totalSize
+
+		priSize, err := strconv.ParseInt(*index.PriStoreSize, 10, 64)
 		if err != nil {
 			return err
 		}
 
-		sizes[*index.Index] = size
+		priSizes[*index.Index] = priSize
 	}
 
 	ilms, err := client.Ilm.ExplainLifecycle("_all").OnlyManaged(true).Do(ctx)
@@ -94,13 +115,14 @@ func ilmList(ctx context.Context, cmd *cli.Command) error {
 	}
 
 	type indexDetails struct {
-		name   string
-		phase  string
-		action string
-		step   string
-		policy string
-		age    time.Duration
-		size   int64
+		name      string
+		phase     string
+		action    string
+		step      string
+		policy    string
+		age       time.Duration
+		priSize   int64
+		totalSize int64
 	}
 
 	indexILM := make([]indexDetails, 0, len(ilms.Indices))
@@ -111,6 +133,10 @@ func ilmList(ctx context.Context, cmd *cli.Command) error {
 			continue
 		}
 
+		if action != "" && action != *managed.Action {
+			continue
+		}
+
 		if phase != "" && phase != *managed.Phase {
 			continue
 		}
@@ -119,9 +145,15 @@ func ilmList(ctx context.Context, cmd *cli.Command) error {
 			continue
 		}
 
-		size := sizes[index]
+		priSize := priSizes[index]
 
-		if size < minSize {
+		if priSize < minPriSize {
+			continue
+		}
+
+		totalSize := totalSizes[index]
+
+		if totalSize < minTotalSize {
 			continue
 		}
 
@@ -134,7 +166,7 @@ func ilmList(ctx context.Context, cmd *cli.Command) error {
 			continue
 		}
 
-		indexILM = append(indexILM, indexDetails{name: index, phase: *managed.Phase, action: *managed.Action, step: *managed.Step, policy: *managed.Policy, age: age, size: size})
+		indexILM = append(indexILM, indexDetails{name: index, phase: *managed.Phase, action: *managed.Action, step: *managed.Step, policy: *managed.Policy, age: age, priSize: priSize, totalSize: totalSize})
 	}
 
 	// Apply the sort criteria as less functions controlled by:
@@ -162,10 +194,19 @@ func ilmList(ctx context.Context, cmd *cli.Command) error {
 				return false, false
 			})
 
-		case "size":
+		case "pri-size":
 			lessFuncs = append(lessFuncs, func(i, j int) (final bool, less bool) {
-				if indexILM[i].size != indexILM[j].size {
-					return true, indexILM[i].size > indexILM[j].size
+				if indexILM[i].priSize != indexILM[j].priSize {
+					return true, indexILM[i].priSize > indexILM[j].priSize
+				}
+
+				return false, false
+			})
+
+		case "total-size":
+			lessFuncs = append(lessFuncs, func(i, j int) (final bool, less bool) {
+				if indexILM[i].totalSize != indexILM[j].totalSize {
+					return true, indexILM[i].totalSize > indexILM[j].totalSize
 				}
 
 				return false, false
@@ -187,12 +228,34 @@ func ilmList(ctx context.Context, cmd *cli.Command) error {
 
 	data := make([][]string, 0, len(indexILM))
 	for _, item := range indexILM {
-		data = append(data, []string{item.name, item.phase, item.action, item.step, item.policy, formatDuration(item.age), units.BytesSize(float64(item.size))})
+		data = append(data, []string{item.name, item.phase, item.action, item.step, item.policy, formatDuration(item.age), units.BytesSize(float64(item.priSize)), units.BytesSize(float64(item.totalSize))})
+	}
+
+	opts := []tablewriter.Option{
+		tablewriter.WithRenderer(
+			renderer.NewBlueprint(),
+		),
+	}
+	switch format {
+	case "compact":
+		opts = []tablewriter.Option{
+			tablewriter.WithRenderer(
+				renderer.NewBlueprint(
+					tw.Rendition{
+						Borders: tw.BorderNone,
+						Settings: tw.Settings{
+							Lines:      tw.LinesNone,
+							Separators: tw.SeparatorsNone,
+						},
+					},
+				),
+			),
+		}
 	}
 
-	table := tablewriter.NewWriter(os.Stdout)
+	table := tablewriter.NewTable(os.Stdout, opts...)
 	table.Header([]string{
-		"Index", "Phase", "Action", "Step", "Policy", "Age", "Size",
+		"Index", "Phase", "Action", "Step", "Policy", "Age", "Pri Size", "Total Size",
 	})
 	err = table.Bulk(data)
 	if err != nil {

main.go

@@ -63,6 +63,11 @@ func run(ctx context.Context, args []string) error {
 						Name:  "list",
 						Usage: "list ilm managed indices filtered by phase",
 						Flags: []cli.Flag{
+							&cli.StringFlag{
+								Name:    "action",
+								Aliases: []string{"a"},
+								Usage:   "Filter to only include indices in the given action",
+							},
 							&cli.StringFlag{
 								Name:    "phase",
 								Aliases: []string{"p"},
@@ -76,16 +81,25 @@ func run(ctx context.Context, args []string) error {
 							&cli.StringSliceFlag{
 								Name:    "sort",
 								Aliases: []string{"s"},
-								Usage:   "Sort indices by the given columns, allowed columns are: age, size",
+								Usage:   "Sort indices by the given columns, allowed columns are: age, pri-size, total-size",
+							},
+							&cli.StringFlag{
+								Name:  "min-total-size",
+								Usage: "Minimum total size (primary shard + replicas) of index in order to be contained in the result, supported units: k, m, g, t, p",
 							},
 							&cli.StringFlag{
-								Name:  "min-size",
-								Usage: "Minimum size of index in order to be contained in the result, supported units: k, m, g, t, p",
+								Name:  "min-pri-size",
+								Usage: "Minimum primary shard size of index in order to be contained in the result, supported units: k, m, g, t, p",
 							},
 							&cli.IntFlag{
 								Name:  "min-age-days",
 								Usage: "Minimum age of index in days in order to be contained in the result",
 							},
+							&cli.StringFlag{
+								Name:    "format",
+								Aliases: []string{"f"},
+								Usage:   "Format for the result: table, compact (default: table)",
+							},
 						},
 						Action: ilmList,
 					},