@@ -9,7 +9,8 @@ PM> Install-Package ExceptionReporter
99
1010## How it Looks
1111
12- If you choose to show a dialog (reports can also be sent silently) there are 2 * modes* - * Less Detail* and * More Detail*
12+ You can show a dialog to the user (reports can also be sent silently). There are
13+ 2 * modes* - * Less Detail* and * More Detail*
1314
1415### ** Less Detail** mode
1516![ Compact Mode] ( images/er2-less-detail.png )
@@ -18,68 +19,75 @@ If you choose to show a dialog (reports can also be sent silently) there are 2 *
1819![ More Detail Mode] ( images/er2-more-detail.png )
1920
2021#### Interface Configuration Options
21- In the next screenshot, we have an example of some customization that can be made with * configuration* .
22- There are no images on the buttons,
23- the window title is customised and an extra Tab (_ Contact_ ) is visible
22+ We don't want you to have to modify the code yourself to achieve a basic level
23+ of customization, so various changes can be made with * configuration* .
2424
25- You can also hide the email button and various other options - see the property ` Config ` on the main ` ExceptionReporter ` class.
25+ The screenshot below is configured to not show icons on the buttons
26+ (` ShowButtonIcons ` ) and the window title is customised (` TitleText ` )
2627
27- ![ Customized Example] ( images/er-customized.png )
28+ There are various other options available such hiding the email button (` ShowEmailButton ` ), changing
29+ the label text (` UserExplanationLabel ` ), the background color (` BackgroundColor ` )
30+ etc - see the property ` Config ` on the main ` ExceptionReporter ` class.
2831
29- The buttons for * More detail * and * Less Detail * allow the user to switch between these modes.
32+ ![ Customized Example ] ( images/er-customized.png )
3033
3134## How it works
3235
33- The Exception Reporter can be called manually or by setting up a Windows Exception event -
36+ The Exception Reporter can be invoked manually or by setting up a Windows
37+ Exception event -
3438see [ Sample Code Usage] ( https://github.com/PandaWood/Exception-Reporter/wiki/Sample-Usage )
3539
36- The report can be sent silently or the dialog (above) shown, which is then populated with the exception and certain system details.
37- A screenshot can be taken and file attachments added (if using email as the method of sending).
38-
3940The ultimate goal is the developer receiving a formatted exception report - see
4041[ Creating and Sending a Report] ( https://github.com/PandaWood/Exception-Reporter/wiki/Creating-and-Sending-a-Report )
4142
4243
4344## Some Important Features
4445
4546- Gathers inner exceptions and accepts multiple exceptions
46- - Option to send a report silently (and asynchronously) ie without showing a dialog
47- - Send a report to a RESTful API/WebService (v3.0)
48- - Send a report via SMTP (Email)
49- - Send a report via Email Client (SimpleMAPI) - Support for automatically attaching files
50- and compressing attached files into a single zip file) - useful for including log and
51- config files to help with troubleshooting
52- - The report sent to the developer can be in the format:
47+ - Option to send a report silently (and asynchronously) - ie without showing a dialog
48+ - Send a report using various methods:
49+ - RESTful API/WebService
50+ - to Email address via SMTP
51+ - to Email address via installed client (SimpleMAPI)
52+ - Emailing includes support for automatically attaching files and compressing
53+ into a single zip file - useful for including log and config files to help with troubleshooting
54+ - The report sent to the developer can be in various formats (v4):
5355 - Plain Text
5456 - HTML
5557 - Markdown
5658 - Custom - your own Handlebar/Mustache template can be used to create the report
57- - The report includes exception stack traces, time/version and important system
58- information (using WMI) such as CPU,
59- memory, OSLanguage, Windows version etc - as well as a list of all referenced
60- assemblies (with versions) being used by the current executable
59+ - The report includes various information such as:
60+ - Full exception ** stack trace** (including inner exception and multiple exceptions)
61+ - ** System information** (using WMI) such as CPU, AvailableMemory, OSLanguage,
62+ Versions etc.
63+ - A list of ** referenced assemblies** (with versions) being used by the current
64+ executable
65+ - Details of your App such as name/version/date/time etc
6166
6267### Demos & Help
6368- The solution includes a Demo App for testing config and sending reports via
6469Email/WebService
65- - The solution also includes a .NET Core REST/WebService project to demonstrate the requirements of sending reports to a WebService
70+ - The solution also includes a .NET Core REST/WebService project to demonstrate
71+ the requirements of sending reports to a WebService
6672
6773## Sample Report
6874
6975Here is a sample of the preset Plain Text report:
7076
7177``` text
72- ====================
78+ ========================================
79+ Exception Report
7380
7481Application: ExceptionReporter Demo App
7582Version: 4.0
7683Region: English (Australia)
7784Date: 25/08/2018
7885Time: 2:40 PM
79-
8086User Explanation: "I just pressed Connect and this error showed immediately"
87+
88+ Error Message: Unable to establish a connection with the Foo bank account service
8189
82- [Full Stack Trace ]
90+ [Stack Traces ]
8391Top-level Exception
8492Type: System.IO.IOException
8593Message: Unable to establish a connection with the Foo bank account service. The error number is #FFF474678.
@@ -93,9 +101,7 @@ Inner Exception 1
93101Type: System.Exception
94102Message: This is an Inner Exception message - with a message that is not too small but perhaps it should be smaller
95103
96- -----------------------------
97-
98- [Assembly Info]
104+ [Assembly References]
99105mscorlib, Version=2.0.0.0
100106System.Windows.Forms, Version=2.0.0.0
101107System, Version=2.0.0.0
@@ -121,6 +127,8 @@ Operating System
121127--Manufacturer = Gigabyte Technology Co., Ltd.
122128--Model = P35-DS3L
123129--TotalPhysicalMemory = 3756515328
130+
131+ ========================================
124132```
125133
126134## Build
0 commit comments