From: Jean Flach <jean-marcel.flach@netways.de>
Date: Wed, 25 Feb 2015 14:01:03 +0000 (+0100)
Subject: Add documentation for the troubleshoot command
X-Git-Tag: v2.3.0~124
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=a026d474543a0b61aa2d8a8f730a0f61ccfe5e57;p=icinga2

Add documentation for the troubleshoot command

refs #3446
---

diff --git a/doc/13-troubleshooting.md b/doc/13-troubleshooting.md
index 660aeb1c1..2bae523b6 100644
--- a/doc/13-troubleshooting.md
+++ b/doc/13-troubleshooting.md
@@ -2,11 +2,9 @@
 
 ## <a id="troubleshooting-information-required"></a> Which information is required
 
-* Which distribution and version
-* How was Icinga 2 installed (and which repository in case)
-* Run `icinga2 --version`
+* Run `icinga2 troubleshoot` to receive a file with the most basic information
+* How was Icinga 2 installed (and which repository in case) and which distribution are you using
 * Provide complete configuration snippets explaining your problem in detail
-* Provide complete logs targetting your problem
 * If the check command failed - what's the output of your manual plugin tests?
 * In case of [debugging](18-debug.md#debug) Icinga 2, the full back traces and outputs
 
diff --git a/doc/8-cli-commands.md b/doc/8-cli-commands.md
index cc7389b52..51e8b33c9 100644
--- a/doc/8-cli-commands.md
+++ b/doc/8-cli-commands.md
@@ -57,6 +57,7 @@ options.
       * repository zone add (adds a new Zone object)
       * repository zone list (lists all Zone objects)
       * repository zone remove (removes a Zone object)
+      * troubleshoot (collect information for troubleshooting)
       * variable get (gets a variable)
       * variable list (lists all variables)
     
@@ -392,6 +393,40 @@ cleared after review.
 
 
 
+## <a id="cli-command-variable"></a> CLI command: Troubleshoot
+
+Collects basic information like version, paths, log files and crash reports for troubleshooting purposes and prints them to a file or the console. See [troubleshooting](13-troubleshooting.md#troubleshooting-information-required).
+
+Its output defaults to a file named `troubleshooting-[TIMESTAMP].log` so it won't overwrite older troubleshooting files.  
+
+> **Note**  
+> Keep in mind that this tool can not collect information from other icinga2 nodes, you will have to run it on
+> each of one of you instances.  
+> This is only a tool to collect information to help others help you, it will not attempt to fix anything.
+
+
+    # icinga2 troubleshoot --help
+    icinga2 - The Icinga 2 network monitoring daemon (version: v2.2.0-551-g1d0f6ed)
+
+    Usage:
+      icinga2 troubleshoot [<arguments>]
+
+    Global options:
+      -h [ --help ]          show this help message
+      -V [ --version ]	     show version information
+      --color                use VT100 color codes even when stdout is not aterminal
+      -D [ --define ] arg    define a constant
+      -l [ --library ] arg   load a library
+      -I [ --include ] arg   add include search directory
+      -x [ --log-level ] arg specify the log level for the console log
+
+    Command options:
+      -c [ --console ]      print to console instead of file
+      -o [ --output ] arg   path to output file
+
+    Report bugs at <https://dev.icinga.org/>
+    Icinga home page: <https://www.icinga.org/>
+
 ## <a id="cli-command-variable"></a> CLI command: Variable
 
 Lists all configured variables (constants) in a similar fasion like [object list](8-cli-commands.md#cli-command-object).