tools/Extractor/README.md

   1 # Line Number Extractor tool
   2
   3 ### Usage
   4
   5 ```
   6 dotnet-extractor [Commands]
   7 ```
   8
   9 ```
  10 dotnet-extractor convert [Options]
  11 ```
  12
  13 #### Commands
  14 * convert
  15    Get the line number from the token value in the stacktrace
  16
  17 #### Interactive shell
  18 * Input string
  19    Input the exception log string directly
  20
  21 #### Options
  22 * -h, --help
  23     Show this help message
  24
  25 * -i, --input  [Input path]
  26    Path to the exception log file (File extension: xxxxx.log)
  27
  28 * -a, --assembly  [Path1:Path2:...]
  29     Multiple paths with assembly directories separated by colon(':')
  30
  31 * -p, --pdb  [Pdb path]
  32     Path to the pdb directory (Can be omitted if it is the same as the assembly directory path)
  33
  34 * -o, --output  [Output path]
  35     Path to the output file (Default: Output to console. If omitted, the xxxxx.out file is created in the same location as the log file)
  36
  37 #### Example
  38 * If you enter the exception log string directly
  39 ```
  40  # dotnet extractor convert
  41  ### Dotnet Extractor Tool (v1.0) ###
  42  Enter the exception log string:
  43   I/DOTNET_LAUNCHER(12345):    at TestApp.Program.TestMethod1() in TestApp.Tizen.dll: token 0x6000001+0x5
  44   I/DOTNET_LAUNCHER(12345):    at TestApp.Program.OnCreate() in TestApp.Tizen.dll: token 0x6000002+0x1
  45 ```
  46
  47 * If both assembly and pdb are in the current directory
  48 ```
  49  # dotnet extractor convert --input /tmp/Exception1.log
  50 ```
  51
  52 * If both assembly and pdb are in the same directory specified
  53 ```
  54  # dotnet extractor convert --input /tmp/Exception2.log --assembly /opt/usr/globalapps/org.tizen.example.TestApp.Tizen/:/usr/share/dotnet.tizen/
  55 ```
  56
  57 * If assembly and pdb are separated in each directory
  58 ```
  59  # dotnet extractor convert --input /tmp/Exception3.log --assembly /usr/share/dotnet.tizen/framework/ --pdb /tmp/pdbs/
  60 ```
  61
  62 #### Others
  63 * Log format
  64 ```
  65  I/DOTNET_LAUNCHER(12345): System.NullReferenceException: Object reference not set to an instance of an object.
  66  I/DOTNET_LAUNCHER(12345):    at TestApp.Program.TestMethod1() in TestApp.Tizen.dll: token 0x6000001+0x5
  67  I/DOTNET_LAUNCHER(12345):    at TestApp.Program.OnCreate() in TestApp.Tizen.dll: token 0x6000002+0x1
  68   ------- Format -------
  69  I/DOTNET_LAUNCHER(00000):    at {typeName}.{methodName}({parameters}) in {moduleName}: token {methodToken}+{ilOffset}
  70 ```
  71
  72 ----
  73
  74 #### Sample
  75 ```
  76 sh-3.2# cat /tmp/Exception.log
  77 I/DOTNET_LAUNCHER(12345): System.NullReferenceException: Object reference not set to an instance of an object.
  78 I/DOTNET_LAUNCHER(12345):    at TestApp.Program.TestMethod1() in TestApp.Tizen.dll: token 0x6000001+0x5
  79 I/DOTNET_LAUNCHER(12345):    at TestApp.Program.TestMethod2() in TestApp.Tizen.dll: token 0x6000002+0x1
  80 I/DOTNET_LAUNCHER(12345):    at TestApp.Program.OnCreate() in TestApp.Tizen.dll: token 0x6000004+0x15
  81 sh-3.2#
  82 sh-3.2# dotnet extractor convert --input /tmp/Exception.log --assembly /opt/usr/globalapps/org.tizen.example.TestApp.Tizen/
  83
  84 ##### Line Number Extractor Tool (v1.0) #####
  85
  86 Extraction result:
  87  at TestApp.Program.TestMethod1() in U:\TestApp\TestApp\TestApp.Tizen\TestApp.Tizen.cs:line 14
  88  at TestApp.Program.TestMethod2() in U:\TestApp\TestApp\TestApp.Tizen\TestApp.Tizen.cs:line 19
  89  at TestApp.Program.OnCreate() in U:\TestApp\TestApp\TestApp.Tizen\TestApp.Tizen.cs:line 58
  90
  91 Output: /tmp/Exception.out
  92
  93 sh-3.2#
  94 ```