性能监控

性能监控目前可以采集Windows和Mac的CPU和内存信息。

前提条件

初始化Parfait SDK。持有初始化成功的parfait_wrapper_ptr指针。具体请参见接入说明。

主进程接入性能监控

步骤一：开启上报

业务需要调用Upload()显示开启性能监控数据的周期上传。一旦开启，Parfait将根据report_interval的数值定期上传数据，直至Parfait SDK退出。

/**
 * 触发自定义事件/自定义日志/性能监控数据的自动间隔循环上传
 **/
void ParfaitWrapperBase::Upload();

示例代码：
parfait_wrapper_ptr->Upload();

步骤二：设置场景

根据业务选择是否设置场景信息。调用后性能数据会带上该场景tag，可用于在平台上筛选不同场景的数据。

/**
 * 设置场景，可随时调用该接口
 * @param scene 场景信息
 */
void ParfaitWrapperBase::SetPerformanceScene(const char* scene);

示例代码：
// 1.初始化SDK
// 2.当前场景为刚启动，设置场景为launch
parfait_wrapper_ptr->SetPerformanceScene("launch");
// 3.应用启动完成，进入running状态
parfait_wrapper_ptr->SetPerformanceScene("running");

步骤三：设置采集频率

创建性能监控的config，用于设置各类数据的采集频率。

struct PerformanceConfig {
  int collect_interval_s = 5;  //collect_interval_s为采集间隔时间
  int aggregate_interval_s = 5;   //aggregate_interval_s为聚合间隔时间
  RECORD_INTERVAL upload_interval_s = INTERVAL_30;  //upload_interval_s为数据上报时间
};

parfait::PerformanceConfig config = {10, 10, parfait::INTERVAL_30};

假设开启了内存监控，采集频率的配置是collect_interval_s为10s，aggregate_interval_s为30s，upload_interval_s为INTERVAL_30。那么PC端性能监控表现为：

• 每隔10s采集一次内存监控值
• 每隔30s聚合前3次内存监控值，取3次的平均值为最终结果
• 每隔30s上报一次最终结果

步骤四：开启CPU监控

采集指标

API

#include "ParfaitWrapperBase.h"
/**
 * 启动本进程cpu性能监控。如果win下需要监控其他进程，请使用带pid的方法
 * mac只能调用此方法，即只能监控本进程
 * @param config 性能监控config
 */
void ParfaitWrapperBase::StartCPUMonitor(const PerformanceConfig& config);

/**
 * 启动cpu性能监控，mac调用此方法不生效
 * @param config 性能监控config
 * @param pid 进程pid
 * @param process_name pid所绑定的进程标识，对应apmplus平台上的进程名
 */
void ParfaitWrapperBase::StartCPUMonitor(const PerformanceConfig& config,
                                         int pid, 
                                         const char* process_name);

示例代码：
// 开启本进程的CPU监控
parfait::PerformanceConfig config = {10, 10, parfait::INTERVAL_30};
parfait_wrapper_ptr->StartCPUMonitor(config)；

步骤五：开启内存监控

采集指标

API

#include "ParfaitWrapperBase.h"
/**
 * 启动本进程cpu性能监控。如果win下需要监控其他进程，请使用带pid的方法
 * mac只能调用此方法，即只能监控本进程
 * @param config 性能监控config
 */
void StartMemoryMonitor(const PerformanceConfig& config);

/**
 * 启动内存性能监控，mac调用此方法不生效
 * @param config 性能监控config
 * @param pid 进程pid。windows和Linux支持pid非本进程，mac调用此方法不生效
 * @param process_name pid所绑定的进程标识，也是slardar上所展示时使用的标识
 */
void ParfaitWrapperBase::StartMemoryMonitor(const PerformanceConfig& config,
                                             int pid, 
                                             const char* process_name);

示例代码：
// 开启本进程的CPU监控
parfait::PerformanceConfig config = {10, 10, parfait::INTERVAL_30};
parfait_wrapper_ptr->StartMemoryMonitor(config)；

步骤六：查询消费

查询数据，请参见自定义看板。

多进程接入性能监控

Windows

Mac