@ked3/ktrace v1.0.1

KTrace 埋点分析SDK

KTrace是一个轻量级、跨平台的埋点分析SDK，支持Web、Vue、React和Electron应用，提供用户行为追踪和错误监控功能。

功能特性

• 多平台支持: Web、Vue、React和Electron
• 基础数据采集: 用户身份识别、设备信息收集、页面访问数据等
• 用户行为追踪: 点击事件、自定义事件追踪
• 错误监控: JavaScript异常、Promise错误、API请求错误、资源加载失败监控
• 灵活配置: 自定义采样率、数据处理
• 离线缓存: 支持数据本地存储和批量上报

安装

npm install ktrace

基础用法

Web应用

import ktrace from 'ktrace';

// 初始化
ktrace.init({
  appId: 'your-app-id',
  serverUrl: 'https://analytics.example.com/collect',
  debug: true
});

// 用户标识
ktrace.identify('user123', { level: 'premium' });

// 事件追踪
ktrace.track('button_click', { buttonId: 'submit-btn' });

// 页面访问追踪
ktrace.trackPageView('home_page', {
  referrer: document.referrer
});

// 错误追踪
try {
  // 业务代码
} catch (error) {
  ktrace.trackError(error, {
    component: 'LoginForm'
  });
}

Vue应用

import Vue from 'vue';
import { VueAdapter } from 'ktrace';

// 创建适配器
const ktrace = VueAdapter({
  appId: 'your-app-id',
  serverUrl: 'https://analytics.example.com/collect'
});

// 安装Vue插件
Vue.use(ktrace);

// 在组件中使用
export default {
  methods: {
    onSubmit() {
      // 追踪事件
      this.$track('form_submit', {
        formName: 'login'
      });
      
      // 其他业务逻辑...
    }
  }
}

React应用

import React from 'react';
import { TrackerProvider, useTracker } from 'ktrace/react';

// 在应用顶层使用Provider
function App() {
  return (
    <TrackerProvider config={{
      appId: 'your-app-id',
      serverUrl: 'https://analytics.example.com/collect'
    }}>
      <YourApp />
    </TrackerProvider>
  );
}

// 在组件中使用hooks
function LoginButton() {
  const { track } = useTracker();
  
  const handleClick = () => {
    track('login_click');
    // 其他业务逻辑...
  };
  
  return <button onClick={handleClick}>登录</button>;
}

Electron应用

// 在主进程中
import { createElectronAdapter } from 'ktrace';

const tracker = createElectronAdapter({
  appId: 'your-app-id',
  serverUrl: 'https://analytics.example.com/collect'
}, true); // true表示主进程

// 在渲染进程中
import { createElectronAdapter } from 'ktrace';

const tracker = createElectronAdapter({
  appId: 'your-app-id',
  serverUrl: 'https://analytics.example.com/collect'
});

// 使用方式与基础用法相同
tracker.track('app_started');

配置选项

开发指南

安装依赖

npm install

开发环境

npm run dev

构建生产版本

npm run build

许可证

MIT