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.

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

Helper command to collect debugging info #547

Closed
edvald opened this issue Feb 19, 2019 · 1 comment
Closed

Helper command to collect debugging info #547

edvald opened this issue Feb 19, 2019 · 1 comment
Assignees

Comments

@edvald
Copy link
Collaborator

edvald commented Feb 19, 2019

It would be very useful to have a command that collects and archives information that would generally be useful for us when debugging user problems.

I suggest we make a garden get debug-info command (other suggestions for names welcome), that does the following:

  1. Collect every garden.yml in the project, and store in a corresponding directory structure in a temporary folder. This should notably work even if the project doesn’t successfully validate.
  2. For every found garden.yml, see if there is an error.log file next to it, if so copy it next to the garden.yml in the temporary directory.
  3. For each provider that specifies it, call the getDebugInfo handler (which we need to add) The handler output schema should have an info key, which allows any object, which is then stored in the temp dir under <provider-name>/info.json. Later we may wish to add more specific keys, or a way to output individual files, but that can wait.
  4. Collect some basic system info, as well as the Garden version into a JSON or YAML file and store at the top of the temp directory.
  5. Zip the temp directory into a garden-debug-<timestamp>.zip file and delete the temp directory.

For step 3, we should at a minimum make a handler for the Kubernetes plugin, that does the following:

  1. Calls kubectl get all —all-namespaces —output yaml and stores it under clusterResources.
  2. Calls kubectl version --output yaml and stores it under version
  3. Possibly other useful info to add?

We should then make sure to update our bug report issue template, once the command is released.

@eysi09 eysi09 self-assigned this Feb 20, 2019
@eysi09 eysi09 assigned 10ko and unassigned eysi09 May 7, 2019
@edvald
Copy link
Collaborator Author

edvald commented Jun 13, 2019

Done in #778

@edvald edvald closed this as completed Jun 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants