Documentation for mz-debug #32099
Documentation for mz-debug #32099
Conversation
SangJunBak
force-pushed
the
jun/#8908/polish
branch
from
96f971a to
90f0c91
Compare
| For questions, discussions, or general technical support, join the [Materialize | ||
| Community on Slack](https://materialize.com/s/chat). | ||
|
|
||
| #### `mz-debug` |
There was a problem hiding this comment.
As an fyi -- we'll need to manually add teh mz-debug page to https://github.com/MaterializeInc/materialize/blob/main/doc/user/content/integrations/_index.md page as well.
SangJunBak
changed the title
- We can actually specify the global options anywhere. I still wanted to separate the global flags from the non-global flags however. Thus I put it in the bottom, similar to Cockroach - Changed the install instructions for linux. Also tested in a linux VM as well.
|
@kay-kim made some changes in the last commit! Sorry this took so long! |
|
|
||
| ## Installation | ||
|
|
||
| ```shell |
There was a problem hiding this comment.
We should separate these so that the commands are actually copyable.
We can use tabs or use separate subheaders.
| disable_list: true | ||
| --- | ||
|
|
||
| `mz-debug` is a command-line interface tool that collects debug information for self-managed and emulator Materialize environments. By default, the tool creates a compressed file (`.zip`) containing logs and a dump of the system catalog. You can then share this file with support teams when investigating issues. |
There was a problem hiding this comment.
Q: Is the "By default" referring to that contents; i.e., the logs and the dump of the system catalog? as opposed to you can have it not create the zip file and do something instead?
|
|
||
| #### `mz-debug` | ||
|
|
||
| Materialize provides a command-line debug tool called `mz-debug` that helps collect diagnostic information from your emulator environment. This tool can gather: |
There was a problem hiding this comment.
Maybe:
Materialize provides mz-debug, a command-line debug tool, that collects diagnostic information from your emulator environment. This tool can gather:
Still working on actually deploying the binaries but the docs should stay relatively the same.
Will make a followup PR to make changes to the self managed docs branch.
Motivation
Tips for reviewer
Checklist
$T ⇔ Proto$Tmapping (possibly in a backwards-incompatible way), then it is tagged with aT-protolabel.