鸿蒙开发系统基础能力:【@ohos.hiAppEvent (应用打点)】

应用打点

本模块提供了应用事件打点能力,包括对打点数据的落盘,以及对打点功能的管理配置。

icon-note.gif 说明:  本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import hiAppEvent from '@ohos.hiAppEvent';

hiAppEvent.write

write(eventName: string, eventType: EventType, keyValues: object, callback: AsyncCallback): void

应用事件打点方法,将事件写入到当天的事件文件中,可接收类型为Json对象的事件参数,使用callback方式作为异步回调。

系统能力:  SystemCapability.HiviewDFX.HiAppEvent

参数:

参数名类型必填说明
eventNamestring应用事件名称。 由开发者自定义。事件名称在48个字符以内,有效的字符是0-9、a-z、下划线,只能以字母开头。
eventType[EventType]应用事件类型。
keyValuesobject事件参数键值对,如果是变长参数类型,则依次输入事件的参数名与参数值。如果是Json对象类型,则Json对象的key是事件的参数名,value是事件的参数值。 - key类型只能为string,value类型只能为string、number、boolean、Array(数组数据类型只能为string、number、boolean)。 - 事件的参数个数必须小于等于32。 - 参数名在16个字符以内,有效的字符是0-9、a-z、下划线,只能以字母开头,不能以下划线结尾。 - string类型参数值在8*1024个字符内。 - Array类型参数值的元素个数必须在100个以内,超出时会进行截断处理。
callbackAsyncCallback回调函数,可以在回调函数中处理接口返回值。 - 返回值为0表示事件校验成功,事件正常异步写入事件文件; - 大于0表示事件校验存在异常参数,在忽略异常参数后将事件异步写入事件文件; - 小于0表示事件校验失败,不将事件写入事件文件。

示例:

hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str_data":"strValue"}, (err, value) => {if (err) {// 事件写入异常:事件存在异常参数时忽略异常参数后继续写入,或者事件校验失败时不执行写入console.error(`failed to write event because ${err.code}`);return;}// 事件写入正常console.log(`success to write event: ${value}`);
});

hiAppEvent.write

write(eventName: string, eventType: EventType, keyValues: object): Promise

应用事件打点方法,将事件写入到当天的事件文件中,可接收类型为Json对象的事件参数,使用promise方式作为异步回调。

系统能力:  SystemCapability.HiviewDFX.HiAppEvent

参数:

参数名类型必填说明
eventNamestring应用事件名称。 由开发者自定义。事件名称在48个字符以内,有效的字符是0-9、a-z、下划线,只能以字母开头。
eventType[EventType]应用事件类型。
keyValuesobject事件参数键值对,如果是变长参数类型,则依次输入事件的参数名与参数值。如果是Json对象类型,则Json对象的key是事件的参数名,value是事件的参数值。 - key类型只能为string,value类型只能为string、number、boolean、Array(数组数据类型只能为string、number、boolean)。 - 事件的参数个数必须小于等于32。 - 参数名在16个字符以内,有效的字符是0-9、a-z、下划线,只能以字母开头,不能以下划线结尾。 - string类型参数值在8*1024个字符内。 - Array类型参数值的元素个数必须在100个以内,超出时会进行截断处理。

返回值:

类型说明
PromisePromise实例,可以在其then()、catch()方法中分别对事件写入成功、写入异常的情况进行回调处理。

示例:

hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str_data":"strValue"}).then((value) => {// 事件写入正常console.log(`success to write event: ${value}`);}).catch((err) => {// 事件写入异常:事件存在异常参数时忽略异常参数后继续写入,或者事件校验失败时不执行写入console.error(`failed to write event because ${err.code}`);});

hiAppEvent.configure

configure(config: ConfigOption): boolean

应用事件打点配置方法,可用于配置打点开关、文件目录存储限额大小等功能。

系统能力:  SystemCapability.HiviewDFX.HiAppEvent

参数:

参数名类型必填说明
config[ConfigOption]应用事件打点配置项对象。

返回值:

类型说明
boolean配置结果,true 表示配置成功,false 表示配置失败。

示例:

