Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* feat: chaosctl for print debug info (#1074) Signed-off-by: yiyiyimu <wosoyoung@gmail.com> * move genrateNNodes out of test file Signed-off-by: yiyiyimu <wosoyoung@gmail.com>
- Loading branch information
Showing
25 changed files
with
1,887 additions
and
113 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| // Copyright 2020 Chaos Mesh Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package main | ||
|
|
||
| import "github.com/chaos-mesh/chaos-mesh/pkg/chaosctl/cmd" | ||
|
|
||
| func main() { | ||
| cmd.Execute() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # chaosctl | ||
|
|
||
| Chaostl is a tool (currently) used to print debug info. Maintainers would make use of it to better provide their suggestions for issues. | ||
|
|
||
| ## How to build | ||
| ```shell | ||
| cd $CHAOSMESH_DIR | ||
| make chaosctl | ||
| ./bin/chaosctl --help #to see if build succeed. | ||
| ``` | ||
| Chaoctl support shell autocompletion, which could save you some typing. Do `./bin/chaosctl completion -h` for detail. | ||
|
|
||
| ## How to use | ||
| **Debug** | ||
| `chaoctl debug` is used to print debug info of certain chaos. Currently, chaosctl support networkchaos, stresschaos and iochaos. | ||
| ```shell | ||
| #to print info of each networkchaos | ||
| ./bin/chaosctl debug networkchaos | ||
| #to print info of certain chaos in default namespace | ||
| ./bin/chaosctl debug networkchaos CHAOSNAME | ||
| #to print info of each networkchaos in certain namespace | ||
| ./bin/chaosctl debug networkchaos -n NAMESPACE | ||
| ``` | ||
|
|
||
| **Logs** | ||
| `chaoctl log` is used to easily print log from all chaos-mesh components, including controller-manager, chaos-daemon and chaos-dashboard. | ||
| ```shell | ||
| # Default print all log of all chaosmesh components | ||
| chaosctl logs | ||
|
|
||
| # to print 100 log lines for chaosmesh components in node NODENAME | ||
| chaosctl logs -t 100 -n NODENAME | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| // Copyright 2020 Chaos Mesh Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package cmd | ||
|
|
||
| import ( | ||
| "os" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| // completionCmd represents the completion command | ||
| var completionCmd = &cobra.Command{ | ||
| Use: "completion [bash|zsh|fish|powershell]", | ||
| Short: "Generate completion script", | ||
| Long: `To load completions: | ||
| Bash: | ||
| $ source <(chaosctl completion bash) | ||
| # To load completions for each session, execute once: | ||
| Linux: | ||
| $ ./bin/chaosctl completion bash > /etc/bash_completion.d/chaosctl | ||
| MacOS: | ||
| $ ./bin/chaosctl completion bash > /usr/local/etc/bash_completion.d/chaosctl | ||
| Zsh: | ||
| $ compdef _chaosctl ./bin/chaosctl | ||
| # If shell completion is not already enabled in your environment you will need | ||
| # to enable it. You can execute the following once: | ||
| $ echo "autoload -U compinit; compinit" >> ~/.zshrc | ||
| # To load completions for each session, execute once: | ||
| $ ./bin/chaosctl completion zsh > "${fpath[1]}/_chaosctl" | ||
| # You will need to start a new shell for this setup to take effect. | ||
| Fish: | ||
| $ ./bin/chaosctl completion fish | source | ||
| # To load completions for each session, execute once: | ||
| $ ./bin/chaosctl completion fish > ~/.config/fish/completions/chaosctl.fish | ||
| Powershell: | ||
| PS> ./bin/chaosctl completion powershell | Out-String | Invoke-Expression | ||
| # To load completions for every new session, run: | ||
| PS> ./bin/chaosctl completion powershell > chaosctl.ps1 | ||
| # and source this file from your powershell profile. | ||
| `, | ||
| DisableFlagsInUseLine: true, | ||
| ValidArgs: []string{"bash", "zsh", "fish", "powershell"}, | ||
| Args: cobra.ExactValidArgs(1), | ||
| Run: func(cmd *cobra.Command, args []string) { | ||
| switch args[0] { | ||
| case "bash": | ||
| cmd.Root().GenBashCompletion(os.Stdout) | ||
| case "zsh": | ||
| cmd.Root().GenZshCompletion(os.Stdout) | ||
| case "fish": | ||
| cmd.Root().GenFishCompletion(os.Stdout, true) | ||
| // TODO: powershell completion is still not fully supported, see https://github.com/spf13/cobra/pull/1208 | ||
| // Need to update cobra version when this PR is merged | ||
| case "powershell": | ||
| cmd.Root().GenPowerShellCompletion(os.Stdout) | ||
| } | ||
| }, | ||
| } | ||
|
|
||
| func init() { | ||
| rootCmd.AddCommand(completionCmd) | ||
| } |
Oops, something went wrong.