Git Product home page Git Product logo

pre-dem-cocoa's Introduction

pre-dem-cocoa

Build Status codecov Latest Stable Version Platform

简介

pre-dem-cocoa 是由七牛云发起和维护的针对 iOS (Mac OS, Tv OS, Watch OS WIP) 等平台集用户体验监控及报障于一体的开源 SDK,用户可以将自定义数据上传到APM上进行分析

安装

使用 CocoaPods 进行安装

pod "PreDemCocoa"

快速开始

  • 创建APP 首先到apm.qiniu.com 上登录并创建自己的APP,在配置信息中找到对应的APP KEY,以及消息上报的域名,填入到sdk中,

  • 初始化

    NSError *error;
    [PREDManager startWithAppKey:@"YOUR_APP_KEY" 
      serviceDomain:@"YOUR_REPORT_DOMAIN"];

初始化之后,SDK 便会自动定期从服务器更新配置信息,终端可根据配置来调整队列发送间隔时间

  • 自定义事件
    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"];
  • 调整发送间隔 默认30s的发送间隔,如果想调整,可以通过如下方式调整 PREDManager.updateInterval = 时间;

示例代码

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

SDK 发送机制介绍

目的

  • 支持灵活的自定义事件上报
  • 提供可靠的缓存机制保障消息不丢失
  • 通过白名单以及其他用户需求,对发送的间隔进行控制
  • 发送组件作为核心,其他采集方式以插件组合方式进行使用

机制介绍

发送数据的主要流程主要分为三个阶段

  1. 数据序列化,将自定义事件加上系统的一些参数,序列化为待上传的json数据
  2. 数据缓存,通过缓存组件,将序列化过的数据缓存在文件中,保障数据不丢失,默认是512K大小换一个文件
  3. 数据发送,将已经缓存过的数据,按照时间间隔进行发送,发送时使用gzip进行压缩,系统启动时发送一次,之后按照updateInterval 指定的时间进行发送,默认是30秒,失败后不会尝试重传(由于网络等问题,失败时大概率重试也会失败),等待到下一个周期继续
  4. 另外,在发送的时候从服务器获取到的一些状态变更由 Sender 通过 Notification 的方式进行广播,内部变更状态的模块通过监听 Notification 的方式进行相关状态的变更。

Todo

  • 使用protobuf 进行序列化
  • 限制最大存储空间进行滚动存储
  • 支持只在WI-FI下发送
  • 支持默认不发送,只在需要时候进行发送

常见问题

代码贡献

详情参考 代码提交指南.

贡献记录

联系我们

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

代码许可

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

pre-dem-cocoa's People

Contributors

cnwangsiyu avatar huangdeheng avatar lansefengxinzi avatar longbai avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

pre-dem-cocoa's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.