Debug

java.lang.Object
- ohos.hiviewdfx.Debug

```
public final class Debug
extends Object
```
Provides debugging methods for applications, including obtaining statistics about tracing and memory data.
This interface enables the debug mode for applications to obtain information such as the memory use and CPU time.
Example code for starting the trace of a specified service flow by using the default trace flags:
```
 long start = Debug.getCpuTime();
 ......
 int pss = Debug.getProcessPssSum();
 
```
从以下版本开始:

2

SystemCapability

SystemCapability.HiviewDFX.Debug

嵌套类概要

嵌套类
限定符和类型	类	说明
`static class`	`Debug.HeapInfo`	Provides the static native heap memory used by the current process of your application.
`static class`	`Debug.IpcType`	Enumerates IPC object types.
`static class`	`Debug.MemType`	Enumerates memory types.

字段概要

字段
限定符和类型	字段	说明
`static int`	`SHOW_CLASSLOADER`	Indicates the flag for `dumpLoadClasses(int)` with information about `classLoader` included.
`static int`	`SHOW_FULL_DETAIL`	Indicates the flag for `dumpLoadClasses(int)` with details of loaded classes included.
`static int`	`SHOW_INITIALIZED`	Indicates the flag for `dumpLoadClasses(int)` with information about initialization statues included.
`static int`	`TRACE_COUNT_ALLOCS`	Indicates the flag for starting the tracing of method logs.

构造器概要

构造器
构造器说明

Debug()

