Skip to content
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

swarm-rafttool: add json output format flag #2898

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

swarm-rafttool: add json output format flag #2898

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9dcecbc
swarm-rafttool: add output format flag
Sep 23, 2019
7fea010
swarm-rafttool: pretty print json format
Sep 24, 2019
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
107 changes: 81 additions & 26 deletions cmd/swarm-rafttool/dump.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package main

import (
"context"
"encoding/json"
"errors"
"fmt"
"os"
Expand Down Expand Up @@ -84,17 +85,38 @@ func dumpWAL(swarmdir, unlockKey string, start, end uint64, redact bool) error {

for _, ent := range walData.Entries {
if (start == 0 || ent.Index >= start) && (end == 0 || ent.Index <= end) {
fmt.Printf("Entry Index=%d, Term=%d, Type=%s:\n", ent.Index, ent.Term, ent.Type.String())
if format == "text" {
fmt.Printf("Entry Index=%d, Term=%d, Type=%s:\n", ent.Index, ent.Term, ent.Type.String())
}
switch ent.Type {
case raftpb.EntryConfChange:

cc := &raftpb.ConfChange{}
err := proto.Unmarshal(ent.Data, cc)
if err != nil {
return err
}

fmt.Println("Conf change type:", cc.Type.String())
fmt.Printf("Node ID: %x\n\n", cc.NodeID)
switch format {
case "text":
fmt.Println("Conf change type:", cc.Type.String())
fmt.Printf("Node ID: %x\n\n", cc.NodeID)
fmt.Println()
case "json":
err := json.NewEncoder(os.Stdout).Encode(struct {
trapier marked this conversation as resolved.
Show resolved Hide resolved
Term uint64
Index uint64
Type raftpb.EntryType
Data *raftpb.ConfChange
}{
ent.Term,
ent.Index,
ent.Type,
cc,
})
if err != nil {
return err
}
}

case raftpb.EntryNormal:
r := &api.InternalRaftRequest{}
Expand Down Expand Up @@ -135,10 +157,28 @@ func dumpWAL(swarmdir, unlockKey string, start, end uint64, redact bool) error {
}
}

if err := proto.MarshalText(os.Stdout, r); err != nil {
return err
switch format {
case "text":
if err := proto.MarshalText(os.Stdout, r); err != nil {
return err
}
fmt.Println()
case "json":
err := json.NewEncoder(os.Stdout).Encode(struct {
Term uint64
Index uint64
Type raftpb.EntryType
Data *api.InternalRaftRequest
}{
Term: ent.Term,
Index: ent.Index,
Type: ent.Type,
Data: r,
})
if err != nil {
return err
}
}
fmt.Println()
}
}
}
Expand All @@ -164,18 +204,6 @@ func dumpSnapshot(swarmdir, unlockKey string, redact bool) error {
return fmt.Errorf("unrecognized snapshot version %d", s.Version)
}

fmt.Println("Active members:")
for _, member := range s.Membership.Members {
fmt.Printf(" NodeID=%s, RaftID=%x, Addr=%s\n", member.NodeID, member.RaftID, member.Addr)
}
fmt.Println()

fmt.Println("Removed members:")
for _, member := range s.Membership.Removed {
fmt.Printf(" RaftID=%x\n", member)
}
fmt.Println()

if redact {
for _, cluster := range s.Store.Clusters {
if cluster != nil {
Expand Down Expand Up @@ -218,11 +246,30 @@ func dumpSnapshot(swarmdir, unlockKey string, redact bool) error {
}
}

fmt.Println("Objects:")
if err := proto.MarshalText(os.Stdout, &s.Store); err != nil {
return err
switch format {
case "text":
fmt.Println("Active members:")
for _, member := range s.Membership.Members {
fmt.Printf(" NodeID=%s, RaftID=%x, Addr=%s\n", member.NodeID, member.RaftID, member.Addr)
}
fmt.Println()

fmt.Println("Removed members:")
for _, member := range s.Membership.Removed {
fmt.Printf(" RaftID=%x\n", member)
}
fmt.Println()

fmt.Println("Objects:")
if err := proto.MarshalText(os.Stdout, &s.Store); err != nil {
return err
}
fmt.Println()
case "json":
if err := json.NewEncoder(os.Stdout).Encode(&s); err != nil {
return err
}
}
fmt.Println()

return nil
}
Expand Down Expand Up @@ -452,10 +499,18 @@ func dumpObject(swarmdir, unlockKey, objType string, selector objSelector) error
}

for _, object := range objects {
if err := proto.MarshalText(os.Stdout, object); err != nil {
return err
switch format {
case "text":
if err := proto.MarshalText(os.Stdout, object); err != nil {
return err
}
fmt.Println()
case "json":
if err := json.NewEncoder(os.Stdout).Encode(object); err != nil {
return err
}

}
fmt.Println()
}

return nil
Expand Down
23 changes: 23 additions & 0 deletions cmd/swarm-rafttool/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ import (
)

var (
format string

mainCmd = &cobra.Command{
Use: os.Args[0],
Short: "Tool to translate and decrypt the raft logs of a swarm manager",
Expand Down Expand Up @@ -45,6 +47,9 @@ var (
dumpWALCmd = &cobra.Command{
Use: "dump-wal",
Short: "Display entries from the Raft log",
PreRunE: func(cmd *cobra.Command, args []string) error {
return validateFormatFlag(format)
},
RunE: func(cmd *cobra.Command, args []string) error {
stateDir, err := cmd.Flags().GetString("state-dir")
if err != nil {
Expand Down Expand Up @@ -78,6 +83,9 @@ var (
dumpSnapshotCmd = &cobra.Command{
Use: "dump-snapshot",
Short: "Display entries from the latest Raft snapshot",
PreRunE: func(cmd *cobra.Command, args []string) error {
return validateFormatFlag(format)
},
RunE: func(cmd *cobra.Command, args []string) error {
stateDir, err := cmd.Flags().GetString("state-dir")
if err != nil {
Expand All @@ -101,6 +109,9 @@ var (
dumpObjectCmd = &cobra.Command{
Use: "dump-object [type]",
Short: "Display an object from the Raft snapshot/WAL",
PreRunE: func(cmd *cobra.Command, args []string) error {
return validateFormatFlag(format)
},
RunE: func(cmd *cobra.Command, args []string) error {
if len(args) != 1 {
return errors.New("dump-object subcommand takes exactly 1 argument")
Expand Down Expand Up @@ -159,6 +170,15 @@ var (
}
)

func validateFormatFlag(format string) error {
switch format {
case "text", "json":
return nil
default:
return fmt.Errorf("invalid 'format' %s", format)
}
}

func init() {
mainCmd.PersistentFlags().StringP("state-dir", "d", defaults.StateDir, "State directory")
mainCmd.PersistentFlags().String("unlock-key", "", "Unlock key, if raft logs are encrypted")
Expand All @@ -172,13 +192,16 @@ func init() {
)

dumpSnapshotCmd.Flags().Bool("redact", false, "Redact the values of secrets, configs, and environment variables")
dumpSnapshotCmd.Flags().StringVar(&format, "format", "text", `Output format (text|json)`)

dumpWALCmd.Flags().Uint64("start", 0, "Start of index range to dump")
dumpWALCmd.Flags().Uint64("end", 0, "End of index range to dump")
dumpWALCmd.Flags().Bool("redact", false, "Redact the values of secrets, configs, and environment variables")
dumpWALCmd.Flags().StringVar(&format, "format", "text", `Output format (text|json)`)

dumpObjectCmd.Flags().String("id", "", "Look up object by ID")
dumpObjectCmd.Flags().String("name", "", "Look up object by name")
dumpObjectCmd.Flags().StringVar(&format, "format", "text", `Output format (text|json)`)
}

func main() {
Expand Down