diff --git a/docs/source/troubleshooting/ask_for_support.rst b/docs/source/troubleshooting/ask_for_support.rst index e814fa130..4fe5c1833 100644 --- a/docs/source/troubleshooting/ask_for_support.rst +++ b/docs/source/troubleshooting/ask_for_support.rst @@ -21,8 +21,6 @@ Please have the following list ready so we can help you faster: 6. Any relevant logs you have collected. We recommend using `Pastebin `_ or `github gists `_. Makes it much easier to read logfiles. -You can also use the ``st2-submit-debug-info`` tool (See :ref:`submit_debug_info_to_st2`). - If you are sure there is a st2 bug after your research, file an `issue `_ against the |st2| repo. diff --git a/docs/source/troubleshooting/index.rst b/docs/source/troubleshooting/index.rst index ed465ab1a..5e9cc2389 100644 --- a/docs/source/troubleshooting/index.rst +++ b/docs/source/troubleshooting/index.rst @@ -17,7 +17,6 @@ and how to debug and troubleshoot them. tuning_action_runner_dispatcher_pool purging_old_data private_networks - submit_debug_info debug_mode ask_for_support webhooks diff --git a/docs/source/troubleshooting/submit_debug_info.rst b/docs/source/troubleshooting/submit_debug_info.rst deleted file mode 100644 index 5e350962b..000000000 --- a/docs/source/troubleshooting/submit_debug_info.rst +++ /dev/null @@ -1,168 +0,0 @@ -.. _submit_debug_info_to_st2: - -Submitting Debugging Information -================================ - -The first step to help debug and troubleshoot an issue for you is for us to try to -reproduce the problem by making sure our setup resemble yours as closely as possible. - -To save time and make it convenient, |st2| includes a utility -which allows you to easily and securely send us the information we need to -help us debug or troubleshoot your issue. - -By default, this utility sends us the following information: - -* All the |st2| services log files from ``/var/log/st2`` -* |st2| config file (``/etc/st2/st2.conf``). Prior to sending the config files we strip sensitive information such as database and queue access information. -* |st2| content (integration packs) minus the pack configs. - -All this information is bundled up in a tarball and encrypted using our -public key via public-key cryptography. Once submitted, this bundled information -is only accessible to Extreme Networks employees and it is used solely for -debugging purposes. - -To send debug information to Extreme Networks, run this CLI command: - -.. sourcecode:: bash - - st2-submit-debug-info - - This will submit the following information to Extreme Networks: logs, configs, content, system_info - Are you sure you want to proceed? [y/n] y - 2015-02-10 16:43:54,733 INFO - Collecting files... - 2015-02-10 16:43:55,714 INFO - Creating tarball... - 2015-02-10 16:43:55,892 INFO - Encrypting tarball... - 2015-02-10 16:44:02,591 INFO - Debug tarball successfully uploaded to Extreme Networks - -By default, the command will run in an interactive mode. If you want to run it in a -non-interactive mode and assuming "yes" as the answer to all the questions, you -can use the ``--yes`` flag. For example: - -.. sourcecode:: bash - - st2-submit-debug-info --yes - - 2015-02-10 16:45:36,074 INFO - Collecting files... - 2015-02-10 16:45:36,988 INFO - Creating tarball... - 2015-02-10 16:45:37,193 INFO - Encrypting tarball... - 2015-02-10 16:45:43,926 INFO - Debug tarball successfully uploaded to StackStorm - -If you want to only send specific information, or exclude particular information -you can use the ``--exclude-`` flag. For example, to only send us the log files: - -.. sourcecode:: bash - - st2-submit-debug-info --exclude-configs --exclude-content --exclude-system-info - -Reviewing the Debug Information -------------------------------- - -If you want to review and/or manipulate the information (e.g. remove log lines -which you might find sensitive), you can do that using the ``--review`` flag. - -When this flag is used, the archive will not be encrypted and uploaded: - -.. sourcecode:: bash - - st2-submit-debug-info --review - - 2015-02-10 17:43:49,016 INFO - Collecting files... - 2015-02-10 17:43:49,770 INFO - Creating tarball... - 2015-02-10 17:43:49,912 INFO - Debug tarball successfully generated and can be reviewed at: /tmp/st2-debug-output-vagrant-ubuntu-trusty-64-2015-02-10-174349.tar.gz - -By default, the archive will be written to the ``/tmp`` directory. This can be controlled by using -the ``--output`` option to specify the location/filename of the archive: - -.. sourcecode:: bash - - st2-submit-debug-info --review --output my-st2-debug-file.tar.gz - - 2016-02-24 23:53:25,779 INFO - Collecting files... - 2016-02-24 23:53:26,423 INFO - Creating tarball... - 2016-02-24 23:53:26,526 INFO - Debug tarball successfully generated and can be reviewed at: my-st2-debug-file.tar.gz - -After review, the archive can be uploaded using the ``--existing-file`` option: - -.. sourcecode:: bash - - st2-submit-debug-info --config /etc/st2debug/submit-debug-info.yaml --existing-file my-st2-debug-file.tar.gz - - 2016-02-24 23:56:13,019 INFO - Encrypting tarball... - 2016-02-24 23:56:13,814 INFO - Debug tarball successfully uploaded to Extreme Networks (name=my-st2-debug-file.tar.gz.asc) - 2016-02-24 23:56:13,814 INFO - When communicating with support, please let them know the tarball name - my-st2-debug-file.tar.gz.asc - - -Customizing the Debug Information Gathered ------------------------------------------- - -``st2-submit-debug-info`` can be customized for specific deployments by loading a set of overrides -from a YAML file. The following config options are supported: - -* ``log_file_paths`` - an additional set of log files to gather -* ``st2_config_file_path`` - path to st2.conf -* ``s3_bucket_url`` - the S3 bucket to upload the archive to -* ``gpg_key_fingerprint`` - gpg fingerprint to use when encrypting the archive -* ``gpg_key`` - gpg key to use when encrypting the archive -* ``shell_commands`` - a list of shell commands to execute and capture the output from -* ``company_name`` - the company name to show in the interactive prompts and log messages - -Sample config yaml file: - -.. literalinclude:: __debug_info_config.yaml - :language: yaml - -To send debug information, simply invoke the CLI command shown below passing it the path to -the YAML config file: - -.. sourcecode:: bash - - st2-submit-debug-info --config - - This will submit the following information to Extreme Networks: logs, configs, content, system_info, shell_commands - Are you sure you want to proceed? [y/n] y - 2016-01-19 06:12:18,587 INFO - Collecting files... - 2016-01-19 06:12:19,602 INFO - Creating tarball... - 2016-01-19 06:12:19,708 INFO - Encrypting tarball... - 2016-01-19 06:12:43,949 INFO - Debug tarball successfully uploaded to Extreme Networks (name=st2-debug-output-70386ae8e4fe-2016-01-19-06:12:18.tar.gz.asc) - 2016-01-19 06:12:43,949 INFO - When communicating with support, please let them know the tarball name - st2-debug-output-70386ae8e4fe-2016-01-19-06:12:18.tar.gz.asc - -We can pass through any command line arguments provided to ``st2-submit-debug-info``. - -For example: - -* To run it in a non-interactive mode use the '--yes' option: - - .. sourcecode:: bash - - st2-submit-debug-info --yes --config - - 2016-01-19 06:25:09,024 INFO - Collecting files... - 2016-01-19 06:25:09,617 INFO - Creating tarball... - 2016-01-19 06:25:09,725 INFO - Encrypting tarball... - 2016-01-19 06:25:13,727 INFO - Debug tarball successfully uploaded to Extreme Networks (name=st2-debug-output-70386ae8e4fe-2016-01-19-06:25:09.tar.gz.asc) - 2016-01-19 06:25:13,727 INFO - When communicating with support, please let them know the tarball name - st2-debug-output-70386ae8e4fe-2016-01-19-06:25:09.tar.gz.asc - -* To send specific information or to exclude particular information, use the - ``--exclude-`` flag: - - .. sourcecode:: bash - - st2-submit-debug-info --exclude-shell-commands --config - - This will submit the following information to Extreme Networks: logs, configs, content, system_info - Are you sure you want to proceed? [y/n] y - 2016-01-19 06:28:25,533 INFO - Collecting files... - 2016-01-19 06:28:25,895 INFO - Creating tarball... - 2016-01-19 06:28:26,002 INFO - Encrypting tarball... - 2016-01-19 06:28:29,559 INFO - Debug tarball successfully uploaded to Extreme Networks (name=st2-debug-output-70386ae8e4fe-2016-01-19-06:28:25.tar.gz.asc) - 2016-01-19 06:28:29,559 INFO - When communicating with support, please let them know the tarball name - st2-debug-output-70386ae8e4fe-2016-01-19-06:28:25.tar.gz.asc - -* To review the debugging information without encrypting and uploading: - - .. sourcecode:: bash - - st2-submit-debug-info --review --config - - 2016-01-19 06:19:04,911 INFO - Collecting files... - 2016-01-19 06:19:05,531 INFO - Creating tarball... - 2016-01-19 06:19:05,637 INFO - Debug tarball successfully generated and can be reviewed at: /tmp/st2-debug-output-70386ae8e4fe-2016-01-19-06:19:04.tar.gz