Compare commits

..

16 Commits

44 changed files with 776 additions and 401 deletions

View File

@@ -110,3 +110,12 @@ profile: buildlocal
./esctl api ls --profile-file cpu.profile
go tool pprof -text esctl cpu.profile
go tool pprof --http localhost:8888 ./esctl cpu.profile
docker-up:
make -C t up
docker-waitup:
make -C t up
docker-down:
make -C t down

View File

@@ -216,7 +216,7 @@ Pending Tasks 0
Nodes 3
Red Indices 0
Long Running Tasks 2
Indicies 221
indices 221
Docs 9854777
Total Size 3.4 GB
Total Queries 4210411
@@ -534,7 +534,7 @@ cluster - manage cluster[s]
allocate-empty-primary - allocate an empty primary shard to a node
allocate-stale-primary - allocate a stale primary shard to a node
datastream - manage data streams
list - list indicies
list - list indices
show - show details about an data stream
create - create a new data stream
delete - delete a data stream
@@ -554,8 +554,8 @@ ilm - manage index lifecycle
list - list index rollover config
show - show rollover forecast over all indices
explain - explain ilm condition of an index
index - manage indicies
list - list indicies
index - manage indices
list - list indices
show - show details about an index
create - create a new index
update - update an index
@@ -564,6 +564,7 @@ index - manage indicies
fields - show info about field capabilities
ilm - show ilm status
du - show index disk usage
copy - copy (reindex) documents from one index to another
alias - manage index aliases
create - create an index alias
list - list index aliases
@@ -587,6 +588,7 @@ role - manage roles
show - show details about a role
diff - show differences between roles and CSV baseline
search - search within an index
searchql - search using ES/QL language
shard - manage shards
list - list shards
show - show details about a shard

View File

@@ -5,5 +5,3 @@
- add datastream support:
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream
also exclude data stream backing indices from index ls

View File

