Enhance the output of consul snapshot inspect #8787

schristoff · 2020-09-30T21:03:48Z

Adding @banks Consul Snapshot tool which enhances the output of the consul snapshot inspect command to look something like this:

consul snapshot inspect -enhance backup.snap

 Type                        Count      Size
 ----                        ----       ----
 Register                    3          1.7KB
 ConnectCA                   1          1.2KB
 ConnectCAProviderState      1          1.1KB
 Index                       12         344B
 AutopilotRequest            1          199B
 ConnectCAConfig             1          197B
 FederationState             1          139B
 SystemMetadata              1          68B
 ChunkingState               1          12B
 ----                        ----       ----
 Total                                   5KB

On the downside, each time a new type is added it will need to be added in two places as RB as shown below.

…n be decoded into a struct. (valueType: 2)\n

…consul_snappyshot

agent/structs/structs.go

command/snapshot/inspect/snapshot_inspect.go

freddygv

This is looking good. Great to see it's being released soon!

Added some mostly stylistic suggestions.

command/snapshot/inspect/snapshot_inspect.go

agent/structs/structs.go

command/snapshot/inspect/snapshot_inspect.go

agent/structs/structs.go

freddygv · 2020-10-08T20:39:54Z

command/snapshot/inspect/snapshot_inspect.go

