https://github.com/jetbrains/hotspotcrashexaminerplugin
HotSpot Crash Examiner IntelliJ Plugin
https://github.com/jetbrains/hotspotcrashexaminerplugin
hotspot-jvm intellij intellij-plugin jb-official kotlin
Last synced: 8 months ago
JSON representation
HotSpot Crash Examiner IntelliJ Plugin
- Host: GitHub
- URL: https://github.com/jetbrains/hotspotcrashexaminerplugin
- Owner: JetBrains
- License: apache-2.0
- Created: 2024-06-19T12:09:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-03T02:34:24.000Z (10 months ago)
- Last Synced: 2025-01-30T02:01:37.269Z (8 months ago)
- Topics: hotspot-jvm, intellij, intellij-plugin, jb-official, kotlin
- Language: Kotlin
- Homepage: https://plugins.jetbrains.com/plugin/24675-hotspot-crash-examiner
- Size: 6.07 MB
- Stars: 13
- Watchers: 6
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
HotSpot Crash Examiner
===
[![Official JetBrains Project][jb-official-svg]][jb-official]
[![Contributions welcome][contributions-welcome-svg]][contributions-welcome]
[](https://plugins.jetbrains.com/plugin/24675-hotspot-crash-examiner)
[](https://plugins.jetbrains.com/plugin/24675-hotspot-crash-examiner)
* [HotSpot Crash Examiner](#hotspot-crash-examiner)
* [Overview](#overview)
* [Toolwindow](#toolwindow)
* [Address Hints](#address-hints)
* [Find Address](#find-address)
* [Hints](#hints)
* [Go To Declaration](#go-to-declaration)
* [Configuration Options](#configuration-options)
* [Installation](#installation)
* [Resources](#resources)
Provides IDE capabilities
to examining [HotSpot JVM fatal error logs](https://docs.oracle.com/javase/10/troubleshoot/fatal-error-log.htm):
* Syntax highlighting
* Structured view
* Folding
* Go to declaration for Java names
* A dedicated tool window
* Documentation hints for addresses, keywords, sizes, etc.
Additional features:
* Configurable auto-folding of sections (`Settings | Other Settings | HotSpot Crash Examiner`).
* The tool window lists important properties from the log, their explanation,
and detailed analysis.
* Highlights the relevant portion of the log when clicking on a tool window element.
* Mark the properties that require attention such as low physical memory on the JVM host.
Limits are configurable in the Settings dialog.
* Go to declaration for Java classes and methods.
* `Find Address` action from the editor's context menu will highlight all occurrences of the currently selected address
and those near it (configurable in the Settings dialog).
If the address belongs to some thread's stack or can be found in the memory map, that will also be highlighted.
* Documentation hints for register names, signals, and other keywords; detailed info about addresses.
Automatically recognizes the files matching these patterns: `hs_err_*.log`, `java_error_in_*.log`, and `crash*.txt`.
To view any file with this plugin, select the file in the project view, choose
`Override File Type` and then `HotSpot Fatal Error Log`
## Overview
### Toolwindow
Configurable warnings in the tool window draw attention to unusual features of the crash:
A human-readable analysis of the crash:
### Address Hints
Hold the mouse pointer over an address to try to resolve it.
Works for thread, stack, Java heap, dynamic libraries, and other addresses:
### Find Address
Pick the `Find Address` option from the context menu
to highlight the address under the cursor and addresses near it everywhere in the log file:
Addresses do not have to match textually or even appear in the log.
For example, address pointing into a memory-mapped region will highlight that
region in the log.
### Hints
Numbers that denote the size are converted into a more human-readable form:
Signals, registers, and common thread names, some JVM terms also have
documentation hints.
### Go To Declaration
Go to declaration for Java symbols and classes;
requires Java support in the IDE and the corresponding project with the classes opened:
### Configuration Options
Various thresholds are configurable in the plugin's Settings dialog:
## Installation
- Using the IDE built-in plugin system:
Settings/Preferences > Plugins > Marketplace > Search for "HotSpot Crash Examiner" >
Install
- Manually:
Download the [latest release](https://github.com/JetBrains/HotSpotCrashExaminerPlugin/releases/latest) and install it manually using
Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...
## Resources
* [Java Platform, Standard Edition Troubleshooting Guide. A Fatal Error Log](https://docs.oracle.com/javase/10/troubleshoot/fatal-error-log.htm)
* [YouTube — Volker Simonis — Analyzing HotSpot Crashes](https://www.youtube.com/watch?v=buPX_nj40Tg&t=3078s)
* [YouTube — JVM Crash Dump Analysis](https://www.youtube.com/watch?v=jd6dJa7tSNU)
[jb-official]: https://github.com/JetBrains#jetbrains-on-github
[jb-official-svg]: https://jb.gg/badges/official.svg
[plugin-repo]: https://github.com/JetBrains/HotSpotCrashExaminerPlugin
[contributions-welcome-svg]: http://img.shields.io/badge/contributions-welcome-brightgreen
[contributions-welcome]: https://github.com/JetBrains/HotSpotCrashExaminerPlugin/blob/master/CONTRIBUTING.md