使用文档

配置选项

本文档描述各 SDK 的通用配置选项。

通用配置

所有 SDK 都支持以下核心配置:

选项 类型 默认值 说明
appId string - 必填,网站/应用 ID
endpoint string - API 端点 URL
batchSize number 10 批量发送的事件数量
flushInterval number 5000 自动发送间隔 (毫秒)
maxQueueSize number 1000 最大队列大小
debug boolean false 调试模式

Web SDK 配置

antdock.init({
  // 必填
  appId: 'your-website-id',

  // 端点配置
  endpoint: 'https://你的域名',

  // 自动追踪
  autoTrack: true,              // 自动追踪页面访问

  // 功能开关
  enableHeatmap: false,         // 热图 (点击追踪)
  enableScroll: false,          // 滚动深度追踪
  enableError: true,            // 错误追踪
  enablePerformance: true,      // 性能追踪

  // 批量配置
  batchSize: 10,
  flushInterval: 5000,
  maxQueueSize: 1000,

  // 调试
  debug: false
})

微信小程序配置

AntDockTracker.init({
  appId: 'your-website-id',
  endpoint: 'https://你的域名',
  autoTrack: true,
  batchSize: 10,
  flushInterval: 5000,
  debug: false
})

iOS SDK 配置

AntDockOptions(
    autoTrack: true,
    enableCrashReport: false,
    batchSize: 10,
    flushInterval: 5.0,     // 秒
    maxQueueSize: 1000,
    debug: false
)

Android SDK 配置

AntDockConfig(
    appId = "your-website-id",
    endpoint = "https://你的域名",
    autoTrack = true,
    enableCrashReport = false,
    batchSize = 10,
    flushIntervalMs = 5000,
    maxQueueSize = 1000,
    debug = false
)

React Native 配置

AntDockTracker.init({
  appId: 'your-website-id',
  endpoint: 'https://你的域名',
  batchSize: 10,
  flushInterval: 5000,
  debug: false
})

Flutter 配置

AntDockOptions(
  batchSize: 10,
  flushIntervalMs: 5000,
  maxQueueSize: 1000,
  debug: false,
)

动态配置

运行时控制

// 启用/禁用追踪
antdock.enable()
antdock.disable()

配置最佳实践

1. 开发环境

antdock.init({
  appId: 'dev-website-id',
  debug: true
})

2. 生产环境

antdock.init({
  appId: 'prod-website-id',
  debug: false,
  batchSize: 10,
  flushInterval: 5000
})

3. 高流量场景

antdock.init({
  appId: 'your-website-id',
  batchSize: 20,
  flushInterval: 10000,
  maxQueueSize: 2000
})