Automattic-Tracks-iOS

用于跟踪用户事件以便稍后分析的客户端库

简介

Tracks for iOS 是一个用于在应用程序内部跟踪事件的客户端库。该项目仅负责收集事件，将其本地存储，并按计划将其发送到 Automattic 服务器。实际上，这个库只对基于 Automattic 的项目有用，但我们旨在分享我们所创造的东西。

安装

您可以通过 Swift Package Manager 在您的应用程序中安装 Tracks 组件。

.package(url: "https://github.com/Automattic/Automattic-Tracks-iOS", from: "0.10.0")

您可以导入整个库，使用 import AutomatticTracks。或者，您也可以仅导入库的某个特定部分

// Reporting events to the internal 'Tracks' service
import AutomatticTracksEvents

// Uploading app logs and crash logs to internal monitoring tools
import AutomatticRemoteLogging

// Running experiments using the internal 'ExPlat' tool
import AutomatticExperiments

// Displaying crash logs in your app
import AutomatticCrashLoggingUI

也可以通过 CocoaPods 安装 Tracks，尽管我们建议用户使用 Swift Package Manager。要通过 Cocoapods 安装

pod 'Automattic-Tracks-iOS'

使用方法

报告事件

1. 创建一个 TracksService 实例。
2. 使用适当的 eventNamePrefix 属性设置一个适当的甚至是受支持的名称前缀。作为 Automattician，您将知道如何获取允许的前缀。
3. 将此实例保存在一个稳定的地方，并在您的应用程序中仅创建一个。

查看 TracksDemo 项目，了解如何跟踪事件的信息。

运行实验

1. 调用 ExPlat.configure(platform:oauthToken:userAgent:anonId:) 来配置实验平台。（如果您正在使用 TracksService，它将在您创建 Tracks 服务时为您执行此调用。）
2. 通过 Explat.shared.register(experiments:) 注册应用应使用的实验。
3. 检查 ExPlat.shared.experiment("my_experiment_name") 来确定应使用实验的哪个变体。

上传文件

1. 使用 init(dataSource:delegate:) 创建一个 EventLogging 实例。
2. 调用 enqueueLogForUpload(log:) 来安排日志文件的上传。

日志

追踪一些活动日志。默认情况下，这些日志将仅输出到控制台。如果您希望将此日志包含在自己的日志解决方案中，可以创建并指派一个符合 TracksLoggingDelegate 协议的日志代理。

TracksLogging.delegate = MyLoggingHandler()

贡献

1. 进行Fork操作！
2. 创建您的功能分支： git checkout -b my-new-feature
3. 提交您的更改： git commit -am 'Add some feature'
4. 将分支推送到远程： git push origin my-new-feature
5. 提交Pull Request :D

鸣谢

原始来源： https://github.com/Automattic/Automattic-Tracks-iOS

最初由：Aaron Douglas @astralbodies 创建

许可证

Automattic-Tracks-iOS 在 GPLv2 许可证下可用。有关更多信息，请参阅LICENSE 文件。