构造器
构造器	说明
`Debug()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法	说明
`static void`	`attachAgent(String library, String options, ClassLoader classLoader)`	Attaches a library as the Java Virtual Machine Tool Interface (JVMTI) agent to the current runtime based on the given `classLoader`.
`static void`	`connectToDebugger()`	Connects this process to the debugger for entering the debug mode.
`static void`	`dumpHeapFile(String fileName)`	Dumps a heap file into the specified file.
`static void`	`dumpLoadClasses(int flags)`	Dumps a list of classes with a specific flag that are loaded by this process into a log file.
`static void`	`emulatorTraceBegin()`	Starts tracing emulator logs.
`static void`	`emulatorTraceEnable()`	Enables log tracing for the emulator.
`static void`	`emulatorTraceEnd()`	Stops tracing emulator logs.
`static void`	`functionTraceBegin()`	Starts tracing function logs based on the default log file name (dmtrace.trace) and buffer size.
`static void`	`functionTraceBegin(String traceName)`	Starts tracing function logs based on the specified log file name and the default buffer size (8 MB).
`static void`	`functionTraceBegin(String traceName, int bufferSize)`	Starts tracing function logs based on the specified log file name and buffer size.
`static void`	`functionTraceBegin(String traceName, int bufferSize, int flags)`	Starts tracing function logs based on the specified log name, buffer size, and flag.
`static void`	`functionTraceEnd()`	Stops tracing function logs.
`static void`	`functionTraceSamplingBegin(String traceName, int bufferSize, int intervalUs)`	Starts tracing function logs in sampling mode based on the specified log file name, buffer size, and sampling interval.
`static int`	`getCountofLoadClasses()`	Obtains the number of classes loaded by this process.
`static long`	`getCpuTime()`	Obtains the amount of time that the current process has occupied CPU.
`static boolean`	`getDebuggerConnectStatus()`	Obtains whether this process has been connected to the debugger.
`static int`	`getIpcCount(Debug.IpcType ipcType)`	Obtains the number of IPC objects of the specified IPC type for this process.
`static int`	`getIpcReceivedCount()`	Obtains the number of IPC objects received by this process.
`static int`	`getIpcSentCount()`	Obtains the number of IPC objects sent by this process.
`static String`	`getMemoryStatistic(String statisticName)`	Obtains statistics about the memory of a specified name.
`static Map<String,String>`	`getMemoryStatistics()`	Obtains the statistics about all memory used by this process.
`static void`	`getNativeHeapInfo(Debug.HeapInfo heapInfo)`	Obtains statistics about the memory used by processes in the native heap.
`static int`	`getProcessPrivateClean(Debug.MemType memType)`	Obtains the size of private clean pages of the specified memory type for this process.
`static int`	`getProcessPrivateCleanSum()`	Obtains the total size of private clean pages for this process.
`static int`	`getProcessPrivateDirty(Debug.MemType memType)`	Obtains the information about private dirty pages used by this process.
`static int`	`getProcessPrivateDirtySum()`	Obtains the total amount of private dirty pages used by the current process.
`static int`	`getProcessPss(Debug.MemType memType)`	Obtains the proportional set size (PSS) memory used by the current process.
`static int`	`getProcessPssSum()`	Obtains the total amount of proportional set size (PSS) memory in use.
`static int`	`getProcessRss(Debug.MemType memType)`	Obtains the resident set size (RSS) of the specified memory type for this process.
`static int`	`getProcessRssSum()`	Obtains the total RSS for this process.
`static int`	`getProcessSharedClean(Debug.MemType memType)`	Obtains the size of shared clean pages of the specified memory type for this process.
`static int`	`getProcessSharedCleanSum()`	Obtains the total size of shard clean pages for this process.
`static int`	`getProcessSharedDirty(Debug.MemType memType)`	Obtains the size of shared dirty pages of the specified memory type for this process.
`static int`	`getProcessSharedDirtySum()`	Obtains the total size of shared dirty pages for this process.
`static int`	`getProcessSwappablePss(Debug.MemType memType)`	Obtains the swappable proportional set size (PSS) of the specified memory type for this process.
`static int`	`getProcessSwappablePssSum()`	Obtains the total swappable PSS for this process.
`static int`	`getProcessSwappedOut(Debug.MemType memType)`	Obtains the size of swapped-out dirty pages of the specified memory type for this process.
`static int`	`getProcessSwappedOutPss(Debug.MemType memType)`	Obtains the size of swapped-out PSS of the specified memory type for this process.
`static int`	`getProcessSwappedOutPssSum()`	Obtains the total size of swapped-out PSS for this process.
`static int`	`getProcessSwappedOutSum()`	Obtains the total size of swapped-out dirty pages for this process.
`static String`	`getRuntimeStatistic(String statisticName)`	Obtains the statistical information about the runtime of a specified name.
`static Map<String,String>`	`getRuntimeStatistics()`	Obtains the statistical information about all runtime used by this process.
`static boolean`	`isConnectingToDebugger()`	Checks whether multiple processes are waiting to connect to the debugger.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - SHOW_CLASSLOADER
```
public static final int SHOW_CLASSLOADER
```
    Indicates the flag for dumpLoadClasses(int) with information about classLoader included.
    Value: 0010
    When this flag is set, the list of loaded classes you obtained contains only classLoader information.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - SHOW_FULL_DETAIL
```
public static final int SHOW_FULL_DETAIL
```
    Indicates the flag for dumpLoadClasses(int) with details of loaded classes included.
    Value: 0001
    When this flag is set, the list of loaded classes you obtained contains all information about loaded classes: class names, classLoader, and class initialization statuses.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - SHOW_INITIALIZED
```
public static final int SHOW_INITIALIZED
```
    Indicates the flag for dumpLoadClasses(int) with information about initialization statues included.
    Value: 0100
    When this flag is set, the list of loaded classes you obtained contains only initialization statues.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - TRACE_COUNT_ALLOCS
```
public static final int TRACE_COUNT_ALLOCS
```
    Indicates the flag for starting the tracing of method logs.
    Value: 0x0001
    When this flag is set, the memory allocations count is added to the trace file.
    
    从以下版本开始:
    
    3
- 构造器详细资料
  - Debug
```
public Debug()
```
- 方法详细资料
  - getProcessPss
```
public static int getProcessPss(Debug.MemType memType)
```
    Obtains the proportional set size (PSS) memory used by the current process.
    
    参数:
    
    memType - Indicates the memory type, which is enumerated in MemType.
    
    返回:
    
    Returns the amount of used proportional set size (PSS) memory in KB.
    
    从以下版本开始:
    
    2
  - getProcessPrivateDirtySum
```
public static int getProcessPrivateDirtySum()
```
    Obtains the total amount of private dirty pages used by the current process.
    
    返回:
    
    Returns the total amount of private dirty pages in KB.
    
    从以下版本开始:
    
    2
  - getProcessPssSum
```
public static int getProcessPssSum()
```
    Obtains the total amount of proportional set size (PSS) memory in use.
    
    返回:
    
    Returns the total amount of used proportional set size (PSS) memory in KB.
    
    从以下版本开始:
    
    2
  - getNativeHeapInfo
```
public static void getNativeHeapInfo(Debug.HeapInfo heapInfo)
```
    Obtains statistics about the memory used by processes in the native heap.
    
    参数:
    
    heapInfo - Indicates the statistics about the memory in the native heap, including the amount of total, allocated, and free memory.
    
    从以下版本开始:
    
    2
  - getCpuTime
```
public static long getCpuTime()
```
    Obtains the amount of time that the current process has occupied CPU.
    
    返回:
    
    Returns the amount of CPU time in nanoseconds.
    
    从以下版本开始:
    
    2
  - getProcessSwappablePss
```
public static int getProcessSwappablePss(Debug.MemType memType)
```
    Obtains the swappable proportional set size (PSS) of the specified memory type for this process.
    
    参数:
    
    memType - Indicates the memory type, which is enumerated in MemType.
    
    返回:
    
    Returns the swappable PSS in KB.
    
    从以下版本开始:
    
    3
  - getProcessSwappablePssSum
```
public static int getProcessSwappablePssSum()
```
    Obtains the total swappable PSS for this process.
    
    返回:
    
    Returns the total swappable PSS in KB.
    
    从以下版本开始:
    
    3
  - getProcessRss
```
public static int getProcessRss(Debug.MemType memType)
```
    Obtains the resident set size (RSS) of the specified memory type for this process.
    
    参数:
    
    memType - Indicates the memory type, which is enumerated in MemType.
    
    返回:
    
    Returns the RSS in KB.
    
    从以下版本开始:
    
    3
  - getProcessRssSum
```
public static int getProcessRssSum()
```
    Obtains the total RSS for this process.
    
    返回:
    
    Returns the total RSS in KB.
    
    从以下版本开始:
    
    3
  - getProcessPrivateDirty
```
public static int getProcessPrivateDirty(Debug.MemType memType)
```
    Obtains the information about private dirty pages used by this process.
    
    参数:
    
    memType - Indicates the memory type, which is enumerated in MemType.
    
    返回:
    
    Returns the size of private dirty pages in KB.
    
    从以下版本开始:
    
    3
  - getProcessSharedDirty
```
public static int getProcessSharedDirty(Debug.MemType memType)
```
    Obtains the size of shared dirty pages of the specified memory type for this process.
    
    参数:
    
    memType - Indicates the memory type, which is enumerated in MemType.
    
    返回:
    
    Returns the size of shared dirty pages in KB.
    
    从以下版本开始:
    
    3
  - getProcessSharedDirtySum
```
public static int getProcessSharedDirtySum()
```
    Obtains the total size of shared dirty pages for this process.
    
    返回:
    
    Returns the total size of shared dirty pages in KB.
    
    从以下版本开始:
    
    3
  - getProcessPrivateClean
```
public static int getProcessPrivateClean(Debug.MemType memType)
```
    Obtains the size of private clean pages of the specified memory type for this process.
    
    参数:
    
    memType - Indicates the memory type, which is enumerated in MemType.
    
    返回:
    
    Returns the size of private clean pages in KB.
    
    从以下版本开始:
    
    3
  - getProcessPrivateCleanSum
```
public static int getProcessPrivateCleanSum()
```
    Obtains the total size of private clean pages for this process.
    
    返回:
    
    Returns the total size of private clean pages in KB.
    
    从以下版本开始:
    
    3
  - getProcessSharedClean
```
public static int getProcessSharedClean(Debug.MemType memType)
```
    Obtains the size of shared clean pages of the specified memory type for this process.
    
    参数:
    
    memType - Indicates the memory type, which is enumerated in MemType.
    
    返回:
    
    Returns the size of shared clean pages in KB.
    
    从以下版本开始:
    
    3
  - getProcessSharedCleanSum
```
public static int getProcessSharedCleanSum()
```
    Obtains the total size of shard clean pages for this process.
    
    返回:
    
    Returns the total size of shared clean pages in KB.
    
    从以下版本开始:
    
    3
  - getProcessSwappedOut
```
public static int getProcessSwappedOut(Debug.MemType memType)
```
    Obtains the size of swapped-out dirty pages of the specified memory type for this process.
    
    参数:
    
    memType - Indicates the memory type, which is enumerated in MemType.
    
    返回:
    
    Returns the size of swapped-out dirty pages in KB.
    
    从以下版本开始:
    
    3
  - getProcessSwappedOutSum
```
public static int getProcessSwappedOutSum()
```
    Obtains the total size of swapped-out dirty pages for this process.
    
    返回:
    
    Returns the total size of swapped-out dirty pages in KB.
    
    从以下版本开始:
    
    3
  - getProcessSwappedOutPss
```
public static int getProcessSwappedOutPss(Debug.MemType memType)
```
    Obtains the size of swapped-out PSS of the specified memory type for this process.
    
    参数:
    
    memType - Indicates the memory type, which is enumerated in MemType.
    
    返回:
    
    Returns the size of swapped-out PSS in KB.
    
    从以下版本开始:
    
    3
  - getProcessSwappedOutPssSum
```
public static int getProcessSwappedOutPssSum()
```
    Obtains the total size of swapped-out PSS for this process.
    
    返回:
    
    Returns the total size of swapped-out PSS in KB.
    
    从以下版本开始:
    
    3
  - getIpcCount
```
public static int getIpcCount(Debug.IpcType ipcType)
```
    Obtains the number of IPC objects of the specified IPC type for this process.
    
    参数:
    
    ipcType - Indicates the IPC type, as enumerated in IpcType.
    
    返回:
    
    Returns the number of IPC objects of the specified IPC type.
    
    从以下版本开始:
    
    3
  - getIpcSentCount
```
public static int getIpcSentCount()
```
    Obtains the number of IPC objects sent by this process.
    
    返回:
    
    Returns the number of IPC objects sent by this process if the operation succeeds; returns -1 if the operation fails.
    
    从以下版本开始:
    
    3
  - getIpcReceivedCount
```
public static int getIpcReceivedCount()
```
    Obtains the number of IPC objects received by this process.
    
    返回:
    
    Returns the number of IPC objects received by this process if the operation succeeds; returns -1 if the operation fails.
    
    从以下版本开始:
    
    3
  - getMemoryStatistic
```
public static String getMemoryStatistic(String statisticName)
```
    Obtains statistics about the memory of a specified name.
    
    参数:
    
    statisticName - Indicates the name of the memory. The following memory names are supported:
    summary.java-heap
    summary.native-heap
    summary.code
    summary.graphics
    summary.private-other
    summary.system
    summary.total-pss
    summary.total-swap
    
    返回:
    
    Returns the statistics about the memory (in KB) used by this process if available; returns null if no memory is obtained.
    
    从以下版本开始:
    
    3
  - getMemoryStatistics
```
public static Map<String,String> getMemoryStatistics()
```
    Obtains the statistics about all memory used by this process. For details about the memory names, see getMemoryStatistic(java.lang.String).
    
    返回:
    
    Returns the statistics about memory names/values in a map.
    
    从以下版本开始:
    
    3
  - functionTraceBegin
```
public static void functionTraceBegin()
```
    Starts tracing function logs based on the default log file name (dmtrace.trace) and buffer size. The storage path is the default external storage directory.
    
    从以下版本开始:
    
    3
  - functionTraceBegin
```
public static void functionTraceBegin(String traceName)
```
    Starts tracing function logs based on the specified log file name and the default buffer size (8 MB). The storage path is the default external storage directory.
    
    参数:
    
    traceName - Indicates the log file name. If this parameter is null, the default file name dmtrace.trace will be used.
    
    从以下版本开始:
    
    3
  - functionTraceBegin
```
public static void functionTraceBegin(String traceName,
                                      int bufferSize)