// 配置应用事件打点功能开关
hiAppEvent.configure({disable: true
});// 配置事件文件目录存储限额大小
hiAppEvent.configure({maxStorage: '100M'
});

ConfigOption

此接口提供了应用打点的配置选项。

系统能力:  以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。

参数名类型必填说明
disableboolean应用打点功能开关。配置值为true表示关闭打点功能,false表示不关闭打点功能。
maxStoragestring打点数据本地存储文件所在目录的配额大小,默认限额为“10M”。所在目录大小超出限额后会对目录进行清理操作,会按从旧到新的顺序逐个删除打点数据文件,直到目录大小不超出限额时停止。

EventType

事件类型枚举。

系统能力:  以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。

名称默认值说明
FAULT1故障类型事件。
STATISTIC2统计类型事件。
SECURITY3安全类型事件。
BEHAVIOR4行为类型事件。

Event

此接口提供了所有预定义事件的事件名称常量。

系统能力:  以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。

名称参数类型可读可写说明
USER_LOGINstring用户登录事件。
USER_LOGOUTstring用户登出事件。
DISTRIBUTED_SERVICE_STARTstring分布式服务启动事件。

Param

此接口提供了所有预定义参数的参数名称常量。

系统能力:  以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。

名称参数类型可读可写说明
USER_IDstring用户自定义ID。
DISTRIBUTED_SERVICE_NAMEstring分布式服务名称。
DISTRIBUTED_SERVICE_INSTANCE_IDstring分布式服务实例ID。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/858430.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

基于 Java 实现的智能客服聊天工具模拟场景