@@ -52,7 +52,7 @@ func CcrStatus(conf *cfg.Config) *cli.Command {
Flags: []cli.Flag{
&cli.StringFlag{
Name: "exclude",
Usage: "regexp of indicies to exclude",
Usage: "regexp of indices to exclude",
Destination: &conf.Exclude,
Aliases: []string{"e"},
},

View File

@@ -34,6 +34,7 @@ const (
Cilm
Cnode
Cclustersettings
Cindextemplate
)
func complete(conf *cfg.Config, cmd *cli.Command, what int) {
@@ -65,6 +66,8 @@ func complete(conf *cfg.Config, cmd *cli.Command, what int) {
list, err = es.NodeNames(conf)
case Cclustersettings:
list, err = es.ClusterSettingsNames(conf)
case Cindextemplate:
list, err = es.IndexTemplateNames(conf)
}
if err != nil {

View File

@@ -46,7 +46,7 @@ func DatastreamList(conf *cfg.Config) *cli.Command {
return &cli.Command{
Name: "list",
Aliases: []string{"ls"},
Usage: "list indicies",
Usage: "list indices",
Flags: []cli.Flag{
&cli.IntFlag{
@@ -169,7 +169,7 @@ func DatastreamRollover(conf *cfg.Config) *cli.Command {
Usage: "roll over after max age (eg: 7d, 2m, 8h)",
Destination: &conf.MaxAge,
},
&cli.IntFlag{
&cli.Int64Flag{
Name: "max-docs",
Usage: "roll over after max docs",
Destination: &conf.MaxDocs,

View File

@@ -89,7 +89,7 @@ func IlmForecastList(conf *cfg.Config) *cli.Command {
},
&cli.BoolFlag{
Name: "hidden",
Usage: "include hidden indicies",
Usage: "include hidden indices",
Destination: &conf.Hidden,
Aliases: []string{"H"},
},

View File

@@ -30,7 +30,7 @@ func Index(conf *cfg.Config) *cli.Command {
return &cli.Command{
Name: "index",
Aliases: []string{"i"},
Usage: "manage indicies",
Usage: "manage indices",
Commands: []*cli.Command{
IndexList(conf),
@@ -42,6 +42,7 @@ func Index(conf *cfg.Config) *cli.Command {
IndexFields(conf),
IndexIlm(conf),
IndexDu(conf),
IndexCopy(conf),
// sub commands
IndexAlias(conf),
@@ -54,7 +55,7 @@ func IndexList(conf *cfg.Config) *cli.Command {
return &cli.Command{
Name: "list",
Aliases: []string{"ls"},
Usage: "list indicies",
Usage: "list indices",
Flags: []cli.Flag{
&cli.IntFlag{
@@ -65,25 +66,25 @@ func IndexList(conf *cfg.Config) *cli.Command {
},
&cli.BoolFlag{
Name: "partials",
Usage: "include partial indicies",
Usage: "include partial indices",
Destination: &conf.Partials,
Aliases: []string{"p"},
},
&cli.BoolFlag{
Name: "hidden",
Usage: "include hidden indicies",
Usage: "include hidden indices",
Destination: &conf.Hidden,
Aliases: []string{"H"},
},
&cli.BoolFlag{
Name: "failed",
Usage: "include only red failed indicies",
Usage: "include only red failed indices",
Destination: &conf.Failed,
Aliases: []string{"f"},
},
&cli.StringSliceFlag{
Name: "filter",
Usage: "show only indicies matching the filter",
Usage: "show only indices matching the filter",
Destination: &conf.Filter,
Aliases: []string{"F"},
},
@@ -299,3 +300,82 @@ func IndexDu(conf *cfg.Config) *cli.Command {
},
}
}
func IndexCopy(conf *cfg.Config) *cli.Command {
return &cli.Command{
Name: "copy",
Aliases: []string{"alias", "cp"},
Usage: "copy (reindex) documents from one index to another",
UsageText: "index copy [options] -s <source-index> -t <dest-index>",
Flags: []cli.Flag{
// FIXME: not implemented by typed API
// &cli.BoolFlag{
// Name: "missing", // op_type
// Usage: "copy only missing docs",
// Destination: &conf.Missing,
// Aliases: []string{"m"},
// },
// &cli.BoolFlag{
// Name: "sync", // version_type to external
// Usage: "create missing docs and update outdated docs",
// Destination: &conf.Sync,
// Aliases: []string{"S"},
// },
&cli.BoolFlag{
Name: "force", // conflicts to proceed
Usage: "continue reindexing even when conflicts happen",
Destination: &conf.Force,
Aliases: []string{"f"},
},
&cli.Float64Flag{
Name: "requests-per-second",
Usage: "the maximum number of documents to index per second (-1 turns off throttling)",
Destination: &conf.RequestsPerSecond,
Aliases: []string{"R"},
},
&cli.Int64Flag{
Name: "max-docs",
Usage: "the maximum number of documents to reindex",
Destination: &conf.MaxDocs,
Aliases: []string{"m"},
},
&cli.DurationFlag{
Name: "timeout",
Usage: "timeout for write operations (e.g. 300m or 120s)",
Destination: &conf.Timeout,
Aliases: []string{"T"},
},
&cli.BoolFlag{
Name: "refresh",
Usage: "refresh affected shards to make this operation visible to search",
Destination: &conf.Refresh,
Aliases: []string{"r"},
},
&cli.BoolFlag{
Name: "wait",
Usage: "wait for active shards",
Destination: &conf.Wait,
Aliases: []string{"w"},
},
&cli.StringSliceFlag{
Name: "source",
Usage: "source index (multiple supported)",
Destination: &conf.SourceIndices,
Aliases: []string{"s"},
Required: true,
},
&cli.StringFlag{
Name: "target",
Usage: "target index",
Destination: &conf.Index,
Aliases: []string{"t"},
Required: true,
},
},
Action: func(ctx context.Context, cmd *cli.Command) error {
return es.IndexCopy(conf)
},
}
}

View File

@@ -121,7 +121,7 @@ func IndexAliasRollover(conf *cfg.Config) *cli.Command {
Usage: "roll over after max age (eg: 7d, 2m, 8h)",
Destination: &conf.MaxAge,
},
&cli.IntFlag{
&cli.Int64Flag{
Name: "max-docs",
Usage: "roll over after max docs",
Destination: &conf.MaxDocs,
@@ -159,7 +159,7 @@ func IndexAliasList(conf *cfg.Config) *cli.Command {
Flags: []cli.Flag{
&cli.StringSliceFlag{
Name: "filter",
Usage: "show only aliases for indicies matching the filter",
Usage: "show only aliases for indices matching the filter",
Destination: &conf.Filter,
Aliases: []string{"F"},
},

View File

@@ -49,8 +49,23 @@ func IndexTemplateList(conf *cfg.Config) *cli.Command {
Aliases: []string{"ls"},
Usage: "list index templates",
Flags: []cli.Flag{
&cli.StringSliceFlag{
Name: "filter-index-pattern",
Usage: "show only index templates which use patterns, which match the filter",
Destination: &conf.Filter,
Aliases: []string{"F"},
},
&cli.BoolFlag{
Name: "hidden",
Usage: "show hidden index templates as well",
Destination: &conf.Hidden,
Aliases: []string{"H"},
},
},
Action: func(ctx context.Context, cmd *cli.Command) error {
return es.IndexTemplateList(conf)
return es.IndexTemplateList(conf, cmd.Args().Get(0))
},
}
}
@@ -71,7 +86,7 @@ func IndexTemplateShow(conf *cfg.Config) *cli.Command {
},
ShellComplete: func(ctx context.Context, cmd *cli.Command) {
complete(conf, cmd, Cindex)
complete(conf, cmd, Cindextemplate)
},
}
}
@@ -215,7 +230,7 @@ func IndexTemplateDelete(conf *cfg.Config) *cli.Command {
},
ShellComplete: func(ctx context.Context, cmd *cli.Command) {
complete(conf, cmd, Cindex)
complete(conf, cmd, Cindextemplate)
},
}
}

4
go.mod
View File

@@ -17,8 +17,9 @@ module codeberg.org/scip/esctl
go 1.26
require (
codeberg.org/scip/mapmap v0.0.2
github.com/MichaelMure/go-term-markdown v0.1.4
github.com/alecthomas/repr v0.5.2
github.com/alecthomas/repr v0.5.3
github.com/charmbracelet/bubbles v1.0.0
github.com/charmbracelet/bubbletea v1.3.10
github.com/charmbracelet/lipgloss v1.1.0
@@ -31,7 +32,6 @@ require (
github.com/go-openapi/spec v0.22.5
github.com/go-openapi/swag/loading v0.26.1
github.com/mattn/go-isatty v0.0.22
github.com/seeruk/go-wordwrap v0.0.0-20191208221741-14ec4aac9550
github.com/tidwall/gjson v1.19.0
github.com/tlinden/yadu v0.1.3
github.com/urfave/cli/v3 v3.10.1-0.20260623012112-f980ca84bf65

8
go.sum
View File

@@ -1,3 +1,5 @@
codeberg.org/scip/mapmap v0.0.2 h1:0i61jOUwFmGVwPukrMzrx0Fi4T9Qru2nlmibuaJimBo=
codeberg.org/scip/mapmap v0.0.2/go.mod h1:/ojYo2P7dMA2FWEu+jHKmsKPeq5yDcCvXeHevqZd5OI=
github.com/MichaelMure/go-term-markdown v0.1.4 h1:Ir3kBXDUtOX7dEv0EaQV8CNPpH+T7AfTh0eniMOtNcs=
github.com/MichaelMure/go-term-markdown v0.1.4/go.mod h1:EhcA3+pKYnlUsxYKBJ5Sn1cTQmmBMjeNlpV8nRb+JxA=
github.com/MichaelMure/go-term-text v0.3.1 h1:Kw9kZanyZWiCHOYu9v/8pWEgDQ6UVN9/ix2Vd2zzWf0=
@@ -10,8 +12,8 @@ github.com/alecthomas/colour v0.0.0-20160524082231-60882d9e2721 h1:JHZL0hZKJ1VEN
github.com/alecthomas/colour v0.0.0-20160524082231-60882d9e2721/go.mod h1:QO9JBoKquHd+jz9nshCh40fOfO+JzsoXy8qTHF68zU0=
github.com/alecthomas/kong v0.2.1-0.20190708041108-0548c6b1afae/go.mod h1:+inYUSluD+p4L8KdviBSgzcqEjUQOfC5fQDRFuc36lI=
github.com/alecthomas/repr v0.0.0-20180818092828-117648cd9897/go.mod h1:xTS7Pm1pD1mvyM075QCDSRqH6qRLXylzS24ZTpRiSzQ=
github.com/alecthomas/repr v0.5.2 h1:SU73FTI9D1P5UNtvseffFSGmdNci/O6RsqzeXJtP0Qs=
github.com/alecthomas/repr v0.5.2/go.mod h1:Fr0507jx4eOXV7AlPV6AVZLYrLIuIeSOWtW57eE/O/4=
github.com/alecthomas/repr v0.5.3 h1:Ebk3yZ0kvrHC7TkTHLDJGDq1LxKeu9sQBQREFMcesS8=
github.com/alecthomas/repr v0.5.3/go.mod h1:Fr0507jx4eOXV7AlPV6AVZLYrLIuIeSOWtW57eE/O/4=
github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
github.com/charmbracelet/bubbles v1.0.0 h1:12J8/ak/uCZEMQ6KU7pcfwceyjLlWsDLAxB5fXonfvc=
@@ -151,8 +153,6 @@ github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
github.com/rogpeppe/go-internal v1.13.1 h1:KvO1DLK/DRN07sQ1LQKScxyZJuNnedQ5/wKSR38lUII=
github.com/rogpeppe/go-internal v1.13.1/go.mod h1:uMEvuHeurkdAXX61udpOXGD/AzZDWNMNyH2VO9fmH0o=
github.com/seeruk/go-wordwrap v0.0.0-20191208221741-14ec4aac9550 h1:C3CfUXH/qmWuQFRqnPm3Sx8PFxa+pqACjhV5CaNO8pw=
github.com/seeruk/go-wordwrap v0.0.0-20191208221741-14ec4aac9550/go.mod h1:Sl541M2Em6rRG3V9WObycR7MYFZiERVkd/TJg0Gt0U4=
github.com/sergi/go-diff v1.0.0 h1:Kpca3qRNrduNnOQeazBd0ysaKrUJiIuISHxogkT9RPQ=
github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=

View File

@@ -22,6 +22,7 @@ import (
"os"
"path/filepath"
"reflect"
"time"
"github.com/alecthomas/repr"
"gopkg.in/yaml.v3"
@@ -68,6 +69,13 @@ type Config struct {
Retention string // index template create: -r
Rollover bool // index template create: -R
Missing bool // index copy: -m
Sync bool // index copy: -S
RequestsPerSecond float64 // index copy: -R
Timeout time.Duration // index copy: -T
Refresh bool // index copy: -r
SourceIndices []string // index copy: -s
From, To, MaxItems int // search: flags
Filter []string // search: -F
Path string // search+doc sh: -p
@@ -99,7 +107,8 @@ type Config struct {
// rollover
MaxAge string
MaxDocs, MaxShardSize, MaxShardDocs int // roll over
MaxDocs int64 // roll over, plus others
MaxShardSize, MaxShardDocs int // roll over
DryRun bool // rollover: -n
Tag string // api ls: -t

View File

@@ -328,8 +328,8 @@ func ApiList(conf *cfg.Config, pattern string) error {
filter := regexp.MustCompile(pattern)
table := printer.NewTable(conf, 4, 0)
table.Addheaders("path", "http verb", "tag", "description")
table := printer.NewTable(conf).WithSize(4, 0).
WithHeaders("path", "http verb", "tag", "description")
for path, item := range assets.OpenAPI.Spec().Paths.Paths {
if pattern != "" {

View File

@@ -57,7 +57,7 @@ func CcrStatus(conf *cfg.Config, leader, follower string) error {
res, err := conf.Clusters[alias].ES().Cat.Indices().
Do(context.Background())
if err != nil {
return fmt.Errorf("failed to get indicies on %s: %w", alias, esErrorString(err))
return fmt.Errorf("failed to get indices on %s: %w", alias, esErrorString(err))
}
indices[alias] = make(map[string]*types.IndicesRecord, len(res))
@@ -111,8 +111,8 @@ func CcrRemoteInfo(conf *cfg.Config, index string) error {
mode = "leader"
}
table := printer.NewTable(conf, 2, 5)
table.Addheaders("ccr remote property", "value")
table := printer.NewTable(conf).WithSize(2, 5).
WithHeaders("ccr remote property", "value")
table.Entries = [][]any{
{"Remote Cluster", remote},

View File

@@ -164,8 +164,8 @@ func CcrFollowerShow(conf *cfg.Config, index string) error {
follower := res.Indices[0].Shards[0]
table := printer.NewTable(conf, 2, 9)
table.Addheaders("ccr follower property", "value")
table := printer.NewTable(conf).WithSize(2, 9).
WithHeaders("ccr follower property", "value")
table.Entries = [][]any{
{"name", index},

View File

@@ -58,8 +58,8 @@ func ClusterList(conf *cfg.Config) error {
wg.Wait()
table := printer.NewTable(conf, 5, len(conf.Clusters))
table.Addheaders("cluster", "uri", "reachable", "current", "error")
table := printer.NewTable(conf).WithSize(5, len(conf.Clusters)).
WithHeaders("cluster", "uri", "reachable", "current", "error")
idx := 0
@@ -212,8 +212,8 @@ func ClusterStatus(conf *cfg.Config) error {
}
}
table := printer.NewTable(conf, 2, 7)
table.Addheaders(conf.DefaultCluster.Name, "status")
table := printer.NewTable(conf).WithSize(2, 7).
WithHeaders(conf.DefaultCluster.Name, "status")
table.Entries = [][]any{
{"Cluster Name", res.health.ClusterName},
@@ -288,10 +288,10 @@ func gatherClusterStats(clusterstats *clusterstats.Response, table *printer.Tabl
}
table.Entries = append(table.Entries, [][]any{
{"Indicies", clusterstats.Indices.Count},
{"indices", clusterstats.Indices.Count},
{"Docs", clusterstats.Indices.Docs.Count},
{"Total Size", printer.Bytes(clusterstats.Indices.Docs.TotalSizeInBytes)},
{"Total Queries", "%d", querycount},
{"Total Queries", querycount},
{"Shards Primaries", clusterstats.Indices.Shards.Primaries},
{"Shards Total", clusterstats.Indices.Shards.Total},
{"Storage", fmt.Sprintf(

View File

@@ -38,8 +38,8 @@ func ClusterSettingsList(conf *cfg.Config) error {
return fmt.Errorf("failed to get cluster settings: %w", esErrorString(err))
}
table := printer.NewTable(conf, 2, 0)
table.Addheaders("setting", "value")
table := printer.NewTable(conf).WithSize(2, 0).
WithHeaders("setting", "value")
entries := [][]any{}

View File

@@ -71,9 +71,9 @@ func checkClusterStatus(conf *cfg.Config, leader, follower string) bool {
status[cluster] = clusterHealth
}
table := printer.NewTable(conf, 3, 6)
table := printer.NewTable(conf).WithSize(3, 6).
table.Addheaders("setting", "leader:"+leader, "follower:"+follower)
WithHeaders("setting", "leader:"+leader, "follower:"+follower)
table.Entries = [][]any{
{"Cluster Name", status[leader].ClusterName, status[follower].ClusterName},
@@ -89,7 +89,7 @@ func checkClusterStatus(conf *cfg.Config, leader, follower string) bool {
status[leader].ActivePrimaryShards,
status[follower].ActivePrimaryShards,
},
{"Indicies",
{"indices",
len(status[leader].Indices),
len(status[follower].Indices),
},
@@ -151,8 +151,8 @@ func findIlmErrors(conf *cfg.Config, leader, follower string) bool {
if len(failed[cluster]) > 0 {
idx := 0
table := printer.NewTable(conf, 2, len(failed[cluster]))
table.Addheaders("ilm errors on "+which, "errors")
table := printer.NewTable(conf).WithSize(2, len(failed[cluster])).
WithHeaders("ilm errors on "+which, "errors")
for name, count := range failed[cluster] {
table.Entries[idx] = []any{name, count}
@@ -172,7 +172,7 @@ func findIlmErrors(conf *cfg.Config, leader, follower string) bool {
return false
}
// find unsynchronized indicies only present on leader
// find unsynchronized indices only present on leader
func findIndicesOnlyOnLeader(conf *cfg.Config, indices ClusterIndices, leader, follower string) bool {
exclude := regexp.MustCompile(DefaultExclude)
if conf.Exclude != "" {
@@ -225,8 +225,8 @@ func findIndicesOnlyOnLeader(conf *cfg.Config, indices ClusterIndices, leader, f
}
idx := 0
table := printer.NewTable(conf, 3, len(indexOnlyOnLeader))
table.Addheaders("index only on leader", "size", "docscount")
table := printer.NewTable(conf).WithSize(3, len(indexOnlyOnLeader)).
WithHeaders("index only on leader", "size", "docscount")
for name, index := range indexOnlyOnLeader {
name := printer.Colorize(conf, "red", name)
@@ -275,8 +275,8 @@ func findOrphanedIndices(conf *cfg.Config, indices ClusterIndices, leader, follo
}
idx := 0
table := printer.NewTable(conf, 3, len(orphaned))
table.Addheaders("orphaned index on follower", "size", "docscount")
table := printer.NewTable(conf).WithSize(3, len(orphaned)).
WithHeaders("orphaned index on follower", "size", "docscount")
for name, index := range orphaned {
name := printer.Colorize(conf, "red", name)
@@ -311,8 +311,8 @@ func findFailedFollowerIndices(conf *cfg.Config, indices ClusterIndices, followe
}
idx := 0
table := printer.NewTable(conf, 3, len(red))
table.Addheaders("red index on follower", "size", "docscount")
table := printer.NewTable(conf).WithSize(3, len(red)).
WithHeaders("red index on follower", "size", "docscount")
for name, index := range red {
name := printer.Colorize(conf, "red", name)

View File

@@ -62,8 +62,8 @@ func DatastreamList(conf *cfg.Config) error {
}
}
table := printer.NewTable(conf, 7, size)
table.Addheaders("name", "ilm policy", "hidden", "system", "replicated", "generation", "timestamp field")
table := printer.NewTable(conf).WithSize(7, size).
WithHeaders("name", "ilm policy", "hidden", "system", "replicated", "generation", "timestamp field")
for idx, datastream := range list {
name := printer.Colorize(conf, datastream.Status.String(), datastream.Name)
@@ -146,8 +146,8 @@ func DatastreamShow(conf *cfg.Config, dsname string) error {
return fmt.Errorf("failed to get data stream stats: %w", esErrorString(err))
}
table := printer.NewTable(conf, 11, 2)
table.Addheaders("data stream property", "value")
table := printer.NewTable(conf).WithSize(11, 2).
WithHeaders("data stream property", "value")
datastream := res.DataStreams[0]
@@ -176,8 +176,8 @@ func DatastreamShow(conf *cfg.Config, dsname string) error {
return err
}
table = printer.NewTable(conf, 5, len(datastream.Indices))
table.Addheaders("backing index name", "uuid", "prefer ilm", "ilm policy", "managed by")
table = printer.NewTable(conf).WithSize(5, len(datastream.Indices)).
WithHeaders("backing index name", "uuid", "prefer ilm", "ilm policy", "managed by")
for idx, index := range datastream.Indices {
policy := ""
@@ -233,8 +233,8 @@ func DatastreamRollover(conf *cfg.Config, ds string) error {
return fmt.Errorf("failed to rollover data stream: %w", esErrorString(err))
}
table := printer.NewTable(conf, 2, 5)
table.Addheaders("rollover response", "value")
table := printer.NewTable(conf).WithSize(2, 5).
WithHeaders("rollover response", "value")
table.Entries = [][]any{
{"acknowledged", res.Acknowledged},
{"rolled over", res.RolledOver},

View File

@@ -85,8 +85,8 @@ func IlmList(conf *cfg.Config, pattern string) error {
repr.Println(res)
}
table := printer.NewTable(conf, 5, 0)
table.Addheaders("ilm policy", "hot", "warm", "frozen", "delete")
table := printer.NewTable(conf).WithSize(5, 0).
WithHeaders("ilm policy", "hot", "warm", "frozen", "delete")
for name, ilm := range res {
table.AddRow(name,
@@ -123,8 +123,8 @@ func IlmShow(conf *cfg.Config, policy string) error {
return IlmShowTree(conf, ilm.Policy)
}
table := printer.NewTable(conf, 2, 5)
table.Addheaders("ilm policy setting", "value")
table := printer.NewTable(conf).WithSize(2, 5).
WithHeaders("ilm policy setting", "value")
table.Entries = [][]any{
{"policy", policy},
@@ -142,9 +142,6 @@ func IlmShow(conf *cfg.Config, policy string) error {
func IlmShowTree(conf *cfg.Config, ilm types.IlmPolicy) error {
indent := ""
table := printer.NewTable(conf, 4, 0)
table.Addheaders("phase", "min age", "min size", "snapshot repo")
for _, phase := range IlmPhaseOrder {
if phase == "hot" {
fmt.Printf("%s%s phase:\n%s rollover after %s\n",
@@ -280,15 +277,17 @@ func IlmExplain(conf *cfg.Config, index string) error {
ilm := explain.(*types.LifecycleExplainManaged)
table := printer.NewTable(conf, 2, 0)
table.Addheaders("ilm status field", "value")
table := printer.NewTable(conf).WithSize(2, 0).
WithHeaders("ilm status field", "value")
info := ""
if len(ilm.StepInfo["reason"]) > 0 {
err = json.Unmarshal(ilm.StepInfo["reason"], &info)
if err != nil {
return fmt.Errorf("failed to unmarshal step info: %w", err)
}
}
table.Entries = [][]any{
{"index", ilm.Index},
@@ -299,8 +298,11 @@ func IlmExplain(conf *cfg.Config, index string) error {
{"phase", *ilm.Phase},
{"phase execution", ilmPhaseString(ilm.PhaseExecution.PhaseDefinition, false)},
{"step", *ilm.Step},
{"failed step", *ilm.FailedStep},
{"failed step retry count", ilm.FailedStepRetryCount},
}
if ilm.FailedStep != nil {
table.AddRow("failed step", *ilm.FailedStep)
table.AddRow("failed step retry count", ilm.FailedStepRetryCount)
}
if err := table.Print(); err != nil {

View File

@@ -105,8 +105,8 @@ func IlmForecastList(conf *cfg.Config, filter string) error {
headers = append(headers, "ilm policy")
}
table := printer.NewTable(conf, len(headers), 0)
table.Addheaders(headers...)
table := printer.NewTable(conf).WithSize(len(headers), 0).
WithHeaders(headers...)
for _, phase := range phaseData {
if filter != "" && !flt.MatchString(phase.index) {

View File

@@ -30,9 +30,11 @@ import (
"codeberg.org/scip/esctl/pkg/cfg"
"codeberg.org/scip/esctl/pkg/printer"
"codeberg.org/scip/mapmap"
"github.com/charmbracelet/lipgloss"
"github.com/elastic/go-elasticsearch/v9/typedapi/cat/indices"
"github.com/elastic/go-elasticsearch/v9/typedapi/esdsl"
"github.com/elastic/go-elasticsearch/v9/typedapi/types"
"github.com/elastic/go-elasticsearch/v9/typedapi/types/enums/healthstatus"
)
@@ -41,7 +43,7 @@ func IndexNames(conf *cfg.Config) ([]string, error) {
res, err := conf.DefaultCluster.ES().Cat.Indices().
Do(context.Background())
if err != nil {
return nil, fmt.Errorf("failed to get indicies: %w", esErrorString(err))
return nil, fmt.Errorf("failed to get indices: %w", esErrorString(err))
}
indices := make([]string, len(res))
@@ -53,41 +55,29 @@ func IndexNames(conf *cfg.Config) ([]string, error) {
}
func filterIndices(conf *cfg.Config, list indices.Response) indices.Response {
// apply partials filter first
selectedlist := indices.Response{}
var filter *regexp.Regexp
for _, index := range list {
if len(conf.Filter) > 0 {
filter = regexp.MustCompile(conf.Filter[0])
}
return mapmap.NewSlicer(list).MapSliceValuesImmutable(func(index types.IndicesRecord) bool {
if !conf.Partials && strings.HasPrefix(*index.Index, "partial-") {
continue
return false
}
if !conf.Hidden && strings.HasPrefix(*index.Index, ".") {
continue
return false
}
if strings.HasPrefix(*index.Index, ".ds-") {
// ignore data stream backing indicies
continue
}
selectedlist = append(selectedlist, index)
}
if len(conf.Filter) == 0 {
return selectedlist
}
// we support just one filter here, for now
filter := *regexp.MustCompile(conf.Filter[0])
newlist := indices.Response{}
for _, index := range selectedlist {
if filter.MatchString(*index.Index) {
newlist = append(newlist, index)
if len(conf.Filter) > 0 {
if !filter.MatchString(*index.Index) {
return false
}
}
return newlist
return true
})
}
func IndexList(conf *cfg.Config) error {
@@ -99,10 +89,10 @@ func IndexList(conf *cfg.Config) error {
res, err := cat.Do(context.Background())
if err != nil {
return fmt.Errorf("failed to get indicies: %w", esErrorString(err))
return fmt.Errorf("failed to get indices: %w", esErrorString(err))
}
slog.Debug("ES result", "indicies", res)
slog.Debug("ES result", "indices", res)
list := filterIndices(conf, res)
@@ -114,8 +104,8 @@ func IndexList(conf *cfg.Config) error {
}
}
table := printer.NewTable(conf, 3, size)
table.Addheaders("name", "size", "docscount")
table := printer.NewTable(conf).WithSize(3, size).
WithHeaders("name", "size", "docscount")
for idx, index := range list {
name := printer.Colorize(conf, *index.Health, *index.Index)
@@ -150,8 +140,8 @@ func IndexShow(conf *cfg.Config, indexpattern string) error {
idx++
}
table := printer.NewTable(conf, 2, 7)
table.Addheaders("index property", "value")
table := printer.NewTable(conf).WithSize(2, 7).
WithHeaders("index property", "value")
ts, err := strconv.ParseInt(index.Settings.Index.CreationDate.(string), 10, 64)
if err != nil {
@@ -273,8 +263,8 @@ func IndexFields(conf *cfg.Config, index string) error {
return fmt.Errorf("failed to retrieve field capabilties: %w", esErrorString(err))
}
table := printer.NewTable(conf, 5, 0)
table.Addheaders("field", "type", "searchable", "aggretable", "metadata")
table := printer.NewTable(conf).WithSize(5, 0).
WithHeaders("field", "type", "searchable", "aggretable", "metadata")
idx := 0
@@ -346,7 +336,7 @@ func IndexDiskusage(conf *cfg.Config, index string) error {
return errors.New("no disk usage reported for index")
}
table := printer.NewTableEmpty(conf).
table := printer.NewTable(conf).
WithHeaders("field", "bloom filter", "norms", "points", "term vectors", "knn vectors", "total")
for name, field := range diskusage.Fields {

View File

@@ -72,8 +72,8 @@ func IndexAliasList(conf *cfg.Config) error {
}
}
table := printer.NewTable(conf, 2, len(aliaslist))
table.Addheaders("index", "alias")
table := printer.NewTable(conf).WithSize(2, len(aliaslist)).
WithHeaders("index", "alias")
idx := 0
for index, aliases := range aliaslist {
@@ -113,8 +113,8 @@ func IndexAliasRollover(conf *cfg.Config, alias string) error {
return fmt.Errorf("failed to rollover index alias: %w", esErrorString(err))
}
table := printer.NewTable(conf, 2, 5)
table.Addheaders("rollover response", "value")
table := printer.NewTable(conf).WithSize(2, 5).
WithHeaders("rollover response", "value")
table.Entries = [][]any{
{"acknowledged", res.Acknowledged},
{"rolled over", res.RolledOver},

83
pkg/es/index_copy.go Normal file
View File

@@ -0,0 +1,83 @@
/*
Copyright © 2026 Thomas von Dein
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package es
import (
"context"
"fmt"
"time"
"codeberg.org/scip/esctl/pkg/cfg"
"codeberg.org/scip/esctl/pkg/printer"
"github.com/elastic/go-elasticsearch/v9/typedapi/esdsl"
"github.com/elastic/go-elasticsearch/v9/typedapi/types/enums/conflicts"
)
func IndexCopy(conf *cfg.Config) error {
copy := conf.DefaultCluster.ES().Reindex()
if conf.Force {
copy.Conflicts(conflicts.Proceed)
}
if conf.RequestsPerSecond != 0 {
copy.RequestsPerSecond(fmt.Sprintf("%.2f", conf.RequestsPerSecond))
}
if conf.MaxDocs > 0 {
copy.MaxDocs(conf.MaxDocs)
}
if conf.Timeout > 0 {
copy.Timeout(formatDuration(conf.Timeout))
}
if conf.Wait {
copy.WaitForActiveShards("all")
}
if conf.Refresh {
copy.Refresh(true)
}
copy.Source(esdsl.NewReindexSource().Index(conf.SourceIndices...))
copy.Dest(esdsl.NewReindexDestination().Index(conf.Index))
res, err := copy.Do(context.Background())
if err != nil {
return fmt.Errorf("failed to copy indices: %w", esErrorString(err))
}
table := printer.NewTable(conf).WithSize(2, 0).
WithHeaders("Reindex metrtic", "value")
table.Entries = [][]any{
{"Source indices", conf.SourceIndices},
{"Target index", conf.Index},
{"Batches", *res.Batches},
{"Documents total", *res.Total},
{"Documents created", *res.Created},
{"Documents deleted", *res.Deleted},
{"Documents updated", *res.Updated},
{"Requests/s", *res.RequestsPerSecond},
{"Timed out", *res.TimedOut},
{"Time elapsed", time.Duration(*res.Took) * time.Millisecond},
{"Version conflicts", *res.VersionConflicts},
}
return table.Print()
}

View File

@@ -28,12 +28,29 @@ import (
"codeberg.org/scip/esctl/pkg/cfg"
"codeberg.org/scip/esctl/pkg/printer"
"codeberg.org/scip/mapmap"
"github.com/elastic/go-elasticsearch/v9/typedapi/esdsl"
"github.com/elastic/go-elasticsearch/v9/typedapi/types"
)
// used for completion
func IndexTemplateList(conf *cfg.Config) error {
func IndexTemplateNames(conf *cfg.Config) ([]string, error) {
res, err := conf.DefaultCluster.ES().Indices.GetIndexTemplate().
Do(context.Background())
if err != nil {
return nil, fmt.Errorf("failed to get index templates: %w", esErrorString(err))
}
names := make([]string, len(res.IndexTemplates))
for idx, tpl := range res.IndexTemplates {
names[idx] = tpl.Name
}
return names, nil
}
func IndexTemplateList(conf *cfg.Config, filter string) error {
res, err := conf.DefaultCluster.ES().Indices.GetIndexTemplate().
Do(context.Background())
if err != nil {
@@ -42,16 +59,20 @@ func IndexTemplateList(conf *cfg.Config) error {
slog.Debug("res", "index templates", res)
table := printer.NewTable(conf, 5, len(res.IndexTemplates))
table.Addheaders("name", "description", "priority")
table := printer.NewTable(conf).WithSize(5, 0).
WithHeaders("name", "description", "index patterns", "priority")
for idx, tpl := range res.IndexTemplates {
desc, err := json.Marshal(tpl.IndexTemplate.Meta_["description"])
if err != nil {
return fmt.Errorf("failed to unmarshal meta json data: %w", err)
tplList := filterIndexTemplates(conf, filter, res.IndexTemplates)
for _, tpl := range tplList {
desc := strings.TrimPrefix(strings.TrimSuffix(string(tpl.IndexTemplate.Meta_["description"]), `"`), `"`)
var prio int64
if tpl.IndexTemplate.Priority != nil {
prio = *tpl.IndexTemplate.Priority
}
table.Entries[idx] = []any{tpl.Name, desc, tpl.IndexTemplate.Priority}
table.AddRow(tpl.Name, desc, tpl.IndexTemplate.IndexPatterns, prio)
}
table.Sort()
@@ -59,6 +80,30 @@ func IndexTemplateList(conf *cfg.Config) error {
return table.Print()
}
// Filter index templates by name, index pattern or hidden flag, using
// mapmap.Slicer
func filterIndexTemplates(conf *cfg.Config, nameFilter string,
templates []types.IndexTemplateItem) []types.IndexTemplateItem {
return mapmap.NewSlicer(templates).MapSliceValuesImmutable(func(tpl types.IndexTemplateItem) bool {
if !conf.Hidden && strings.HasPrefix(tpl.Name, ".") {
return false
}
if nameFilter != "" && !strings.Contains(tpl.Name, nameFilter) {
return false
}
if len(conf.Filter) > 0 {
if !mapmap.NewSlicer(tpl.IndexTemplate.IndexPatterns).
FindSliceInSlice(conf.Filter, strings.Contains) {
return false
}
}
return true
})
}
func IndexTemplateShow(conf *cfg.Config, tplname string) error {
res, err := conf.DefaultCluster.ES().Indices.GetIndexTemplate().
Name(tplname).
@@ -75,8 +120,8 @@ func IndexTemplateShow(conf *cfg.Config, tplname string) error {
tpl := res.IndexTemplates[0]
table := printer.NewTable(conf, 2, 6)
table.Addheaders("index template property", "value")
table := printer.NewTable(conf).WithSize(2, 6).
WithHeaders("index template property", "value")
desc, err := json.Marshal(tpl.IndexTemplate.Meta_["description"])
if err != nil {
@@ -103,8 +148,8 @@ func IndexTemplateShow(conf *cfg.Config, tplname string) error {
return err
}
table = printer.NewTable(conf, 2, 0)
table.Addheaders("index setting property", "value")
table = printer.NewTable(conf).WithSize(2, 0).
WithHeaders("index setting property", "value")
err = getIndexTemplateSettings(conf, tplname, table)
if err != nil {
@@ -117,8 +162,8 @@ func IndexTemplateShow(conf *cfg.Config, tplname string) error {
return err
}
table = printer.NewTable(conf, 2, 0)
table.Addheaders("index field mapping", "type")
table = printer.NewTable(conf).WithSize(2, 0).
WithHeaders("index field mapping", "type")
if tpl.IndexTemplate.Template.Mappings != nil {
for name, field := range tpl.IndexTemplate.Template.Mappings.Properties {
@@ -396,8 +441,8 @@ func rolloverAliasIndexTemplate(conf *cfg.Config, name string) error {
return nil
}
table := printer.NewTable(conf, 4, 0)
table.Addheaders("rollover alias", "status", "ack", "new index")
table := printer.NewTable(conf).WithSize(4, 0).
WithHeaders("rollover alias", "status", "ack", "new index")
// apply rollover to all matching aliases, if any
for alias := range aliases {

View File

@@ -35,7 +35,7 @@ func LicenseShow(conf *cfg.Config) error {
slog.Debug("license show", "license", res)
table := printer.NewTableEmpty(conf).WithHeaders("license setting", "value")
table := printer.NewTable(conf).WithHeaders("license setting", "value")
lic := res.License

View File

@@ -37,7 +37,7 @@ func NodeList(conf *cfg.Config) error {
slog.Debug("ES result", "nodes", nodes)
table := printer.NewTableEmpty(conf).WithHeaders(
table := printer.NewTable(conf).WithHeaders(
"name", "ip", "load1m", "load5m", "load15m", "ram %", "heap %")
for _, node := range nodes {
@@ -104,8 +104,8 @@ func NodeShow(conf *cfg.Config, nodename string) error {
for id, info := range res.Nodes {
stat := stats.Nodes[id]
table := printer.NewTable(conf, 2, 0)
table.Addheaders(nodename+" property", "value")
table := printer.NewTable(conf).WithSize(2, 0).
WithHeaders(nodename+" property", "value")
roles := make([]string, len(info.Roles))
for idx, role := range info.Roles {
@@ -197,8 +197,8 @@ func NodeClients(conf *cfg.Config, nodename string) error {
slog.Debug("ES result", "stat", stats)
table := printer.NewTable(conf, 5, 0)
table.Addheaders("agent", "id", "when", "from host", "url")
table := printer.NewTable(conf).WithSize(5, 0).
WithHeaders("agent", "id", "when", "from host", "url")
for _, stat := range stats.Nodes {
for _, client := range stat.Http.Clients {
@@ -250,7 +250,7 @@ func NodeUsage(conf *cfg.Config, nodeid string) error {
slog.Debug("ES result", "usage", stats)
table := printer.NewTableEmpty(conf).WithHeaders(
table := printer.NewTable(conf).WithHeaders(
"node",
"bulk",
"doc get",

View File

@@ -47,8 +47,8 @@ func RoleList(conf *cfg.Config) error {
slog.Debug("ES result", "roles", res)
table := printer.NewTable(conf, 3, len(res))
table.Addheaders("role", "index roles", "cluster roles")
table := printer.NewTable(conf).WithSize(3, len(res)).
WithHeaders("role", "index roles", "cluster roles")
idx := 0
for name, role := range res {
@@ -126,8 +126,8 @@ func roleRemoteClusters(conf *cfg.Config, role types.Role) error {
return nil
}
table := printer.NewTable(conf, 2, len(role.RemoteCluster))
table.Addheaders("remote cluster", "privilege")
table := printer.NewTable(conf).WithSize(2, len(role.RemoteCluster)).
WithHeaders("remote cluster", "privilege")
idx := 0
@@ -152,8 +152,8 @@ func roleClusters(conf *cfg.Config, role types.Role) error {
return nil
}
table := printer.NewTable(conf, 1, len(role.Cluster))
table.Addheaders("cluster rights")
table := printer.NewTable(conf).WithSize(1, len(role.Cluster)).
WithHeaders("cluster rights")
idx := 0
for _, cluster := range role.Cluster {
@@ -171,8 +171,8 @@ func roleRemoteIndices(conf *cfg.Config, role types.Role) error {
return nil
}
table := printer.NewTable(conf, 3, len(role.RemoteIndices))
table.Addheaders("remote index names", "index permissions", "allow restricted")
table := printer.NewTable(conf).WithSize(3, len(role.RemoteIndices)).
WithHeaders("remote index names", "index permissions", "allow restricted")
idx := 0
@@ -197,8 +197,8 @@ func roleIndices(conf *cfg.Config, role types.Role) error {
return nil
}
table := printer.NewTable(conf, 3, len(role.Indices))
table.Addheaders("index names", "index permissions", "allow restricted")
table := printer.NewTable(conf).WithSize(3, len(role.Indices)).
WithHeaders("index names", "index permissions", "allow restricted")
idx := 0
@@ -223,8 +223,8 @@ func roleApplications(conf *cfg.Config, role types.Role) error {
return nil
}
table := printer.NewTable(conf, 3, len(role.Applications))
table.Addheaders("application", "privileges", "resources")
table := printer.NewTable(conf).WithSize(3, len(role.Applications)).
WithHeaders("application", "privileges", "resources")
idx := 0
for _, priv := range role.Applications {

View File

@@ -216,8 +216,8 @@ func RoleDiff(conf *cfg.Config, csvfile, role string) error {
rows := diffRoles(conf, records, res)
table := printer.NewTable(conf, 3, len(rows))
table.Addheaders("role", "is deployed", "is defined")
table := printer.NewTable(conf).WithSize(3, len(rows)).
WithHeaders("role", "is deployed", "is defined")
for idx, row := range rows {
deployed := printer.Colorize(conf, "green", "deployed")

View File

@@ -33,7 +33,7 @@ func RolloverConditions(conf *cfg.Config) types.RolloverConditionsVariant {
}
if conf.MaxDocs > 0 {
cond.MaxDocs(int64(conf.MaxDocs))
cond.MaxDocs(conf.MaxDocs)
}
if conf.MaxShardSize > 0 {

View File

@@ -64,14 +64,13 @@ func SearchQL(conf *cfg.Config, querystring string) error {
return nil
}
table := printer.NewTable(conf, len(qlResult.Columns), len(qlResult.Values))
headers := make([]string, len(qlResult.Columns))
for idx, col := range qlResult.Columns {
headers[idx] = col.Name
}
table.Addheaders(headers...)
table := printer.NewTable(conf).WithSize(len(qlResult.Columns), len(qlResult.Values)).
WithHeaders(headers...)
table.Entries = qlResult.Values

View File

@@ -100,8 +100,8 @@ func printShards(conf *cfg.Config, shardlist shards.Response) error {
headers = append(headers, "node", "ip")
}
table := printer.NewTable(conf, len(headers), len(shardlist))
table.Addheaders(headers...)
table := printer.NewTable(conf).WithSize(len(headers), len(shardlist)).
WithHeaders(headers...)
for idx, shard := range shardlist {
name := colorzizeShard(conf, *shard.State, *shard.Index)
@@ -163,8 +163,8 @@ func ShardAllocation(conf *cfg.Config, index string) error {
slog.Debug("ES result", "explain", res)
table := printer.NewTable(conf, 2, 10)
table.Addheaders("shard allocation setting", "value")
table := printer.NewTable(conf).WithSize(2, 10).
WithHeaders("shard allocation setting", "value")
table.Entries = [][]any{
{"Index", index},

View File

@@ -42,17 +42,17 @@ type Snapshot struct {
}
func SnapshotList(conf *cfg.Config) error {
// get partial indicies
// get partial indices
ires, err := conf.DefaultCluster.ES().Cat.Indices().Do(context.Background())
if err != nil {
return fmt.Errorf("failed to get indicies: %w", esErrorString(err))
return fmt.Errorf("failed to get indices: %w", esErrorString(err))
}
indicies := map[string]int{}
indices := map[string]int{}
for _, index := range ires {
name := strings.ReplaceAll(*index.Index, "partial-", "")
indicies[name] = 1
indices[name] = 1
}
// get snapshots
@@ -61,7 +61,7 @@ func SnapshotList(conf *cfg.Config) error {
return fmt.Errorf("failed to get snapshots: %w", esErrorString(err))
}
slog.Debug("ES result", "indicies", sres)
slog.Debug("ES result", "indices", sres)
snapshots := []*Snapshot{} // original snapshot names
@@ -74,7 +74,7 @@ func SnapshotList(conf *cfg.Config) error {
Orphaned: "no",
})
_, exists := indicies[snap.Forindex]
_, exists := indices[snap.Forindex]
if !exists {
snap.Orphaned = "orphaned"
}
@@ -84,8 +84,8 @@ func SnapshotList(conf *cfg.Config) error {
}
}
table := printer.NewTable(conf, 5, len(snapshots))
table.Addheaders("name", "index", "start", "orphaned", "status")
table := printer.NewTable(conf).WithSize(5, len(snapshots)).
WithHeaders("name", "index", "start", "orphaned", "status")
for idx, snap := range snapshots {
table.Entries[idx] = []any{
@@ -118,8 +118,8 @@ func SnapshotShow(conf *cfg.Config, snapshot string) error {
return errors.New("no snapshot retrieved")
}
table := printer.NewTable(conf, 2, 17)
table.Addheaders("snapshot property", "value")
table := printer.NewTable(conf).WithSize(2, 17).
WithHeaders("snapshot property", "value")
snap := res.Snapshots[0]

View File

@@ -36,8 +36,8 @@ func TaskList(conf *cfg.Config) error {
slog.Debug("res", "tasks", res)
table := printer.NewTable(conf, 8, len(res))
table.Addheaders("task id", "action", "start time", "run time", "node", "type")
table := printer.NewTable(conf).WithSize(6, len(res)).
WithHeaders("task id", "action", "start time", "run time", "node", "type")
for idx, task := range res {
var ts time.Time

View File

@@ -1,3 +1,5 @@
package printer
/*
Copyright © 2026 Thomas von Dein
@@ -14,15 +16,15 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package printer
import "strings"
// a wrapper around strings.Builder for convenience
// Builder is a wrapper around strings.Builder for convenience
type Builder struct {
strings.Builder
}
func (builder *Builder) WriteStringLine(in string) {
builder.WriteString(in + "\n")
builder.WriteString(in)
builder.WriteString("\n")
}

View File

@@ -1,3 +1,5 @@
package printer
/*
Copyright © 2026 Thomas von Dein
@@ -14,10 +16,11 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package printer
import "github.com/dustin/go-humanize"
// ByteSize converts uint64 bytes into human readable size
// e.g. 1500 => 1.5kb
type ByteSize struct {
size uint64
}

View File

@@ -1,3 +1,5 @@
package printer
/*
Copyright © 2026 Thomas von Dein
@@ -14,7 +16,6 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package printer
import (
"fmt"
@@ -25,9 +26,11 @@ import (
"github.com/elastic/go-elasticsearch/v9/typedapi/types"
)
func any2string(in any) string {
// stringer returns the string representation of different types of
// values
func stringer(cell any) string {
//nolint:gocritic
switch val := in.(type) {
switch val := cell.(type) {
case string:
return val
case bool:
@@ -54,52 +57,27 @@ func any2string(in any) string {
return string(val)
case nil:
return "null"
case types.Percentage, types.DateTime:
return val.(string)
}
case *types.Float64:
// ignore err here, because types.Float64.MarshalJSON() never returns one
f, _ := val.MarshalJSON()
return ""
return string(f)
default:
// Caution: this may cause a panic if the [unknown] type does
// not implement fmt.Stringer. In this case add another case
// to the type switch for it above.
return cell.(fmt.Stringer).String()
}
}
func (data *Table) preprocessRows() {
if data.processed {
// only do it once
return
// visibleLen returns the length of a string but only visible chars,
// w/o ansi color escapes
func visibleLen(word string) int {
if !strings.Contains(word, "\x1b") {
// no ansi escape in there, use faster method
return len(word)
}
// convert entries to strings
data.rows = make([][]string, len(data.Entries))
for rowidx, entries := range data.Entries {
data.rows[rowidx] = make([]string, len(entries))
for colidx, entry := range data.Entries[rowidx] {
data.rows[rowidx][colidx] = any2string(entry)
}
}
// determine header lenght's
for idx, head := range data.Headers {
data.lenHeaders[idx] = visibleLen(head)
}
// determine max width per column
for _, entries := range data.rows {
currentWidth := 0
for idx, entry := range entries {
length := visibleLen(entry)
if data.lenHeaders[idx] < length {
if length > currentWidth+data.maxwidth {
data.lenHeaders[idx] = data.maxwidth - currentWidth
} else {
data.lenHeaders[idx] = length
}
}
currentWidth += data.lenHeaders[idx]
}
}
data.processed = true
// contains escapes, need to clean up before counting
return len(ansiCtrlSeq.ReplaceAllLiteralString(word, ""))
}

View File

@@ -1,3 +1,5 @@
package printer
/*
Copyright © 2026 Thomas von Dein
@@ -15,11 +17,12 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package printer
import (
"os"
"codeberg.org/scip/esctl/pkg/cfg"
"github.com/fatih/color"
"github.com/mattn/go-isatty"
)
var (
@@ -31,6 +34,10 @@ var (
)
func Colorize(conf *cfg.Config, col, what string) string {
if !isatty.IsTerminal(os.Stdout.Fd()) {
return what
}
switch conf.Output {
case "json", "yaml":
return what
@@ -49,3 +56,11 @@ func Colorize(conf *cfg.Config, col, what string) string {
return what
}
func Bold(what string) string {
if !isatty.IsTerminal(os.Stdout.Fd()) {
return what
}
return bold(what)
}

View File

@@ -1,3 +1,5 @@
package printer
/*
Copyright © 2026 Thomas von Dein
@@ -14,7 +16,6 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package printer
import (
"fmt"

56
pkg/printer/metrics.go Normal file
View File

@@ -0,0 +1,56 @@
package printer
/*
Copyright © 2026 Thomas von Dein
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import (
"fmt"
"runtime/metrics"
"strconv"
)
func printGoRoutineMetrics() {
fmt.Println("\nGoroutine metrics:")
printMetric("/sched/goroutines-created:goroutines", "Created")
printMetric("/sched/goroutines:goroutines", "Live")
printMetric("/sched/goroutines/not-in-go:goroutines", "Syscall/CGO")
printMetric("/sched/goroutines/runnable:goroutines", "Runnable")
printMetric("/sched/goroutines/running:goroutines", "Running")
printMetric("/sched/goroutines/waiting:goroutines", "Waiting")
fmt.Println("Thread metrics:")
printMetric("/sched/gomaxprocs:threads", "Max")
printMetric("/sched/threads/total:threads", "Live")
}
func printMetric(name string, descr string) {
sample := []metrics.Sample{{Name: name}}
metrics.Read(sample)
var val string
switch sample[0].Value.Kind() {
case metrics.KindFloat64, metrics.KindFloat64Histogram:
val = fmt.Sprintf("%.2f", sample[0].Value.Float64())
case metrics.KindUint64:
val = strconv.FormatUint(sample[0].Value.Uint64(), 10)
case metrics.KindBad:
val = "n/a"
}
fmt.Printf(" %s: %v\n", descr, val)
}

View File

@@ -1,3 +1,5 @@
package printer
/*
Copyright © 2026 Thomas von Dein
@@ -14,7 +16,6 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package printer
// pager setup using bubbletea
// file shamlelessly copied from:

View File

@@ -1,3 +1,5 @@
package printer
/*
Copyright © 2026 Thomas von Dein
@@ -14,7 +16,6 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package printer
import (
"encoding/json"
@@ -25,17 +26,23 @@ import (
"strings"
"codeberg.org/scip/esctl/pkg/cfg"
"github.com/seeruk/go-wordwrap"
"gopkg.in/yaml.v3"
)
var (
// ansiCtrlSeq is being used to remove ANSI control sequences so
// that we can properly determine string lenght's
ansiCtrlSeq = regexp.MustCompile(`\033.[0-9;]+m`)
)
// Table stores tabular data for printing
type Table struct {
Mode string // tsv, json, yaml
Headers []string
RawHeaders []string
Entries [][]any
Headers []string // colored headers
RawHeaders []string // plain string headers
Entries [][]any // rows of cells as fed in by pkg/es
rows [][]string // representation used for printing
rows [][]string // representation used for printing, cells are stringified
processed bool
lenHeaders []int
alignInts bool
@@ -43,73 +50,65 @@ type Table struct {
debugGoRoutines bool
}
func NewTable(conf *cfg.Config, columns, rows int) *Table {
table := new(Table{
// NewTable returns a new empty table object with unaligned storage
func NewTable(conf *cfg.Config) *Table {
return new(Table{
Mode: conf.Output,
maxwidth: cfg.GetTermWidth(),
debugGoRoutines: conf.DebugGoRoutines,
Headers: []string{},
RawHeaders: []string{},
lenHeaders: []int{},
alignInts: conf.AlignInts,
})
table.Headers = make([]string, columns)
table.RawHeaders = make([]string, columns)
table.Entries = make([][]any, rows)
table.lenHeaders = make([]int, columns)
table.alignInts = conf.AlignInts
return table
}
func NewTableEmpty(conf *cfg.Config) *Table {
table := new(Table{
Mode: conf.Output,
maxwidth: cfg.GetTermWidth(),
debugGoRoutines: conf.DebugGoRoutines,
})
table.alignInts = conf.AlignInts
return table
}
func (table *Table) WithHeaders(headers ...string) *Table {
count := len(headers)
table.Entries = [][]any{}
table.lenHeaders = make([]int, count)
table.Headers = make([]string, count)
table.RawHeaders = make([]string, count)
table.Addheaders(headers...)
return table
}
func (table *Table) Print() error {
var err error
switch table.Mode {
case "json":
err = table.PrintJSON()
case "yaml":
err = table.PrintYAML()
case "csv":
err = table.PrintCSV()
default:
err = table.PrintTSV()
// WithSize configures the dimensions of the table, allocs aligned storage
func (t *Table) WithSize(columns, rows int) *Table {
if columns > 0 {
t.Headers = make([]string, columns)
t.RawHeaders = make([]string, columns)
t.lenHeaders = make([]int, columns)
}
if table.debugGoRoutines {
if rows > 0 {
t.Entries = make([][]any, rows)
}
return t
}
// WithHeaders sets table headers
func (t *Table) WithHeaders(headers ...string) *Table {
count := len(headers)
return t.WithSize(count, 0).formatHeaders(headers...)
}
// Print outputs the tabular data according to Table.Mode
func (t *Table) Print() error {
var err error
switch t.Mode {
case "json":
err = t.PrintJSON()
case "yaml":
err = t.PrintYAML()
case "csv":
err = t.PrintCSV()
default:
err = t.PrintTSV()
}
if t.debugGoRoutines {
printGoRoutineMetrics()
}
return err
}
var (
ansiCtrlSeq = regexp.MustCompile(`\033.[0-9;]+m`)
)
func (table *Table) PrintYAML() error {
raw := table.toMap()
func (t *Table) PrintYAML() error {
raw := t.toMap()
body, err := yaml.Marshal(raw)
if err != nil {
@@ -121,8 +120,8 @@ func (table *Table) PrintYAML() error {
return nil
}
func (table *Table) PrintJSON() error {
raw := table.toMap()
func (t *Table) PrintJSON() error {
raw := t.toMap()
body, err := json.MarshalIndent(raw, "", " ")
if err != nil {
@@ -134,80 +133,12 @@ func (table *Table) PrintJSON() error {
return nil
}
func (table *Table) PrintTSV() error {
// length's, convert cell types
table.preprocessRows()
func (t *Table) PrintCSV() error {
t.preprocessRows()
// output headers
for idx, header := range table.Headers {
if idx+1 != len(table.Headers) {
fmt.Print(header, strings.Repeat(" ", table.lenHeaders[idx]-visibleLen(header)))
} else {
// no padding for last header
fmt.Print(header)
}
fmt.Println(strings.Join(t.RawHeaders, ","))
if idx < len(table.Headers)-1 {
fmt.Print(" ")
}
}
fmt.Println()
for _, entries := range table.rows {
currentWidth := 0
for idx, entry := range entries {
length := visibleLen(entry)
if length+currentWidth > table.maxwidth && table.maxwidth-currentWidth > 1 {
// text is too wide to be put into one line, wrap it
wrapper := wordwrap.Wrapper(table.maxwidth-currentWidth, false)
wrapped := wrapper(entry)
// and indent it
first := true
for line := range strings.Lines(wrapped) {
if first {
entry = line
first = false
} else {
entry += "\n " + strings.Repeat(" ", currentWidth) + line
}
}
}
currentWidth += table.lenHeaders[idx]
switch {
case isInt(entry) && table.alignInts:
// align right
fmt.Print(strings.Repeat(" ", table.lenHeaders[idx]-length), entry)
case length < table.lenHeaders[idx] && idx+1 != len(entries):
// pad right, if required
fmt.Print(entry, strings.Repeat(" ", table.lenHeaders[idx]-length))
default:
// no padding for last entry
fmt.Print(entry)
}
if idx < len(table.Headers)-1 {
fmt.Print(" ")
}
}
fmt.Println()
}
return nil
}
func (table *Table) PrintCSV() error {
table.preprocessRows()
fmt.Println(strings.Join(table.RawHeaders, ","))
for _, entries := range table.rows {
for _, entries := range t.rows {
row := make([]string, len(entries))
for idx, entry := range entries {
@@ -224,69 +155,220 @@ func (table *Table) PrintCSV() error {
return nil
}
func (table *Table) Sort() {
// Sort tabular data by first column
func (t *Table) Sort() {
// sanity checks
if len(table.Entries) == 0 {
if len(t.Entries) == 0 {
return
}
table.preprocessRows()
t.preprocessRows()
sort.Slice(table.rows, func(i, j int) bool {
return table.rows[i][0] < table.rows[j][0]
sort.Slice(t.rows, func(i, j int) bool {
return t.rows[i][0] < t.rows[j][0]
})
}
func (table *Table) Addheaders(headers ...string) {
for idx, header := range headers {
switch table.Mode {
case "json", "yaml":
table.Headers[idx] = strings.ReplaceAll(strings.ToLower(header), " ", "_")
default:
table.Headers[idx] = bold(strings.ReplaceAll(strings.ToUpper(header), " ", "-"))
}
table.RawHeaders[idx] = header
}
func (t *Table) AddRow(fields ...any) {
t.Entries = append(t.Entries, fields)
}
func (table *Table) AddRow(fields ...any) {
table.Entries = append(table.Entries, fields)
}
func (t *Table) AddRowLate(fields ...any) {
t.AddRow(fields)
func (table *Table) AddRowLate(fields ...any) {
table.AddRow(fields)
if !table.processed {
if !t.processed {
return
}
row := make([]string, len(fields))
for idx, field := range fields {
row[idx] = any2string(field)
row[idx] = stringer(field)
}
table.rows = append(table.rows, row)
t.rows = append(t.rows, row)
}
// PrintTSV is the default printer, it outputs in tab-separated-value format
func (t *Table) PrintTSV() error {
t.preprocessRows()
t.printTsvHeaders()
return t.printTsvRows()
}
func (t *Table) printTsvRows() error {
for _, entries := range t.rows {
currentWidth := 0
columns := len(entries)
for idx, entry := range entries {
length := visibleLen(entry)
if length+currentWidth > t.maxwidth &&
t.maxwidth-currentWidth > 1 &&
idx == columns-1 {
// text is too wide to be put into one line, and
// it's the last cell, so wrap it
entry = wrap(t.maxwidth-currentWidth, currentWidth+2, entry)
}
currentWidth += t.lenHeaders[idx]
switch {
case isInt(entry) && t.alignInts:
// align right
fmt.Print(strings.Repeat(" ", t.lenHeaders[idx]-length), entry)
case length < t.lenHeaders[idx] && idx+1 != len(entries):
// pad right, if required
fmt.Print(entry, strings.Repeat(" ", t.lenHeaders[idx]-length))
default:
// no padding for last entry
fmt.Print(entry)
}
if idx < len(t.Headers)-1 {
fmt.Print(" ")
}
}
fmt.Println()
}
return nil
}
// printTsvHeaders outputs TSV headers
func (t *Table) printTsvHeaders() {
for idx, header := range t.Headers {
if idx+1 != len(t.Headers) {
fmt.Print(header, strings.Repeat(" ", t.lenHeaders[idx]-visibleLen(header)))
} else {
// no padding for last header
fmt.Print(header)
}
if idx < len(t.Headers)-1 {
fmt.Print(" ")
}
}
fmt.Println()
}
// formatHeaders formats header fields according to output mode
func (t *Table) formatHeaders(headers ...string) *Table {
for idx, header := range headers {
switch t.Mode {
case "json", "yaml":
t.Headers[idx] = strings.ReplaceAll(strings.ToLower(header), " ", "_")
default:
t.Headers[idx] = Bold(strings.ReplaceAll(strings.ToUpper(header), " ", "-"))
}
t.RawHeaders[idx] = header
}
return t
}
// Wrap a text into multiple lines, first line is not indented, all
// further lines will be indented. Used within Print() to print large
// cell text.
func wrap(width, indent int, text string) string {
if len(text) <= width {
return text
}
wrapped := ""
line := ""
for word := range strings.FieldsSeq(text) {
if len(line)+len(word)+1 <= width {
// appending word to current line doesn't exceed width
if line != "" {
line += " "
}
line += word
} else {
// it exceeds it, so we need to wrap
if wrapped == "" {
// beginning of output, no indenting here
wrapped = line + "\n"
} else {
// we're in the middle of the text, so add the indent
wrapped += strings.Repeat(" ", indent) + line + "\n"
}
// remember the current word for the next round
line = word
}
}
if line != "" {
// last line, no newline needed here
wrapped += strings.Repeat(" ", indent) + line
}
return wrapped
}
// needed for json and yaml output
func (table *Table) toMap() []map[string]any {
raw := make([]map[string]any, len(table.Entries))
func (t *Table) toMap() []map[string]any {
raw := make([]map[string]any, len(t.Entries))
for idx, entries := range table.Entries {
raw[idx] = make(map[string]any, len(table.Headers))
for idx, entries := range t.Entries {
raw[idx] = make(map[string]any, len(t.Headers))
for eidx, entry := range entries {
raw[idx][table.Headers[eidx]] = entry
raw[idx][t.Headers[eidx]] = entry
}
}
return raw
}
// return the length of a string but only visible chars, w/o ansi color escapes
func visibleLen(word string) int {
return len(ansiCtrlSeq.ReplaceAllLiteralString(word, ""))
func (t *Table) preprocessRows() {
if t.processed {
// only do it once
return
}
// convert entries to strings
t.rows = make([][]string, len(t.Entries))
for rowidx, entries := range t.Entries {
t.rows[rowidx] = make([]string, len(entries))
for colidx, entry := range t.Entries[rowidx] {
t.rows[rowidx][colidx] = stringer(entry)
}
}
// determine header lenght's
for idx, head := range t.Headers {
t.lenHeaders[idx] = visibleLen(head)
}
// determine max width per column
for _, entries := range t.rows {
currentWidth := 0
for idx, entry := range entries {
length := visibleLen(entry)
if t.lenHeaders[idx] < length {
if length > currentWidth+t.maxwidth {
t.lenHeaders[idx] = t.maxwidth - currentWidth
} else {
t.lenHeaders[idx] = length
}
}
currentWidth += t.lenHeaders[idx]
}
}
t.processed = true
}
func isInt(num string) bool {

View File

@@ -1,4 +1,4 @@
.PHONY: test clean cluster docs search up down delete
.PHONY: test clean cluster docs search up down delete runenv
# docker stuff
up:
@@ -20,6 +20,8 @@ delete:
clean-docker: down delete
runenv: up waitup cluster docs wait
# mosscap esctl stuff
test: up waitup cluster docs wait search