Skip to content

[tempo-cli] Add flags to print simple summary vs full summary #4120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 27, 2024
Merged

[tempo-cli] Add flags to print simple summary vs full summary #4120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 44 additions & 21 deletions cmd/tempo-cli/cmd-analyse-block.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,12 @@ func dedicatedColPathForVersion(i int, scope backend.DedicatedColumnScope, v str
type analyseBlockCmd struct {
backendOptions

TenantID string `arg:"" help:"tenant-id within the bucket"`
BlockID string `arg:"" help:"block ID to list"`
NumAttr int `help:"Number of attributes to display" default:"15"`
GenerateJsonnet bool `help:"Generate overrides Jsonnet for dedicated columns"`
TenantID string `arg:"" help:"tenant-id within the bucket"`
BlockID string `arg:"" help:"block ID to list"`
NumAttr int `help:"Number of attributes to display" default:"15"`
GenerateJsonnet bool `help:"Generate overrides Jsonnet for dedicated columns"`
SimpleSummary bool `help:"Print only single line of top attributes" default:"false"`
PrintFullSummary bool `help:"Print full summary of the analysed block" default:"true"`
}

func (cmd *analyseBlockCmd) Run(ctx *globalOptions) error {
Expand All @@ -106,7 +108,7 @@ func (cmd *analyseBlockCmd) Run(ctx *globalOptions) error {
return errors.New("failed to process block")
}

return blockSum.print(cmd.NumAttr, cmd.GenerateJsonnet)
return blockSum.print(cmd.NumAttr, cmd.GenerateJsonnet, cmd.SimpleSummary, cmd.PrintFullSummary)
}

func processBlock(r backend.Reader, tenantID, blockID string, maxStartTime, minStartTime time.Time, minCompactionLvl uint8) (*blockSummary, error) {
Expand Down Expand Up @@ -198,13 +200,25 @@ type blockSummary struct {
spanSummary, resourceSummary genericAttrSummary
}

func (s *blockSummary) print(maxAttr int, generateJsonnet bool) error {
if err := printSummary("span", maxAttr, s.spanSummary); err != nil {
return err
func (s *blockSummary) print(maxAttr int, generateJsonnet, simpleSummary, printFullSummary bool) error {
if printFullSummary {
if err := printSummary("span", maxAttr, s.spanSummary, false); err != nil {
return err
}

if err := printSummary("resource", maxAttr, s.resourceSummary, false); err != nil {
return err
}
}

if err := printSummary("resource", maxAttr, s.resourceSummary); err != nil {
return err
if simpleSummary {
if err := printSummary("span", maxAttr, s.spanSummary, true); err != nil {
return err
}

if err := printSummary("resource", maxAttr, s.resourceSummary, true); err != nil {
return err
}
}

if generateJsonnet {
Expand Down Expand Up @@ -324,27 +338,36 @@ func aggregateColumn(pf *parquet.File, colName string) (uint64, error) {
return totalBytes, nil
}

func printSummary(scope string, max int, summary genericAttrSummary) error {
func printSummary(scope string, max int, summary genericAttrSummary, simple bool) error {
// TODO: Support more output formats
w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)

if max > len(summary.attributes) {
max = len(summary.attributes)
}

fmt.Printf("Top %d %s attributes by size\n", max, scope)
fmt.Println("")
attrList := topN(max, summary.attributes)
for _, a := range attrList {

name := a.name
if _, ok := summary.dedicated[a.name]; ok {
name = a.name + " (dedicated)"
if simple {
fmt.Printf("%s attributes: ", scope)
for _, a := range attrList {
fmt.Printf("\"%s\", ", a.name)
}
fmt.Println("")
} else {
fmt.Printf("Top %d %s attributes by size\n", max, scope)
for _, a := range attrList {

name := a.name
if _, ok := summary.dedicated[a.name]; ok {
name = a.name + " (dedicated)"
}

percentage := float64(a.bytes) / float64(summary.totalBytes) * 100
_, err := fmt.Fprintf(w, "name: %s\t size: %s\t (%s%%)\n", name, humanize.Bytes(a.bytes), strconv.FormatFloat(percentage, 'f', 2, 64))
if err != nil {
return err
percentage := float64(a.bytes) / float64(summary.totalBytes) * 100
_, err := fmt.Fprintf(w, "name: %s\t size: %s\t (%s%%)\n", name, humanize.Bytes(a.bytes), strconv.FormatFloat(percentage, 'f', 2, 64))
if err != nil {
return err
}
}
}

Expand Down
4 changes: 3 additions & 1 deletion cmd/tempo-cli/cmd-analyse-blocks.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ type analyseBlocksCmd struct {
backendOptions

Jsonnet bool `help:"output Jsonnet necessary for overrides"`
SimpleSummary bool `help:"Print only single line of top attributes" default:"false"`
PrintFullSummary bool `help:"Print full summary of the analysed block" default:"true"`
TenantID string `arg:"" help:"tenant-id within the bucket"`
MinCompactionLevel int `help:"Min compaction level to analyse" default:"3"`
MaxBlocks int `help:"Max number of blocks to analyse" default:"10"`
Expand Down Expand Up @@ -101,5 +103,5 @@ func (cmd *analyseBlocksCmd) Run(ctx *globalOptions) error {
totalBytes: totalResourceBytes,
attributes: topResourceAttrs,
},
}).print(cmd.NumAttr, cmd.Jsonnet)
}).print(cmd.NumAttr, cmd.Jsonnet, cmd.SimpleSummary, cmd.PrintFullSummary)
}