AvoInspector
Avo 文档
这是一份快速入门指南。有关 Inspector 项目更多信息,请参阅 Avo 文档。
安装
AvoInspector 通过 CocoaPods 提供。要安装它,只需将以下行添加到 Podfile 中
pod 'AvoInspector'
最新版本可在 GitHub 发布选项卡中找到。
导入
Obj-C
#import <AvoInspector/AvoInspector.h>
Swift
import AvoInspector
初始化
在 Avo.app 获取 API 密钥
Obj-C
AvoInspector *avoInspector = [[AvoInspector alloc] initWithApiKey:@"apiKey" env: AvoInspectorEnvDev];
Swift
let avoInspector = AvoInspector(apiKey: "apiKey", env: AvoInspectorEnv.dev)
启用日志
默认情况下,开发模式中启用日志,基于初始化标志,生产模式中禁用日志。
Obj-C
[AvoInspector setLogging:YES];
Swift
AvoInspector.setLogging(true)
与 Avo Functions(由 Avo 生成的代码)集成
设置轻量级,请在本指南中获取详细信息。
在此集成之后,使用 Avo Function 发送的所有事件将自动发送到 Avo Inspector。
发送 Avo Functions 外部事件的事件架构
每次你发送跟踪事件调用以下方法之一
请在Avo 文档中获取更多信息
1.
这些方法获取实际的跟踪事件参数、自动提取架构并发送到 Avo Inspector 后端。这是使用库的最简单方法,只需在与你的分析工具的 track 方法调用相同参数的同一位置调用此方法即可。
Obj-C
[avoInspector trackSchemaFromEvent:@"Event Name" eventParams:@{@"id": @"sdf-334fsg-334f", @"number": @41}];
Swift
avoInspector.trackSchema(fromEvent: "Event Name", eventParams: ["id": "sdf-334fsg-334f", "number": 41])
2.
如果你希望手动提取数据架构,请使用此方法。
Obj-C
[avoInspector trackSchema:@"Event Name" eventSchema:@{@"id": [[AvoString alloc] init], @"number": [[AvoInt alloc] init]}];
Swift
avoInspector.trackSchema("Event Name", eventSchema: ["id": AvoString(), "number": AvoInt()])
手动提取事件架构
Obj-C
NSDictionary * schema = [avoInspector extractSchema:@{@"id": @"sdf-334fsg-334f", @"number": @41}];
Swift
let schema = avoInspector.extractSchema(["id": "sdf-334fsg-334f", "number": 41])
使用可视化检查器
默认情况下,可视化检查器在开发和预发布环境中启用。
显示
Obj-C
[avoInspector showVisualInspector:Bar]; // or Bubble
Swift
avoInspector.show(AvoVisualInspectorType.Bar) // or AvoVisualInspectorType.Bubble
隐藏
Obj-C
[avoInspector hideVisualInspector];
Swift
avoInspector.hideVisualInspector()
高级使用
您可以使用以下方法获取 AnalyticsDebugger
实例。
Obj-C
[avoInspector getVisualInspector];
Swift
avoInspector.getVisualInspector()
关于 AnalyticsDebugger
的更多信息,请参阅 GitHub 仓库
批量控制
为了确保我们的 SDK 对性能或电池寿命的影响不大,它支持事件方案批量处理。
默认的批量大小为 30,默认的批量刷新超时为 30 秒。在调试模式下,默认的批量刷新超时为 1 秒,即 SDK 将一秒内发送的事件方案批量处理。
Obj-C
[AvoInspector setBatchSize:15];
[AvoInspector setBatchFlushSeconds:10];
Swift
AvoInspector.setBatchSize(15)
AvoInspector.setBatchFlushSeconds(10)
示例应用
要运行示例项目,请先克隆仓库,然后在 Example 目录中运行 pod install
。
作者
Avo (https://www.avo.app), [email protected]
许可证
AvoInspector遵守MIT许可证。有关更多信息,请参阅LICENSE文件。