apex-live-event v1.0.21

顶点软件埋点事件 JSSDK

安装

npm install apex-live-event@1.0.21

调用

初始化埋点事件

初始化需要在应用初始化的时候调用，避免实例还未初始化就已经开始调用接口导致埋点失败。

import ApexLiveEvent from 'apex-live-event'

/**
 * 初始化配置参数类型
 */
type InitConfigType = {
  serverPath: string, // 服务地址 (必填) 例如 http://127.0.0.1:8111 或 https://yourwebsite.com 或 前端代理 '/liveEventApi'
}

const main = () => {
  // serverPath 可自行判断，例如 provider == 'wx' ? 'https://yourwebsite.com' : '/liveEventApi'
  const config: InitConfigType = {
    serverPath: 'http://127.0.0.1:8111', // 或 https://yourwebsite.com 或 前端代理 '/liveEventApi'
  }
  ApexLiveEvent.initConfig(config) // 返回值为初始化结果
}

调用埋点事件

import ApexLiveEvent from 'apex-live-event'

/**
 * 用户需要传入的参数类型
 */
type EventParamsType = {
  // traceId: string, // 事件链路唯一ID （前缀_随机唯一值）由 jssdk 提供
  traceName: string, // 事件链路名称
  traceCode: string, // 事件链路代码
  businessId?: string, // 业务唯一标识
  // eventId: string, // 事件唯一 ID （前缀_随机唯一值）等于 `${tanceId + 1}-yyyyMMdd` 由 jssdk 提供
  eventName: string, // 事件名称
  eventCode: string, // 事件代码
  clientEndpoint: string, // 客户端站点（192.169.0.2 或者 IMEI）
  serverEndpoint?: string, // 服务端站点（192.169.0.2 或者 IMEI）
  parentEventId?: string, // 父事件 ID
  previousEventId?: string, // 兄事件 ID
  startTime: number | undefined, // 开始时间
  endTime: number | undefined, // 结束时间
  duration?: string, // 处理耗时
  resultCode?: string | number, // 处理结果 -1|1|其他 code
  resultNote?: string, // 处理说明
  tags?: any, // json 对象字符串，不能是数组
}

/**
 * 完整的事件参数类型
 */
type EventParamsType = {
  traceId: string, // 事件链路唯一ID （前缀_随机唯一值） // 由jssdk提供
  traceName: string, // 事件链路名称
  traceCode: string, // 事件链路代码
  businessId?: string, // 业务唯一标识
  eventId: string, // 事件唯一 ID （前缀_随机唯一值） // 由jssdk提供
  eventName: string, // 事件名称
  eventCode: string, // 事件代码
  clientEndpoint: string, // 客户端站点（192.169.0.2 或者 IMEI）
  serverEndpoint?: string, // 服务端站点（192.169.0.2 或者 IMEI）
  parentEventId?: string, // 父事件 ID
  previousEventId?: string, // 兄事件 ID
  startTime: number, // 开始时间
  endTime: number, // 结束时间
  duration?: string, // 处理耗时
  resultCode?: string | number, // 处理结果 -1|1|其他 code
  resultNote?: string, // 处理说明
  tags?: string, // json 对象字符串，不能是数组
}

const Business = () => {
  const eventPrams: BusinessEventParamsType = {
    traceName: 'traceName-20241106100437',
    traceCode: 'traceCode-20241106100437',
    eventName: 'eventName-20241106100437',
    eventCode: 'eventCode-20241106100437',
    businessId: 'businessId-20241106100437',
    clientEndpoint: '127.0.0.1',
    serverEndpoint: '192.168.3.9',
    startTime: new Date().getTime(),
    endTime: new Date().getTime(),
    resultCode: 1,
    resultNote: 'resultNote-20241106100437',
    tags: {
      tag1: 'tag1-20241106100437',
      tag2: 'tag2-20241106100437',
    },
  }
  ApexLiveEvent.eventTrigger(eventPrams) // 返回值为埋点结果 code 为 1 表示埋点成功
}