codeLog
概述
codeLog 模块提供了日志的生成、查询和删除功能。
codeLog 模块适用于纪录代码运行日志、软件操作日志、系统异常日志等信息,不但可以帮助调试程序,而且可以监测系统的日常运行状况。在遇到问题的时候,查询日志可以快速找到问题,了解问题起因,并迅速解决问题。
writeLog
创建指定类别的日志,并写入日志内容
writeLog({params} , callback(ret, err))
tag:
- 类型: 字符串类型
- 默认值:’sys’
- 描述: (可选项)日志的类别标签,用来对日志进行分类,日志可以分多种类别,如:info,debug,warn,assert等,建议类别名称尽量简短。
text:
- 类型: 字符串类型
- 描述: 日志内容,可以存入各种自定义信息,不限长度
callback(ret, err)
ret:
- 类型:JSON对象
- 内部字段:
err:
- 类型:JSON对象
- 内部字段:
{
msg:'' //错误信息描述
}
示例代码
var logModule = api.require('codeLog');
logModule.writeLog(
{
"tag":"info",
"text":"content"
},
function(ret,err)
{
if (err){
//写入失败
alert(JSON.stringify(err));
}
else{
//写入成功
alert(JSON.stringify(ret));
}
});
可用性
iOS系统,Android系统
getLogList
getLogList({params}, callback(ret, err))
查询日志列表,可以指定类别和时段等筛选条件。时段条件要精确到秒,查询时段为多天时,可以只传入日期。如查询2017年4月10日一天的,类别为info的日志,指定的筛选条件为:
{“tag”:”info”,”startTime”:”2017-04-10 00:00:00”,”endTime”:”2017-04-10 23:59:59”}
或者
{“tag”:”info”,”startTime”:”2017-04-10”,”endTime”:”2017-04-11”}
tag:
- 类型: 字符串类型
- 默认值:无
- 描述:(可选项)日志类别名称
startTime:
- 类型: 字符串类型
- 默认值:无
- 描述:(可选项) 开始时间,日期格式为 yyyy-MM-dd HH:mm:ss或者yyyy-MM-dd
endTime:
- 类型: 字符串类型
- 默认值:无
- 描述:(可选项) 结束时间,日期格式为 yyyy-MM-dd HH:mm:ss或者yyyy-MM-dd
callback(ret, err)
ret:
- 类型:JSON对象数组
- 内部字段:
err:
- 类型:JSON对象
- 内部字段:
{
msg:'' //错误信息描述
}
示例代码
//获取所有日志
var logModule = api.require('codeLog');
logModule.getLogList(function(ret,err)
{
if (err){
//获取失败
alert(JSON.stringify(err));
}
else{
alert(JSON.stringify(ret));
}
});
//获取tag为'info'的日志
var logModule = api.require('codeLog');
logModule.getLogList(
{
"tag":"info"
},
function(ret,err)
{
if (err){
//获取失败
alert(JSON.stringify(err));
}
else{
//获取成功
alert(JSON.stringify(ret));
}
//获取tag为'info',时间 >='2017-04-10 00:00:00' 的日志
var logModule = api.require('codeLog');
logModule.getLogList(
{
"tag":"info",
"startTime":"2017-04-10"
},
function(ret,err)
{
if (err){
//获取失败
alert(JSON.stringify(err));
}
else{
//获取成功
alert(JSON.stringify(ret));
}
});
//获取tag为'info',时间 >='2017-04-10 12:31:28' 并且 <='2017-04-11 00:00:00' 的日志
var logModule = api.require('codeLog');
logModule.getLogList(
{
"tag":"info",
"startTime":"2017-04-10 12:31:28",
"endTime":"2017-04-11"
},
function(ret,err)
{
if (err){
//获取失败
alert(JSON.stringify(err));
}
else{
//获取成功
alert(JSON.stringify(ret));
}
});
可用性
可提供的1.0.0及更高版本
deleteLogs
批量删除指定时间段,指定类型日志。时段条件要精确到秒,查询时段为多天时,可以只传入日期。注意:删除后无法恢复,操作需谨慎。
deleteLogs({params}, callback(ret, err))
tag:
- 类型: 字符串类型
- 默认值:无
- 描述:(可选项)日志类型名称
startTime:
- 类型: 字符串类型
- 默认值:无
- 描述:(可选项)开始时间,日期格式为 yyyy-MM-dd HH:mm:ss或者yyyy-MM-dd
endTime:
- 类型: 字符串类型
- 默认值:无
- 描述:(可选项)结束时间,日期格式为 yyyy-MM-dd HH:mm:ss或者yyyy-MM-dd
callback(ret, err)
ret:
- 类型:JSON对象
- 内部字段:
err:
- 类型:JSON对象
- 内部字段:
{
msg:'' //错误信息描述
}
示例代码
//删除所有日志
var logModule = api.require('codeLog');
logModule.deleteLogs(function(ret,err)
{
if (err){
//删除失败
alert(JSON.stringify(err));
}
else{
//删除成功
alert(JSON.stringify(ret));
}
//删除tag为'info'的日志
var logModule = api.require('codeLog');
logModule.deleteLogs(
{
"tag":"info"
},
function(ret,err)
{
if (err){
//删除失败
alert(JSON.stringify(err));
}
else{
//删除成功
alert(JSON.stringify(ret));
}
});
//删除tag为'info',时间 >='2017-04-10 00:00:00' 并且 <='2017-04-11 00:00:00' 的日志
var logModule = api.require('codeLog');
logModule.deleteLogs(
{
"tag":"info",
"startTime":"2017-04-10",
"endTime":"2017-04-11"
},
function(ret,err)
{
if (err){
//删除失败
alert(JSON.stringify(err));
}
else{
//删除成功
alert(JSON.stringify(ret));
}
});
//删除tag为'info',时间 <='2017-04-11 00:00:00' 的日志
var logModule = api.require('codeLog');
logModule.deleteLogs(
{
"tag":"info",
"endTime":"2017-04-11"
},
function(ret,err)
{
if (err){
//删除失败
alert(JSON.stringify(err));
}
else{
//删除成功
alert(JSON.stringify(ret));
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本