Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
29123eef
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
29123eef
编写于
5月 18, 2023
作者:
B
BruceZong
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
add docs for loglibrary interfaces
Signed-off-by:
N
BruceZong
<
zongquan@huawei.com
>
上级
e475a982
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
343 addition
and
0 deletion
+343
-0
zh-cn/application-dev/reference/apis/js-apis-loglibrary.md
zh-cn/application-dev/reference/apis/js-apis-loglibrary.md
+319
-0
zh-cn/application-dev/reference/errorcodes/errorcode-loglibrary.md
...lication-dev/reference/errorcodes/errorcode-loglibrary.md
+24
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-loglibrary.md
0 → 100644
浏览文件 @
29123eef
# @ohos.logLibrary (维测日志获取)
本模块提供了获取各类系统维测日志的能力。
> **说明:**
>
> - 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块的接口为系统接口。
## 导入模块
```
js
import
logLibrary
from
'
@ohos.logLibrary
'
;
```
## LogEntry
日志文件对象接口。
**系统能力:**
SystemCapability.HiviewDFX.Hiview.LogLibrary
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| name | string | 是 | 否 | 文件名称。 |
| mtime | number | 是 | 否 | 上次修改该文件的时间,表示距1970年1月1日0时0分0秒的秒数。 |
| size | number | 是 | 否 | 文件大小,以字节为单位。 |
## logLibrary.list
list(logType: string): LogEntry[]
以同步方法查询指定类型的日志文件列表,接收string类型的对象作为参数,返回指定类型日志的文件列表信息。
**需要权限:**
ohos.permission.READ_HIVIEW_SYSTEM
**系统能力:**
SystemCapability.HiviewDFX.Hiview.LogLibrary
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ------------------------------------------------------------ |
| logType | string | 是 | 日志类型字符串,例如“HILOG”, "FAULTLOG", "BETACLUB", "REMOTELOG"等。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------------------------------------------------------ |
| LogEntry[] | 日志文件对象的数组。 |
**错误码:**
以下错误码的详细介绍请参见
[
维测日志错误码
](
../errorcodes/errorcode-loglibrary.md
)
。
| 错误码ID | 错误信息 |
| ------- | ----------------------------------------------------------------- |
| 201 | Permission denied. |
| 202 | Permission denied, non-system app called system api. |
| 401 | Invalid argument.|
**示例:**
```
js
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
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ----------------------- | ---- | --------------- |
| logType | string | 是 | 日志类型字符串,例如“HILOG”, "FAULTLOG", "BETACLUB", "REMOTELOG"等。 |
| logName | string | 是 | 日志文件名称。 |
| dest | string | 是 | 目标目录,需填入相对目录名称。传入dest字串后,日志文件将保存到应用缓存路径下的"hiview/
*dest*
"文件夹,即"../cache/hiview/
*dest*
"。可填入多层目录。
<br>
如果传入空字串,将保存到根目录下,即应用缓存路径下的hiview文件夹。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------------------------------------------------------ |
| Promise
<
void
>
| Promise实例,可以在其then()、catch()方法中分别对拷贝成功、拷贝异常的回调进行处理。 |
**错误码:**
以下错误码的详细介绍请参见
[
维测日志错误码
](
../errorcodes/errorcode-loglibrary.md
)
。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------------------------------- |
| 201 | Permission denied. |
| 202 | Permission denied, non-system app called system api. |
| 401 | Invalid argument.|
| 21300001 | Source file does not exists. |
**示例:**
```
js
import
logLibrary
from
'
@ohos.logLibrary
'
;
try
{
logLibrary
.
copy
(
'
HILOG
'
,
'
hiapplogcat-1.zip
'
,
''
).
then
(
(
val
)
=>
{
// do something here.
}
).
catch
(
(
err
)
=>
{
// 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
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ------------------------------------------------------------ |
| logType | string | 是 | 日志类型字符串,例如“HILOG”, "FAULTLOG", "BETACLUB", "REMOTELOG"等。 |
| logName | string | 是 | 日志文件名称。 |
| dest | string | 是 | 目标目录,需填入相对目录名称。传入dest字串后,日志文件将保存到应用缓存路径下的"hiview/
*dest*
"文件夹,即"../cache/hiview/
*dest*
"。可填入多层目录。
<br>
如果传入空字串,将保存到根目录下,即应用缓存路径下的hiview文件夹。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,可以在回调函数中处理接口返回值。0表示拷贝成功,其它值表示拷贝失败。 |
**错误码:**
以下错误码的详细介绍请参见
[
维测日志错误码
](
../errorcodes/errorcode-loglibrary.md
)
。
| 错误码ID | 错误信息 |
| ------- | ----------------------------------------------------------------- |
| 201 | Permission denied. |
| 202 | Permission denied, non-system app called system api. |
| 401 | Invalid argument.|
| 21300001 | Source file does not exists. |
**示例:**
```
js
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
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ----------------------- | ---- | --------------- |
| logType | string | 是 | 日志类型字符串,例如"FAULTLOG", "BETACLUB", "REMOTELOG"等。 |
| logName | string | 是 | 日志文件名称。 |
| dest | string | 是 | 目标目录,需填入相对目录名称。传入dest字串后,日志文件将保存到应用缓存路径下的"hiview/
*dest*
"文件夹,即"../cache/hiview/
*dest*
"。可填入多层目录。
<br>
如果传入空字串,将保存到根目录下,即应用缓存路径下的hiview文件夹。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------------------------------------------------------ |
| Promise
<
void
>
| Promise实例,可以在其then()、catch()方法中分别对移动成功、移动异常的回调进行处理。 |
**错误码:**
以下错误码的详细介绍请参见
[
维测日志错误码
](
../errorcodes/errorcode-loglibrary.md
)
。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------------------------------- |
| 201 | Permission denied. |
| 202 | Permission denied, non-system app called system api. |
| 401 | Invalid argument.|
| 21300001 | Source file does not exists. |
**示例:**
```
js
import
logLibrary
from
'
@ohos.logLibrary
'
;
try
{
logLibrary
.
move
(
'
FAULTLOG
'
,
'
fault_log_test.zip
'
,
''
).
then
(
(
val
)
=>
{
// do something here.
}
).
catch
(
(
err
)
=>
{
// 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
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ------------------------------------------------------------ |
| logType | string | 是 | 日志类型字符串,例如“HILOG”, "FAULTLOG", "BETACLUB", "REMOTELOG"等。 |
| logName | string | 是 | 日志文件名称。 |
| dest | string | 是 | 目标目录,需填入相对目录名称。传入dest字串后,日志文件将保存到应用缓存路径下的"hiview/
*dest*
"文件夹,即"../cache/hiview/
*dest*
"。可填入多层目录。
<br>
如果传入空字串,将保存到根目录下,即应用缓存路径下的hiview文件夹。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,可以在回调函数中处理接口返回值。0表示移动成功,其它值表示移动失败。 |
**错误码:**
以下错误码的详细介绍请参见
[
维测日志错误码
](
../errorcodes/errorcode-loglibrary.md
)
。
| 错误码ID | 错误信息 |
| ------- | ----------------------------------------------------------------- |
| 201 | Permission denied. |
| 202 | Permission denied, non-system app called system api. |
| 401 | Invalid argument.|
| 21300001 | Source file does not exists. |
**示例:**
```
js
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
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ------------------------------------------------------------ |
| logType | string | 是 | 日志类型字符串,例如"FAULTLOG", "BETACLUB", "REMOTELOG"等。 |
| logName | string | 是 | 日志文件名称。 |
**错误码:**
以下错误码的详细介绍请参见
[
维测日志错误码
](
../errorcodes/errorcode-loglibrary.md
)
。
| 错误码ID | 错误信息 |
| ------- | ----------------------------------------------------------------- |
| 201 | Permission denied. |
| 202 | Permission denied, non-system app called system api. |
| 401 | Invalid argument.|
| 21300001 | Source file does not exists. |
**示例:**
```
js
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
}
`
);
}
```
\ No newline at end of file
zh-cn/application-dev/reference/errorcodes/errorcode-loglibrary.md
0 → 100644
浏览文件 @
29123eef
# 维测日志错误码
> **说明:**
>
> 以下仅介绍本模块特有错误码,通用错误码请参考[通用错误码说明文档](errorcode-universal.md)。
## 21300001 指定文件不存在
**错误信息**
The specified file does not exist.
**错误描述**
在调用拷贝、移动、删除接口进行文件操作时,指定类型日志中不存在指定文件名的文件。
**可能原因**
1.
文件名称传递错误。
2.
传入的文件名在物理设备上不存在。
**处理步骤**
检查传入的文件名称是否正确。
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录