bucket inspect: Adds csv, tsv printer for inspect command

cmd/thanos/tools_bucket.go

@@ -6,8 +6,10 @@ package main
 import (
 	"context"
 	"crypto/rand"
+	"encoding/csv"
 	"encoding/json"
 	"fmt"
+	"io"
 	"io/ioutil"
 	"net/http"
 	"os"
@@ -70,6 +72,15 @@ var (
 		},
 	}
 	inspectColumns = []string{"ULID", "FROM", "UNTIL", "RANGE", "UNTIL-DOWN", "#SERIES", "#SAMPLES", "#CHUNKS", "COMP-LEVEL", "COMP-FAILED", "LABELS", "RESOLUTION", "SOURCE"}
+	outputTypes    = []string{"table", "tsv", "csv"}
+)
+
+type outputType string
+
+const (
+	TABLE outputType = "table"
+	CSV   outputType = "csv"
+	TSV   outputType = "tsv"
 )
 
 func registerBucket(app extkingpin.AppClause) {
@@ -274,6 +285,8 @@ func registerBucketInspect(app extkingpin.AppClause, objStoreConfig *extflag.Pat
 		Default("FROM", "UNTIL").Enums(inspectColumns...)
 	timeout := cmd.Flag("timeout", "Timeout to download metadata from remote storage").Default("5m").Duration()
 
+	output := cmd.Flag("output", "Output format for result. Currently supports table, cvs, tsv.").Default("table").Enum(outputTypes...)
+
 	cmd.Setup(func(g *run.Group, logger log.Logger, reg *prometheus.Registry, _ opentracing.Tracer, _ <-chan struct{}, _ bool) error {
 
 		// Parse selector.
@@ -316,7 +329,17 @@ func registerBucketInspect(app extkingpin.AppClause, objStoreConfig *extflag.Pat
 			blockMetas = append(blockMetas, meta)
 		}
 
-		return printTable(blockMetas, selectorLabels, *sortBy)
+		var opPrinter tablePrinter
+		op := outputType(*output)
+		switch op {
+		case TABLE:
+			opPrinter = printTable
+		case TSV:
+			opPrinter = printTSV
+		case CSV:
+			opPrinter = printCSV
+		}
+		return printBlockData(blockMetas, selectorLabels, *sortBy, opPrinter)
 	})
 }
 
@@ -619,7 +642,56 @@ func registerBucketCleanup(app extkingpin.AppClause, objStoreConfig *extflag.Pat
 	})
 }
 
-func printTable(blockMetas []*metadata.Meta, selectorLabels labels.Labels, sortBy []string) error {
+type tablePrinter func(w io.Writer, t Table) error
+
+func printTable(w io.Writer, t Table) error {
+	table := tablewriter.NewWriter(w)
+	table.SetHeader(t.Header)
+	table.SetBorders(tablewriter.Border{Left: true, Top: false, Right: true, Bottom: false})
+	table.SetCenterSeparator("|")
+	table.SetAutoWrapText(false)
+	table.SetReflowDuringAutoWrap(false)
+	table.SetAlignment(tablewriter.ALIGN_LEFT)
+	table.AppendBulk(t.Lines)
+	table.Render()
+	return nil
+}
+
+func printCSV(w io.Writer, t Table) error {
+	csv := csv.NewWriter(w)
+	err := csv.Write(t.Header)
+	if err != nil {
+		return err
+	}
+	err = csv.WriteAll(t.Lines)
+	if err != nil {
+		return err
+	}
+	csv.Flush()
+	return nil
+}
+
+func newTSVWriter(w io.Writer) *csv.Writer {
+	writer := csv.NewWriter(w)
+	writer.Comma = rune('\t')
+	return writer
+}
+
+func printTSV(w io.Writer, t Table) error {
+	tsv := newTSVWriter(w)
+	err := tsv.Write(t.Header)
+	if err != nil {
+		return err
+	}
+	err = tsv.WriteAll(t.Lines)
+	if err != nil {
+		return err
+	}
+	tsv.Flush()
+	return nil
+}
+
+func printBlockData(blockMetas []*metadata.Meta, selectorLabels labels.Labels, sortBy []string, printer tablePrinter) error {
 	header := inspectColumns
 
 	var lines [][]string
@@ -671,17 +743,10 @@ func printTable(blockMetas []*metadata.Meta, selectorLabels labels.Labels, sortB
 
 	t := Table{Header: header, Lines: lines, SortIndices: sortByColNum}
 	sort.Sort(t)
-
-	table := tablewriter.NewWriter(os.Stdout)
-	table.SetHeader(t.Header)
-	table.SetBorders(tablewriter.Border{Left: true, Top: false, Right: true, Bottom: false})
-	table.SetCenterSeparator("|")
-	table.SetAutoWrapText(false)
-	table.SetReflowDuringAutoWrap(false)
-	table.SetAlignment(tablewriter.ALIGN_LEFT)
-	table.AppendBulk(t.Lines)
-	table.Render()
-
+	err := printer(os.Stdout, t)
+	if err != nil {
+		return errors.Errorf("unable to write output.")
+	}
 	return nil
 }
 

docs/components/tools.md

@@ -431,7 +431,9 @@ Flags:
                              Path to YAML file that contains object store
                              configuration. See format details:
                              https://thanos.io/tip/thanos/storage.md/#configuration
-  -l, --selector=<name>=\"<value>\" ...  
+      --output=table         Output format for result. Currently supports table,
+                             cvs, tsv.
+  -l, --selector=<name>=\"<value>\" ...
                              Selects blocks based on label, e.g. '-l
                              key1=\"value1\" -l key2=\"value2\"'. All key value
                              pairs must match.