服务端代码 import java.io.BufferedReader; import java.io.IOException; import java.io.InputStreamReader; import java.io.PrintWriter; import java.net.ServerSocket; import java.net.Socket;public class Server {public static void main(String[] args) throws IOE…

今日分享:中国石油年金系统交互、视觉设计和vue开发

金融系统交互及UI设计时,需注意简洁明了、色彩合理、字体统一、交互易用、安全感和用户控制。确保用户快速理解、安全操作并提升体验。

数据结构~~时间、空间复杂度

目录 一、什么是数据结构 什么是算法 算法的复杂度 二、时间复杂度 三、空间复杂度 四、总结 一、什么是数据结构 数据结构(Data Structure)是计算机存储、组织数据的方式,指相互之间存在一种或多种特定关系的 数据元素的集合。 数据结构关注的是数据的逻辑结…

快速搭建Jenkins自动化集成cicd工具

一、简介 jenkins是一款优秀的自动化持续集成运维工具,可以极大的简化运维部署的步骤。 传统的项目部署需要手动更换最新的项目代码,然后打包并运行到服务器上。 使用Jenkins可以自动化实现,当代码编写完成并提交到git后,Jenki…

通过 cloudflare 白嫖个人 docker 镜像加速服务

不知为何,现在大多数的 docker hub 镜像加速站都停止服务,而官方站点又因某些原因访问不到或延迟很高。所以,今天来记录一种通过 CloudFlare 搭建一个自己的镜像加速服务。 0、必看!!! 注意: 此…

pywebview打包本地的html

51.安装 pip install pywebview 2.新建start.py import webview import timeclass API:def say_hello(self, name):time.sleep(2) # 模拟一个耗时操作return fHello, {name}!def main():api API()webview.create_window(pywebview Example, index.html, js_apiapi)webview.…

抛弃Mybatis,拥抱新的ORM 框架!【送源码】

背景 转java后的几年时间里面一直在寻找一个类似.net的orm,不需要很特别的功能,仅希望90%的场景都可以通过强类型语法来编写符合直觉的sql,来操作数据库编写业务。 但是一直没有找到,Mybatis-Plus的单表让我在最初的时间段内看到…

利用golang_Consul代码实现Prometheus监控目标的注册以及动态发现与配置

文章目录 前言一、prometheus发现方式二、监控指标注册架构图三、部分代码展示1.核心思想2.代码目录3、程序入口函数剖析4、settings配置文件5、初始化配置文件及consul6、全局变量7、配置config8、公共方法目录common9、工具目录tools10、service层展示11、命令行参数12、Make…

Qt异常处理

初步警告:异常安全功能不完整!一般情况下应该可以工作,但类仍然可能泄漏甚至崩溃。 Qt本身不会抛出异常。而是使用错误码, 但是C可能会抛出异常。此外,有些类有用户可见的错误消息,例如QIODevice::errorString()或QSqlQuery::lastError()。这…

Android笔记-安装Termux开启ssh,安装vim、android-tool、python等

背景 家里面有个老手机,想将此手机做成一个家庭服务器。控制各种家电。目前准备先控制电视机 流程 用电脑usb连接手机,下载好Termux,在安卓手机上安装好。这里就不记录笔记了,各个手机不一样。 安装好进入手机后: …

Java短路逻辑运算符

Java中的运算符还有短路运算符。 其中就有符号 && 和 || 符号 作用 说明 && 短路与 结果和&相同,但是有短路效果 || 短路或 结果和|相同,但是有短路效果 注意事项: &和|&…

SIM卡将成为历史

近期苹果发布了全新款的 iPad Pro 和 iPad Air,这些新品不仅在性能和设计上带来了令人惊叹的进步,还悄然迎来了一项重要改变:eSIM 技术的支持。此次发布的蜂窝版本 iPad Pro 和 iPad Air 都不再配备物理 SIM 卡槽,这标志着苹果在推…

mfc140.dll是什么文件?mfc140.dll文件下载安装办法

一、mfc140.dll文件功能与作用 mfc140.dll作为Microsoft Foundation Classes库的一部分,提供了一系列的基础功能,这些功能对于开发Windows桌面应用程序至关重要。 2.1 应用程序框架 mfc140.dll封装了应用程序的生命周期管理,包括初始化、运…

Gorm 基础:表映射

这篇文章将以创建事件时间记录功能为示例,介绍如何使用 Gorm 完成数据库表的基本映射、简单的创建表数据操作和注意事项。 数据库表设计 设计一个事件时间记录功能通常需要记录事件的开始时间、结束时间和事件类型,以及一些额外的功能,像事…

代码生成技术技术-janino

文章目录 背景简单例子flink 例子 背景 代码生成技术适合在需要动态代码编译的场景中使用。比如大数据计算场景下,经常会要把flink sql 转成实际的执行计划 简单例子 代码是一个string 类型,直接用janino 编译后,就可以得到加载到jvm里的c…

北京地铁用什么数据结构来处理

北京地铁信息查询系统或相关数据分析系统可能会使用多种数据结构来高效地处理和存储信息。以下是几种可能用到的数据结构及其用途: 图(Graph):北京地铁线路可以被建模为一个有向加权图,其中每个站点是一个节点&#xf…

赶论文不用愁:如何利用ChatGPT在3小时内完成论文

在这份指南里,我将详细介绍如何运用ChatGPT 4.0的高级功能来辅助学术研究与文章写作。从挖掘研究课题的初步想法开始,到撰写一篇内容深刻、结构完整的学术论文,我将逐步演示如何在研究的各个阶段中充分利用ChatGPT。值得一提的是,…

编程精粹—— Microsoft 编写优质无错 C 程序秘诀 07:编码中的假象

这是一本老书,作者 Steve Maguire 在微软工作期间写了这本书,英文版于 1993 年发布。2013 年推出了 20 周年纪念第二版。我们看到的标题是中译版名字,英文版的名字是《Writing Clean Code ─── Microsoft’s Techniques for Developing》&a…

POSTMAN接口详解

Postman接口详解 Postman 是一个流行的API开发工具,广泛应用于测试、开发和文档编写。它支持发送各种HTTP请求,管理请求参数、标头、认证和脚本,帮助开发者快速调试和验证API接口的正确性。以下是对Postman接口的详细讲解。 Postman基本功能…

二进制炸弹的fp是什么?

🏆本文收录于「Bug调优」专栏,主要记录项目实战过程中的Bug之前因后果及提供真实有效的解决方案,希望能够助你一臂之力,帮你早日登顶实现财富自由🚀;同时,欢迎大家关注&&收藏&&…