shark-hprof/shark

Package shark

Types

ByteArraySourceProvider

class ByteArraySourceProvider(byteArray: ByteArray) : DualSourceProvider

ConstantMemoryMetricsDualSourceProvider

class ConstantMemoryMetricsDualSourceProvider(realSourceProvider: DualSourceProvider) : DualSourceProvider

Captures IO read metrics without using much memory.

DualSourceProvider

interface DualSourceProvider : StreamingSourceProvider, RandomAccessSourceProvider

Both a StreamingSourceProvider and a RandomAccessSourceProvider

FileSourceProvider

class FileSourceProvider(file: File) : DualSourceProvider

sealed class GcRoot

A GcRoot as identified by HprofRecord.HeapDumpRecord.GcRootRecord in the heap dump.

HprofDeobfuscator

class HprofDeobfuscator

Converts a Hprof file to another file with deobfuscated class and field names.

data class HprofHeader( val heapDumpTimestamp: Long = System.currentTimeMillis(), val version: HprofVersion = HprofVersion.ANDROID, val identifierByteSize: Int = 4)

Represents the header metadata of a Hprof file.

HprofPrimitiveArrayStripper

class HprofPrimitiveArrayStripper

Converts a Hprof file to another file with all primitive arrays replaced with arrays of zeroes, which can be useful to remove PII. Char arrays are handled slightly differently because 0 would be the null character so instead these become arrays of '?'.

sealed class HprofRecord

A Hprof record. These data structure map 1:1 with how records are written in hprof files.

HprofRecordReader

class HprofRecordReader

Reads hprof content from an Okio BufferedSource.

enum HprofRecordTag : Enum<HprofRecordTag>

enum HprofVersion : Enum<HprofVersion>

Supported hprof versions

class HprofWriter : Closeable

Generates Hprof files.

OnHprofRecordListener

fun interface OnHprofRecordListener

Listener passed in to StreamingHprofReader.readRecords, gets notified for each HprofRecord found in the heap dump which types is in the set of the recordTypes parameter passed to StreamingHprofReader.readRecords.

OnHprofRecordTagListener

fun interface OnHprofRecordTagListener

Listener passed in to StreamingHprofReader.readRecords, gets notified for each HprofRecordTag found in the heap dump.

enum PrimitiveType : Enum<PrimitiveType>

A primitive type in the prof.

ProguardMapping

class ProguardMapping

ProguardMappingReader

class ProguardMappingReader(proguardMappingInputStream: InputStream)

RandomAccessHprofReader

class RandomAccessHprofReader : Closeable

Reads records in a Hprof source, one at a time with a specific position and size. Call openReaderFor to obtain a new instance.

RandomAccessSource

interface RandomAccessSource : Closeable

RandomAccessSourceProvider

fun interface RandomAccessSourceProvider

Can open RandomAccessSource instances.

StreamingHprofReader

class StreamingHprofReader

Reads the entire content of a Hprof source in one fell swoop. Call readerFor to obtain a new instance.

StreamingRecordReaderAdapter

class StreamingRecordReaderAdapter(streamingHprofReader: StreamingHprofReader)

Wraps a StreamingHprofReader to provide a higher level API that streams HprofRecord instances.

StreamingSourceProvider

fun interface StreamingSourceProvider

Can open Source instances.

ThrowingCancelableFileSourceProvider

class ThrowingCancelableFileSourceProvider(file: File, throwIfCanceled: Runnable) : DualSourceProvider

A DualSourceProvider that invokes throwIfCanceled before every read, allowing cancellation of IO based work built on top by throwing an exception.

sealed class ValueHolder

A value in the heap dump, which can be a ReferenceHolder or a primitive type.