+		}
+		stats, offset, err := enhance(file)
+		if err != nil {
+			c.UI.Error(fmt.Sprintf("Error verifying snapshot: %s", err))


This error message could be updated, it's from the old call to snapshot.Verify()

Co-authored-by: Freddy <freddygv@users.noreply.github.com>

command/snapshot/inspect/snapshot_inspect.go

command/snapshot/inspect/snapshot_inspect_test.go

command/snapshot/inspect/testdata/TestSnapshotInspectEnhanceCommand.golden

command/snapshot/inspect/snapshot_inspect_test.go

Co-authored-by: Daniel Nephin <dnephin@hashicorp.com>

agent/structs/structs.go

command/snapshot/inspect/formatter.go

command/snapshot/inspect/snapshot_inspect.go

website/pages/commands/snapshot/inspect.mdx

agent/consul/fsm/fsm.go

Co-authored-by: R.B. Boyer <rb@hashicorp.com>

…consul_snappyshot

mkeeler

Just the one change necessary to the changelog entry but otherwise 👍

mkeeler · 2020-10-09T19:03:05Z

.changelog/8787.txt

@@ -0,0 +1,3 @@
+```release-note:feature
+agent: update `consul snapshot inspect` command to provide more detailed snapshot data


Suggested change

agent: update `consul snapshot inspect` command to provide more detailed snapshot data

snapshot: update `consul snapshot inspect` command to provide more detailed snapshot data

agent/structs/structs.go

command/snapshot/inspect/snapshot_inspect.go

dnephin

a few minor things, but I think the defer to remove the temp file would be good to handle

command/snapshot/inspect/snapshot_inspect.go

command/snapshot/inspect/snapshot_inspect_test.go

Sarah Christoff added 6 commits July 27, 2020 16:23

pass one

8db378a

added stuff into structs, handler still isnt right

5b8919f

we need offset and to count better

79dc01e

add countingreader struct, how to count though?

66226a3

add countingreader

ab15b60

it outputs?

d0b833e

schristoff requested a review from dnephin September 30, 2020 21:03

hashibot-web deployed to Netlify Deploy Preview September 30, 2020 21:11 View deployment

Sarah Christoff added 2 commits September 30, 2020 16:13

remove weird serf line

7659df9

Merge branch 'master' into consul_snappyshot

deaf3f4

hashibot-web deployed to Netlify Deploy Preview October 1, 2020 18:45 View deployment

Sarah Christoff added 2 commits October 5, 2020 11:25

Error verifying snapshot: codec.decoder: Only encoded map or array ca…

e4168ae

…n be decoded into a struct. (valueType: 2)\n

Merge branch 'consul_snappyshot' of github.com:hashicorp/consul into …

cbaaaf0

…consul_snappyshot

rboyer reviewed Oct 6, 2020

View reviewed changes

agent/structs/structs.go Outdated Show resolved Hide resolved

rboyer reviewed Oct 6, 2020

View reviewed changes

command/snapshot/inspect/snapshot_inspect.go Show resolved Hide resolved

Sarah Christoff added 3 commits October 7, 2020 14:31

minor changes

407eb6f

daniel fixed read so much, test failing cannot open file?

6d118ba

test passing?

94c24db

schristoff changed the title ~~[WIP] Enhance the output of consul snapshot inspect~~ Enhance the output of consul snapshot inspect Oct 8, 2020

Merge branch 'master' into consul_snappyshot

df0db1c

hashibot-web deployed to Netlify Deploy Preview October 8, 2020 16:38 View deployment

done?

a94a42e

schristoff requested review from a team and rboyer October 8, 2020 19:26

hashibot-web deployed to Netlify Deploy Preview October 8, 2020 19:33 View deployment

freddygv reviewed Oct 8, 2020

View reviewed changes

s-christoff and others added 4 commits October 8, 2020 16:21

Update command/snapshot/inspect/snapshot_inspect.go

b2c2585

Co-authored-by: Freddy <freddygv@users.noreply.github.com>

Update command/snapshot/inspect/snapshot_inspect.go

a43762c

Co-authored-by: Freddy <freddygv@users.noreply.github.com>

Update agent/structs/structs.go

9723aed

Co-authored-by: Freddy <freddygv@users.noreply.github.com>

Update agent/structs/structs.go

084053e

Co-authored-by: Freddy <freddygv@users.noreply.github.com>

dnephin reviewed Oct 8, 2020

View reviewed changes

command/snapshot/inspect/snapshot_inspect.go Show resolved Hide resolved

command/snapshot/inspect/snapshot_inspect.go Outdated Show resolved Hide resolved

command/snapshot/inspect/snapshot_inspect_test.go Outdated Show resolved Hide resolved

dnephin reviewed Oct 8, 2020

View reviewed changes

command/snapshot/inspect/testdata/TestSnapshotInspectEnhanceCommand.golden Outdated Show resolved Hide resolved

dnephin reviewed Oct 8, 2020

View reviewed changes

command/snapshot/inspect/snapshot_inspect_test.go Outdated Show resolved Hide resolved

s-christoff and others added 2 commits October 8, 2020 22:56

Update command/snapshot/inspect/snapshot_inspect_test.go

a09306c

Co-authored-by: Daniel Nephin <dnephin@hashicorp.com>

Everything is broken, trying to add JSON/Pretty Print

8378618

mkeeler reviewed Oct 9, 2020

View reviewed changes

rboyer reviewed Oct 9, 2020

View reviewed changes

agent/consul/fsm/fsm.go Outdated Show resolved Hide resolved

goodbye enhance, seeya later json

a68c72c

schristoff force-pushed the consul_snappyshot branch from 230168b to a68c72c Compare October 9, 2020 16:56

hashibot-web deployed to Netlify Deploy Preview October 9, 2020 17:04 View deployment

s-christoff and others added 8 commits October 9, 2020 12:21

Update agent/consul/fsm/fsm.go

ec8f45f

Co-authored-by: R.B. Boyer <rb@hashicorp.com>

almost done

240d412

Merge branch 'consul_snappyshot' of github.com:hashicorp/consul into …

d438a40

…consul_snappyshot

remove golden enhance

d5f2683

fix ent struct

481225e

backups change, this one wont

a32d3a2

sacrifice lines to appease the linter

955a8fd

first ever changelog file :)

6623e2b

mkeeler approved these changes Oct 9, 2020

View reviewed changes

dnephin reviewed Oct 9, 2020

View reviewed changes

agent/structs/structs.go Outdated Show resolved Hide resolved

dnephin reviewed Oct 9, 2020

View reviewed changes

command/snapshot/inspect/snapshot_inspect.go Outdated Show resolved Hide resolved

updates

7bd3788

dnephin reviewed Oct 9, 2020

View reviewed changes

final countdown

0b1d79d

schristoff merged commit 9bb348c into master Oct 9, 2020

schristoff deleted the consul_snappyshot branch October 9, 2020 19:57

This was referenced Oct 21, 2020

Improvements to consul snapshot inspect CLI command #7106

Closed

WIP - Add size statistics to consul snapshot inspect output #7349

Closed

schristoff mentioned this pull request Nov 2, 2020

Add KV size breakdown banks/consul-snapshot-tool#5

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhance the output of consul snapshot inspect #8787

Enhance the output of consul snapshot inspect #8787

schristoff commented Sep 30, 2020 •

edited

Loading

freddygv left a comment

freddygv Oct 8, 2020

mkeeler left a comment

mkeeler Oct 9, 2020

dnephin left a comment

		@@ -0,0 +1,3 @@
		```release-note:feature
		agent: update `consul snapshot inspect` command to provide more detailed snapshot data

	agent: update `consul snapshot inspect` command to provide more detailed snapshot data
	snapshot: update `consul snapshot inspect` command to provide more detailed snapshot data

Enhance the output of consul snapshot inspect #8787

Enhance the output of consul snapshot inspect #8787

Conversation

schristoff commented Sep 30, 2020 • edited Loading

freddygv left a comment

Choose a reason for hiding this comment

freddygv Oct 8, 2020

Choose a reason for hiding this comment

mkeeler left a comment

Choose a reason for hiding this comment

mkeeler Oct 9, 2020

Choose a reason for hiding this comment

dnephin left a comment

Choose a reason for hiding this comment

schristoff commented Sep 30, 2020 •

edited

Loading