```
    Starts tracing function logs based on the specified log file name and buffer size. The storage path is the default external storage directory.
    
    参数:
    
    traceName - Indicates the log file name. If this parameter is null, the default file name dmtrace.trace will be used.
    
    bufferSize - Indicates the buffer size in KB.
    
    从以下版本开始:
    
    3
  - functionTraceBegin
```
public static void functionTraceBegin(String traceName,
                                      int bufferSize,
                                      int flags)
```
    Starts tracing function logs based on the specified log name, buffer size, and flag. The storage path is the default external storage directory.
    
    参数:
    
    traceName - Indicates the log file name. If this parameter is null, the default file name dmtrace.trace will be used.
    
    bufferSize - Indicates the buffer size in KB.
    
    flags - Indicates the trace flag. Currently, only TRACE_COUNT_ALLOCS is supported.
    
    从以下版本开始:
    
    3
  - functionTraceSamplingBegin
```
public static void functionTraceSamplingBegin(String traceName,
                                              int bufferSize,
                                              int intervalUs)
```
    Starts tracing function logs in sampling mode based on the specified log file name, buffer size, and sampling interval.
    
    参数:
    
    traceName - Indicates the log file name. If this parameter is null, the default file name dmtrace.trace will be used.
    
    bufferSize - Indicates the buffer size in KB.
    
    intervalUs - Indicates the sampling interval, in microseconds.
    
    从以下版本开始:
    
    3
  - functionTraceEnd
```
public static void functionTraceEnd()
```
    Stops tracing function logs.
    
    从以下版本开始:
    
    3
  - dumpHeapFile
```
public static void dumpHeapFile(String fileName)
                         throws IOException
