diff --git a/README.md b/README.md index f8454f7..43f0b9a 100644 --- a/README.md +++ b/README.md @@ -7,25 +7,30 @@ SuperDumps was made with these goals in mind: * Make crash-dump analysis easy for people who are unexperienced with it, or don't have the necessary tools installed. * Speed up first assessment of a crash-dump, by automatically preparing crash-dump analysis up-front. A developer should be quicker in determining if it's an already known crash. - What SuperDump is not: +What SuperDump is not: * A replacement for in-depth analysis tools such as WinDbg. Features ======== - * Dump analysis can be triggered via web-frontend (HTTP-upload) or via REST-API. - * Any windows-crash-dump (Fulldump or Minidump) can be analyzed (`*.dmp` files). - * .zip files, containing multiple crash-dumps are also supported. - * Report results are stored as `.json` files and can be queried via REST-API. But they can also be viewed in SuperDump directly. - * SuperDump report shows - * Basic information (bitness, system/process uptime, lastevent, ...) - * Loaded modules and versions - * Stacktraces of all threads (native and .NET frames) - * AppDomains - * Basic memory analyis (number of bytes used by .NET types) + * Dump analysis can be triggered via web-frontend (HTTP-upload) or via REST-API. + * Any windows-crash-dump (Fulldump or Minidump) can be analyzed (`*.dmp` files). + * .zip files, containing multiple crash-dumps are also supported. + * Report results are stored as `.json` files and can be queried via REST-API. But they can also be viewed in SuperDump directly. + * SuperDump report shows: + * Basic information (bitness, system/process uptime, lastevent, ...) + * Loaded modules and versions + * Stacktraces of all threads (native and .NET frames) + * AppDomains + * Basic memory analyis (number of bytes used by .NET types) * SuperDump detects exceptions (native and managed) and marks the responsible threads. * Deadlock detection. * SuperDump also invokes a number of `WinDbg` commands and logs them to a separate log-file. + + + + + Technologies ============ * [CLRMD] for analysis. @@ -58,11 +63,16 @@ Though it currently works great for us at Dynatrace, there are areas that need t * There is currently no data retention stuff implemented. Every crash-dump is stored forever. Cleanup needs to be done manually. * There is no authentication/authorization implemented. Every crash-dump is visible to everyone and can be downloaded by everyone. This is an important fact, because crash-dump contents can highly security critical. +Future +====== +We've open sourced SuperDump, because we believe it can be helpful for others. Anyone is welcome to help improve SuperDump. In small ways, or in ways we have not thought about yet. PR's are welcome as well as github tickets. + Credit ====== -Most of the initial code base was written by [Andreas Lobmaier] in his summer internship of 2016. It's been maintained and further developed since then by folks at [Dynatrace]. +Most of the initial code base was written by [Andreas Lobmaier] in his summer internship of 2016. It's been maintained and further developed since then by [Christoph Neumüller] and other folks at [Dynatrace]. [Andreas Lobmaier]: https://github.com/alobmaier +[Christoph Neumüller]: https://github.com/discostu105 [Dynatrace]: https://www.dynatrace.com License diff --git a/doc/img/mainpage.png b/doc/img/mainpage.png new file mode 100644 index 0000000..144e646 Binary files /dev/null and b/doc/img/mainpage.png differ diff --git a/doc/img/managedexception.png b/doc/img/managedexception.png new file mode 100644 index 0000000..6508a71 Binary files /dev/null and b/doc/img/managedexception.png differ diff --git a/doc/img/managednativestacktrace.png b/doc/img/managednativestacktrace.png new file mode 100644 index 0000000..e5c0827 Binary files /dev/null and b/doc/img/managednativestacktrace.png differ diff --git a/doc/img/nativeexception.png b/doc/img/nativeexception.png new file mode 100644 index 0000000..0809805 Binary files /dev/null and b/doc/img/nativeexception.png differ diff --git a/src/SuperDumpService/Views/Home/About.cshtml b/src/SuperDumpService/Views/Home/About.cshtml index d402d8d..a4d514a 100644 --- a/src/SuperDumpService/Views/Home/About.cshtml +++ b/src/SuperDumpService/Views/Home/About.cshtml @@ -2,4 +2,6 @@ ViewData["Title"] = "About"; }

About SuperDump

-

TBD

\ No newline at end of file +

SuperDump is a service for automated Windows crash-dump analysis.

+ +

More about it on github.com/Dynatrace/superdump

\ No newline at end of file diff --git a/src/SuperDumpService/Views/Shared/_Layout.cshtml b/src/SuperDumpService/Views/Shared/_Layout.cshtml index 9743ca4..a4543cb 100644 --- a/src/SuperDumpService/Views/Shared/_Layout.cshtml +++ b/src/SuperDumpService/Views/Shared/_Layout.cshtml @@ -76,7 +76,7 @@ @RenderBody()