Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
discostu105 committed Jan 29, 2017
1 parent 6a7f2b0 commit 1c44aef
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 14 deletions.
34 changes: 22 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<a href="doc/img/mainpage.png"><img src="doc/img/mainpage.png" title="main page" width="200"/></a>
<a href="doc/img/managednativestacktrace.png"><img src="doc/img/managednativestacktrace.png" title="native managed" width="200"/></a>
<a href="doc/img/nativeexception.png"><img src="doc/img/nativeexception.png" title="native exception" width="200"/></a>
<a href="doc/img/managedexception.png"><img src="doc/img/managedexception.png" title="managed exception" width="200"/></a>

Technologies
============
* [CLRMD] for analysis.
Expand Down Expand Up @@ -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
Expand Down
Binary file added doc/img/mainpage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/img/managedexception.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/img/managednativestacktrace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/img/nativeexception.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion src/SuperDumpService/Views/Home/About.cshtml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@
ViewData["Title"] = "About";
}
<h1>About SuperDump</h1>
<p>TBD</p>
<p>SuperDump is a service for <i>automated Windows crash-dump analysis</i>.</p>

<p>More about it on <a href="https://github.com/Dynatrace/superdump">github.com/Dynatrace/superdump</a></p>
2 changes: 1 addition & 1 deletion src/SuperDumpService/Views/Shared/_Layout.cshtml
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
@RenderBody()
<hr />
<footer>
<p>&copy; 2016 - SuperDump</p>
<p><a href="https://github.com/Dynatrace/superdump">github.com/Dynatrace/superdump</a></p>
</footer>
</nav>

Expand Down

0 comments on commit 1c44aef

Please sign in to comment.