```
    Dumps a heap file into the specified file.
    
    参数:
    
    fileName - Indicates the file name, including the file path, for example, /sdcard/dump.hprof.
    
    抛出:
    
    IOException - if the heap file cannot be dumped.
    
    从以下版本开始:
    
    3
  - getRuntimeStatistic
```
public static String getRuntimeStatistic(String statisticName)
```
    Obtains the statistical information about the runtime of a specified name.
    
    参数:
    
    statisticName - Indicates the name of the runtime. The following runtime names are supported.
    gc.gc-count
    gc.gc-time
    gc.bytes-allocated
    gc.bytes-freed
    gc.blocking-gc-count
    gc.blocking-gc-time
    gc.gc-count-rate-histogram
    gc.blocking-gc-count-rate-histogram
    
    返回:
    
    Returns the statistical information about the runtime for this process if available; returns null if the statistics cannot be obtained.
    
    从以下版本开始:
    
    3
  - getRuntimeStatistics
```
public static Map<String,String> getRuntimeStatistics()
```
    Obtains the statistical information about all runtime used by this process. For details about the runtime names, see getRuntimeStatistic(java.lang.String).
    
    返回:
    
    Returns the statistical information in a map storing runtime names and their corresponding data values.
    
    从以下版本开始:
    
    3
  - connectToDebugger
```
public static void connectToDebugger()
```
    Connects this process to the debugger for entering the debug mode.
    
    从以下版本开始:
    
    5
  - getDebuggerConnectStatus
```
public static boolean getDebuggerConnectStatus()
```
    Obtains whether this process has been connected to the debugger.
    
    返回:
    
    Returns true if this process has been connected to the debugger; returns false otherwise.
    
    从以下版本开始:
    
    3
  - isConnectingToDebugger
```
public static boolean isConnectingToDebugger()
```
    Checks whether multiple processes are waiting to connect to the debugger.
    
    返回:
    
    Returns true if multiple processes are waiting to connect to the debugger; returns false otherwise.
    
    从以下版本开始:
    
    5
  - getCountofLoadClasses
```
public static int getCountofLoadClasses()
```
    Obtains the number of classes loaded by this process.
    
    返回:
    
    Returns the number of classes loaded by this process.
    
    从以下版本开始:
    
    3
  - dumpLoadClasses
```
public static void dumpLoadClasses(int flags)
```
    Dumps a list of classes with a specific flag that are loaded by this process into a log file.
    
    参数:
    
    flags - Indicates the flag of the loaded classes. The flag can be SHOW_FULL_DETAIL, SHOW_CLASSLOADER, or SHOW_INITIALIZED.
    
    从以下版本开始:
    
    3
  - emulatorTraceBegin
```
public static void emulatorTraceBegin()
```
    Starts tracing emulator logs. This method is intended only for applications running in the simulator.
    
    从以下版本开始:
    
    3
  - emulatorTraceEnd
```
public static void emulatorTraceEnd()
```
    Stops tracing emulator logs. This method is intended only for applications running in the simulator.
    
    从以下版本开始:
    
    3
  - emulatorTraceEnable
```
public static void emulatorTraceEnable()
```
    Enables log tracing for the emulator. If you want to enable log tracing for a period time, call emulatorTraceBegin().
    
    从以下版本开始:
    
    3
  - attachAgent
```
public static void attachAgent(String library,
                               String options,
                               ClassLoader classLoader)
                        throws IOException
