MeasureKit 0.0.2

MeasureKit 0.0.2

×

由 Hoang Nguyen 维护。

MeasureKit 0.0.2

  • 由
  • Hoang Nguyen

MeasureKit 库

MeasureKit 是一个轻量级的 Swift 库，旨在简化 iOS 应用程序中任务执行的测量。它提供了一个简单的接口来测量任务耗时并将事件报告给分析服务。这个 README.md 文件作为指南，帮助您将库集成到项目中。

安装

您可以使用 CocoaPods 将任务测量库集成到项目中。在 Podfile 中添加以下行：

pod 'MeasureKit'

然后，在项目目录中运行以下命令：

pod install

或者，您可以手动下载库并将源文件添加到项目中。

入门

1. 导入库

在希望使用MeasureKit模块的文件中导入它

import MeasureKit

2. 创建TaskMeasurement实例

在Swift文件中创建一个TaskMeasurement实例

let taskMeasurement = TaskMeasurementImp(analyticsService: AnalyticsServiceImp())

将AnalyticsServiceImp()替换为您的实际分析服务实现。此服务将接收到测量的事件。

3. 测量任务

使用startEvent和completeEvent方法来测量任务的持续时间。以下是一个在UIViewController中的示例

class ViewController: UIViewController {
    // ... other code

    lazy var taskMeasurement = TaskMeasurementImp(analyticsService: AnalyticsServiceImp())

    override func viewDidLoad() {
        super.viewDidLoad()

        // ... other code

        // Start event
        taskMeasurement.startEvent(eventIdentifier: "get_users_api")

        // Perform your task here, e.g., network request
        // ...

        // Completed event. It will throw an event to `AnalyticsService`.
        taskMeasurement.completeEvent(eventIdentifier: "get_users_api")
    }
}

MeasureKit将发送一个事件到AnalyticsService。结果将是

"name: get_users_api, params: Optional([\"val\": \"983.3632500004023\"])"

我们还提供了带有customAttributes的completeEvent方法

taskMeasurement.completeEvent(eventIdentifier: "get_users_api",
                              customAttributes: ["user": "123", "env": "ios"])

许可证

本库根据MIT许可证发布。

贡献

欢迎贡献！请随意提交问题和合并请求。

编码愉快！