Skip to content
🤔 Documentation issue? Report it


shark / shark

Package shark


Name Summary
ApplicationLeak data class ApplicationLeak :Leak
A leak found by HeapAnalyzer in your application.
AppSingletonInspector class AppSingletonInspector :ObjectInspector
Inspector that automatically marks instances of the provided class names as not leaking because they’re app wide singletons.
FilteringLeakingObjectFinder class FilteringLeakingObjectFinder :LeakingObjectFinder
Finds the objects that are leaking by scanning all objects in the heap dump and delegating the decision to a list of FilteringLeakingObjectFinder.LeakingObjectFilter
HeapAnalysis sealed class HeapAnalysis :Serializable
The result of an analysis performed by HeapAnalyzer, either a HeapAnalysisSuccess or a HeapAnalysisFailure. This class is serializable however there are no guarantees of forward compatibility.
HeapAnalysisFailure data class HeapAnalysisFailure :HeapAnalysis
The analysis performed by HeapAnalyzer did not complete successfully.
HeapAnalysisSuccess data class HeapAnalysisSuccess :HeapAnalysis
The result of a successful heap analysis performed by HeapAnalyzer.
HeapAnalyzer class HeapAnalyzer
Analyzes heap dumps to look for leaks.
IgnoredReferenceMatcher class IgnoredReferenceMatcher :ReferenceMatcher
IgnoredReferenceMatcher should be used to match references that cannot ever create leaks. The shortest path finder will never go through matching references.
KeyedWeakReferenceFinder object KeyedWeakReferenceFinder :LeakingObjectFinder
Finds all objects tracked by a KeyedWeakReference, ie all objects that were passed to
Leak sealed class Leak :Serializable
A leak found by HeapAnalyzer, either an ApplicationLeak or a LibraryLeak.
LeakingObjectFinder interface LeakingObjectFinder
LeakTrace data class LeakTrace :Serializable
The best strong reference path from a GC root to the leaking object. “Best” here means the shortest prioritized path. A large number of distinct paths can generally be found leading to a leaking object. Shark prioritizes paths that don’t go through known LibraryLeakReferenceMatcher (because those are known to create leaks so it’s more interesting to find other paths causing leaks), then it prioritize paths that don’t go through java local gc roots (because those are harder to reason about). Taking those priorities into account, finding the shortest path means there are less LeakTraceReference that can be suspected to cause the leak.
LeakTraceObject data class LeakTraceObject :Serializable
LeakTraceReference data class LeakTraceReference :Serializable
A LeakTraceReference represents and origin LeakTraceObject and either a reference from that object to the LeakTraceObject in the next LeakTraceReference in LeakTrace.referencePath, or to LeakTrace.leakingObject if this is the last LeakTraceReference in LeakTrace.referencePath.
LibraryLeak data class LibraryLeak :Leak
A leak found by HeapAnalyzer, where the only path to the leaking object required going through a reference matched by pattern, as provided to a LibraryLeakReferenceMatcher instance. This is a known leak in library code that is beyond your control.
LibraryLeakReferenceMatcher data class LibraryLeakReferenceMatcher :ReferenceMatcher
LibraryLeakReferenceMatcher should be used to match references in library code that are known to create leaks and are beyond your control. The shortest path finder will only go through matching references after it has exhausted references that don’t match, prioritizing finding an application leak over a known library leak. Library leaks will be reported as LibraryLeak instead of ApplicationLeak.
MetadataExtractor interface MetadataExtractor
ObjectInspector interface ObjectInspector
ObjectInspectors enum class ObjectInspectors :ObjectInspector
A set of default ObjectInspectors that knows about common JDK objects.
ObjectReporter class ObjectReporter
Enables ObjectInspector implementations to provide insights on heapObject, which is an object (class, instance or array) found in the heap.
OnAnalysisProgressListener interface OnAnalysisProgressListener
ReferenceMatcher sealed class ReferenceMatcher
Used to pattern match known patterns of references in the heap, either to ignore them (IgnoredReferenceMatcher) or to mark them as library leaks (LibraryLeakReferenceMatcher).
ReferencePattern sealed class ReferencePattern :Serializable
A pattern that will match references for a given ReferenceMatcher.


Name Summary
HeapAnalysisException class HeapAnalysisException :RuntimeException


Name Summary
<no name provided> fun <no name provided>():Unit
Finds the objects that are leaking, for which Shark will compute leak traces.