```
    Attaches a library as the Java Virtual Machine Tool Interface (JVMTI) agent to the current runtime based on the given classLoader.
    
    参数:
    
    library - Indicates the path of the library to be attached.
    
    options - Indicates the options to be passed to the agent.
    
    classLoader - Indicates the class loader, which determines the library search path.
    
    抛出:
    
    IOException - Throws this exception if the agent cannot be connected.
    
    从以下版本开始:
    
    3

类 Debug

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

SHOW_CLASSLOADER

SHOW_FULL_DETAIL

SHOW_INITIALIZED

TRACE_COUNT_ALLOCS

构造器详细资料

Debug

方法详细资料

getProcessPss

getProcessPrivateDirtySum

getProcessPssSum

getNativeHeapInfo

getCpuTime

getProcessSwappablePss

getProcessSwappablePssSum

getProcessRss

getProcessRssSum

getProcessPrivateDirty

getProcessSharedDirty

getProcessSharedDirtySum

getProcessPrivateClean

getProcessPrivateCleanSum

getProcessSharedClean

getProcessSharedCleanSum

getProcessSwappedOut

getProcessSwappedOutSum

getProcessSwappedOutPss

getProcessSwappedOutPssSum

getIpcCount

getIpcSentCount

getIpcReceivedCount

getMemoryStatistic

getMemoryStatistics

functionTraceBegin

functionTraceBegin

functionTraceBegin

functionTraceBegin

functionTraceSamplingBegin

functionTraceEnd

dumpHeapFile

getRuntimeStatistic

getRuntimeStatistics

connectToDebugger

getDebuggerConnectStatus

isConnectingToDebugger

getCountofLoadClasses

dumpLoadClasses

emulatorTraceBegin

emulatorTraceEnd

emulatorTraceEnable

attachAgent