@ohos.logLibrary (维测日志获取)

本模块提供了获取各类系统维测日志的能力。

说明：

• 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
• 本模块的接口为系统接口。

导入模块

import logLibrary from '@ohos.logLibrary';

LogEntry

日志文件对象接口。

系统能力： SystemCapability.HiviewDFX.Hiview.LogLibrary

logLibrary.list

list(logType: string): LogEntry[]

以同步方法查询指定类型的日志文件列表，接收string类型的对象作为参数，返回指定类型日志的文件列表信息。

需要权限： ohos.permission.READ_HIVIEW_SYSTEM

系统能力： SystemCapability.HiviewDFX.Hiview.LogLibrary

参数：

返回值：

错误码：

以下错误码的详细介绍请参见维测日志错误码。

示例：

import logLibrary from '@ohos.logLibrary';

try {
    let logObj = logLibrary.list('HILOG');
    // do something here.
} catch (error) {
    console.error(`error code: ${error?.code}, error msg: ${error?.message}`);
}

logLibrary.copy

copy(logType: string, logName: string, dest: string): Promise<void>

拷贝指定日志类型的指定文件到目标应用目录下。使用Promise回调。

需要权限： ohos.permission.READ_HIVIEW_SYSTEM

系统能力： SystemCapability.HiviewDFX.Hiview.LogLibrary

参数：

返回值：

错误码：

以下错误码的详细介绍请参见维测日志错误码。

示例：

import logLibrary from '@ohos.logLibrary';
import { BusinessError } from '@ohos.base';

try {
    logLibrary.copy('HILOG', 'hiapplogcat-1.zip', ''
    ).then(
        (val) => {
            // do something here.
        }
    ).catch(
        (err: BusinessError) => {
            // do something here.
        }
    )
} catch (error) {
    console.error(`error code: ${error?.code}, error msg: ${error?.message}`);
}

logLibrary.copy

copy(logType: string, logName: string, dest: string, callback: AsyncCallback<void>): void

拷贝指定日志类型的指定文件到目标应用目录下。使用callback回调。

需要权限： ohos.permission.READ_HIVIEW_SYSTEM

系统能力： SystemCapability.HiviewDFX.Hiview.LogLibrary

参数：

错误码：

以下错误码的详细介绍请参见维测日志错误码。

示例：

import logLibrary from '@ohos.logLibrary';

try {
    logLibrary.copy('HILOG', 'hiapplogcat-1.zip', 'dir1', (error, val) => {
        if (val === undefined) {
            // copy failed.
        } else {
            // copy success.
        }
    });
} catch (error) {
    console.error(`error code: ${error?.code}, error msg: ${error?.message}`);
}

logLibrary.move

move(logType: string, logName: string, dest: string): Promise<void>

移动指定日志类型的指定文件到目标应用目录下。使用Promise回调。

需要权限： ohos.permission.WRITE_HIVIEW_SYSTEM

系统能力： SystemCapability.HiviewDFX.Hiview.LogLibrary

参数：

返回值：

错误码：

以下错误码的详细介绍请参见维测日志错误码。

示例：

import logLibrary from '@ohos.logLibrary';
import { BusinessError } from '@ohos.base';

try {
    logLibrary.move('FAULTLOG', 'fault_log_test.zip', ''
    ).then(
        (val) => {
            // do something here.
        }
    ).catch(
        (err: BusinessError) => {
            // do something here.
        }
    )
} catch (error) {
    console.error(`error code: ${error?.code}, error msg: ${error?.message}`);
}

logLibrary.move

move(logType: string, logName: string, dest: string, callback: AsyncCallback<void>): void

移动指定日志类型的指定文件到目标应用目录下。使用callback回调。

需要权限： ohos.permission.WRITE_HIVIEW_SYSTEM

系统能力： SystemCapability.HiviewDFX.Hiview.LogLibrary

参数：

错误码：

以下错误码的详细介绍请参见维测日志错误码。

示例：

import logLibrary from '@ohos.logLibrary';

try {
    logLibrary.move('FAULTLOG', 'fault_log_test.zip', 'dir1/dir2', (error, val) => {
        if (val === undefined) {
            // move failed.
        } else {
            // move success.
        }
    });
} catch (error) {
    console.error(`error code: ${error?.code}, error msg: ${error?.message}`);
}

logLibrary.remove

remove(logType: string, logName: string): void

以同步方法删除指定日志类型的指定文件。

需要权限： ohos.permission.WRITE_HIVIEW_SYSTEM

系统能力： SystemCapability.HiviewDFX.Hiview.LogLibrary

参数：

错误码：

以下错误码的详细介绍请参见维测日志错误码。

示例：

import logLibrary from '@ohos.logLibrary';

try {
  logLibrary.remove('FAULTLOG', 'fault_log_test.zip');
} catch (error) {
  console.error(`error code: ${error?.code}, error msg: ${error?.message}`);
}