Add the first iteration of the blocks viewer cli tool #2697
Conversation
aleks-p
force-pushed
the
block-viewer-cli
branch
from
20a6a73
to
1a5bd95
Compare
cmd/profilecli/blocks_tool.go
Outdated
| blocksWebToolCmd.Flag("object-store-type", "The type of the object storage (e.g., gcs).").Default("gcs").StringVar(¶ms.objectStoreType) | ||
| blocksWebToolCmd.Flag("bucket-name", "The name of the object storage bucket.").StringVar(¶ms.bucketName) |
There was a problem hiding this comment.
I really would prefer if we could mimic flags from pyroscope itself and support all the options by calling RegisterFlags.
Unsure that might be also incredibly hard
There was a problem hiding this comment.
I tried but it doesn't seem simple enough to do without a bigger refactor, can plan this for later though.
pkg/admin/admin.go
Outdated
| @@ -0,0 +1 @@ | |||
| package admin | |||
There was a problem hiding this comment.
Unsure we need this at this point
There was a problem hiding this comment.
No, that is a leftover from something else, good catch!
cmd/profilecli/blocks_tool.go
Outdated
| out := output(ctx) | ||
|
|
||
| fmt.Fprintf(out, "The blocks web tool is available at http://localhost:%d/blocks/index\n", t.params.httpListenPort) | ||
|
|
There was a problem hiding this comment.
Nice to have: Potentially open the browser automatically: https://stackoverflow.com/questions/39320371/how-start-web-server-to-open-page-in-browser-in-golang
There was a problem hiding this comment.
That is a good idea and perhaps it needs to be behind a flag if someone finds getting multiple tabs from multiple runs annoying. One issue with most solutions though is they are not robust enough. For example, to open the browser only when the server is successfully up we need to do something like https://stackoverflow.com/questions/32738188/how-can-i-start-the-browser-after-the-server-started-listening/32742904#32742904 but we can't since we don't start the server this way.
Addresses #2541
Usage:
profilecli tool blocks web --bucket-name <object_store_bucket_name>http://localhost:4201/blocks/indexin a browser (the URL is also printed to stdout)Notes:
Next steps (outside of this PR):
Screen.Recording.2023-11-17.at.07.55.34.mov