From: noahfalk <noahfalk@microsoft.com>
Date: Thu, 10 Jan 2019 09:59:42 +0000 (-0800)
Subject: starting dotnet diag tools design
X-Git-Tag: submit/tizen/20190813.035844~61^2
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=4bb9e3ec606e9f27c30ab1a1268c09c1ef05f3de;p=platform%2Fcore%2Fdotnet%2Fdiagnostics.git

starting dotnet diag tools design

grabbed a few comments from existing threads and stuck them
in a doc in the repo so we can iterate on it.
---

diff --git a/documentation/design-docs/dotnet-tools.md b/documentation/design-docs/dotnet-tools.md
new file mode 100644
index 000000000..839557f3e
--- /dev/null
+++ b/documentation/design-docs/dotnet-tools.md
@@ -0,0 +1,119 @@
+Capturing some comments from https://github.com/dotnet/diagnostics/issues/85 as a starting point
+we can edit from.
+
+@davidfowl wrote:
+
+@shirhatti We're thinking it should be part of dotnet-collect since all of the flags and infrastructure would likely be the same and it should have a "top" like interface. 
+
+![image](https://user-images.githubusercontent.com/95136/49297973-09575400-f471-11e8-99ec-823e616eafa2.png)
+
+We'll need to decide what things we show (aggregations and counters)
+
+
+
+
+@shirhatti wrote:
+
+```
+NAME
+
+    dotnet-collect - Collect diagnostic information from a .NET process
+
+SYNOPSIS
+
+    dotnet collect [-v, --version] [-h, --help]
+                   [-p, --process-id]
+                   [-o, --output]
+                   <command> [<args>]
+
+OPTIONS
+
+    -v, --version
+        Prints the version of the dotnet collect utility.
+
+    -h, --help
+        Prints the synopsis and a list of the most commonly used commands. 
+
+    -p, --process-id <PROCESS_ID>
+        The process id of the process you want to collect diagnostic information
+        from.
+    
+    -o, --output <OUTPUT_DIRECTORY>
+        The output directory where this diagnostic data should be written to.
+
+
+================================================================================
+
+NAME
+
+    dotnet-collect-dump - Collect a process dump 
+
+SYNOPSIS
+
+    dotnet collect dump [-h, --help]
+                        
+DESCRIPTION
+
+    On Windows, dotnet-collect-dump collects a Windows minidump.
+    On Linux, dotnet-collect-dump collects a core dump using createdump.
+
+OPTIONS
+
+    -h, --help
+        Prints the synopsis and a list of the most commonly used commands. 
+
+================================================================================
+
+NAME
+
+    dotnet-collect-trace - Collect a trace
+
+SYNOPSIS
+
+    dotnet collect dump [-h, --help]
+                        [--provider]
+                        [--buffer]
+                        
+
+OPTIONS
+
+    -h, --help
+        Prints the synopsis and a list of the most commonly used commands.
+
+    --provider <PROVIDER_SPEC>
+        An EventPipe provider to enable.
+        A string in the form '<provider name>:<keywords>:<level>'. 
+    
+    --buffer <BUFFER_SIZE_IN_MB>
+        The size of the in-memory circular buffer in megabytes.
+
+================================================================================
+
+NAME
+
+    dotnet-monitor
+
+SYNOPSIS
+
+    dotnet monitor [-v, --version] [-h, --help]
+                   [--provider]
+                   [--buffer]
+                        
+
+OPTIONS
+
+    -v, --version
+        Prints the version of the dotnet collect utility.
+
+    -h, --help
+        Prints the synopsis and a list of the most commonly used commands.
+
+    --provider <PROVIDER_SPEC>
+        An EventPipe provider to enable.
+        A string in the form '<provider name>:<keywords>:<level>'. 
+    
+    --buffer <BUFFER_SIZE_IN_MB>
+        The size of the in-memory circular buffer in megabytes.
+
+================================================================================
+```
\ No newline at end of file