Latest2.0.0
Homepagehttps://github.com/pre-dem/pre-dem-cocoa
LicenseMIT
Platformsios 8.0
Authors

pre-dem-cocoa

Build Status
codecov
Latest Stable Version
Platform

简介

pre-dem-cocoa 是由七牛云发起和维护的针对 iOS (Mac OS, Tv OS, Watch OS WIP) 等平台集用户体验监控及报障于一体的开源 SDK,具有无埋点集成,轻量级,高性能等优点

安装

使用 CocoaPods 进行安装

pod "PreDemCocoa"

快速开始

  • 初始化
    NSError *error;
    [PREDManager startWithAppKey:@"YOUR_APP_KEY"
                   serviceDomain:@"YOUR_REPORT_DOMAIN"
                        complete:^(BOOL succeess, NSError * _Nullable error) {
                            if (error) {
                                NSLog(@"initialize PREDManager error: %@", error);
                            }
                        }];

初始化之后,SDK 便会自动采集包括 HTTP 请求等监控数据并上报到您指定的服务器

  • 网络诊断
    [PREDManager  diagnose:@"YOUR_SERVER"
                  complete:^(PREDNetDiagResult * _Nonnull result) {
        NSLog(@"new diagnose completed with result:n %@", result);
    }];

网络诊断功能会使用包括 ping, traceroute 等一系列网络工具对您指定的服务器进行网络诊断并将诊断结果上传服务器。

  • 自定义事件
    NSDictionary *dict = @{
                           @"PARAMETER_KEY1": @"PARAMETER_VALUE1",
                           @"PARAMETER_KEY2": @"PARAMETER_VALUE2"
                           };
    PREDEvent *event = [PREDEvent eventWithName:@"YOUR_EVENT_NAME" contentDic:dict];
    [PREDManager trackEvent:event];

自定义事件上报功能能够将您自定义的事件直接上报至服务器。

  • 事务上报

开始一个事务

PREDTransaction *transaction = [PREDManager transactionStart:@"test"];

将一个事务标识为完成并上传数据到服务器(!注意一个事务只能标识一次完成,之后应该释放该对象,多次标识完成会造成统计出现偏差)

[transaction complete];

将一个事务标识为被取消并上传数据到服务器(!注意一个事务只能标识一次被取消,之后应该释放该对象,多次标识完成会造成统计出现偏差)

[transaction cancelWithReason:@"test reason for cancelled transaction"];

将一个事务标识为失败并上传数据到服务器(!注意一个事务只能标识一次被取消,之后应该释放该对象,多次标识完成会造成统计出现偏差)

[transaction failWithReason:@"test reason for failed transaction"];

示例代码

  • 完整的 demo 见 PreDemCocoaDemo 目录下的代码
  • 具体细节的一些配置 可参考 PreDemCocoaDemo/PreDemCocoaTests 下面的一些单元测试,以及源代码

常见问题

代码贡献

详情参考 代码提交指南.

贡献记录

联系我们

  • 如果需要帮助, 请提交工单 (在 portal 右侧点击咨询和建议提交工单, 或者直接向 [email protected] 发送邮件)
  • 如果有什么问题, 可以到问答社区提问, 问答社区
  • 如果发现了 bug, 欢迎提交 issue
  • 如果有功能需求, 欢迎提交 issue
  • 如果要提交代码, 欢迎提交 pull request
  • 欢迎关注我们的 微信 && 微博, 及时获取动态信息

代码许可

The MIT License (MIT). 详情见 License 文件.

Latest podspec

{
    "name": "PreDemCocoa",
    "version": "2.0.0",
    "summary": "A short description of PreDemCocoa.",
    "homepage": "https://github.com/pre-dem/pre-dem-cocoa",
    "license": "MIT",
    "authors": {
        "cnwangsiyu": "[email protected]"
    },
    "source": {
        "git": "https://github.com/pre-dem/pre-dem-cocoa.git",
        "tag": "v2.0.0"
    },
    "platforms": {
        "ios": "8.0"
    },
    "default_subspecs": "Core",
    "subspecs": [
        {
            "name": "Core",
            "source_files": "PreDemCocoa/**/*.{h,m,mm,c,cpp}",
            "public_header_files": "PreDemCocoa/Public/*.h",
            "libraries": [
                "c++",
                "z"
            ],
            "resource_bundles": {
                "PREDResources": "PreDemCocoa/Resources/*.plist"
            },
            "dependencies": {
                "QNNetDiag": [],
                "UICKeyChainStore": []
            }
        }
    ]
}

Pin It on Pinterest

Share This