iOS SDK 基础设置接口 - 启动SDK、调整日志级别、获取SDK版本-阿里云帮助中心

本文档介绍 iOS SDK 提供的基础 API 接口，包括启动SDK、获取 SDK 版本号、调整日志级别。

1. 启动SDK

使用配置选项options启动 SDK。

接口定义

+ (void)startWithOptions:(EAPMOptions *)options;

EAPMOptions参数说明

参数	类型	是否必填	说明

参数	类型	是否必填	说明
appKey	NSString	是	应用监控服务的 appKey
appSecret	NSString	是	应用监控服务的 appSecret
sdkComponents	NSArray<Class< EAPMSDKComponent>>	是	应用监控 SDK加载的业务组件崩溃分析：[EAPMCrashAnalysis class]
userId	NSString	否	用户ID，建议保持唯一，字符串最大长度不超过128
userNick	NSString	否	用户昵称，字符串最大长度不超过128
channel	NSString	否	渠道标识

代码示例

Object C

        
#import "AlicloudApmCore/AlicloudApmCore.h"
#import "AlicloudApmCrashAnalysis/AlicloudApmCrashAnalysis.h"

EAPMOptions *options = [[EAPMOptions alloc] initWithAppKey:@"您的AppKey"
                                                 appSecret:@"您的AppSecret"
                                             sdkComponents:@[[EAPMCrashAnalysis class]]];
options.userId = @"userId";
options.userNick = @"userNick";
options.channel = @"channel";

[EAPMApm startWithOptions:options];

2. 更新用户ID和昵称

使用配置选项options启动 SDK。

接口定义

- (void)setUserId:(NSString *)userId;
- (void)setUserNick:(NSString *)userNick;

参数说明

参数	类型	是否必填	说明

参数	类型	是否必填	说明
userId	NSString	是	用户ID，建议保持唯一，字符串最大长度不超过128
userNick	NSString	是	用户昵称，字符串最大长度不超过128

代码示例

Object C

        
#import "AlicloudApmCore/AlicloudApmCore.h"

[[EAPMApm defaultApm] setUserId:@"userId"];
[[EAPMApm defaultApm] setUserNick:@"userNick"];

3. 获取SDK版本号

通过以下 API 获取 SDK 的版本号

接口定义

NSString *EAPMVersion(void);

代码示例

Object C

        
#import "AlicloudApmCore/AlicloudApmCore.h"

NSString *apmVersion = EAPMVersion();

4. 调整SDK日志级别

设置或者获取SDK日志级别，默认日志打印级别是信息级别EAPMLoggerLevelInfo。

接口定义

/**
 * 设置EAPM SDK日志级别
 *
 * @param loggerLevel 日志级别，默认级别是EAPMLoggerLevelNotice.
 */
- (void)setLoggerLevel:(EAPMLoggerLevel)loggerLevel;

/**
 * 返回EAPM日志级别
 */
- (EAPMLoggerLevel)loggerLevel;

EAPMLoggerLevel枚举说明

参数	说明

参数	说明
EAPMLoggerLevelError	错误级别，表示严重的错误信息。
EAPMLoggerLevelWarning	警告级别，表示潜在的问题或异常情况。
EAPMLoggerLevelNotice	通知级别，表示正常的但值得注意的事件。
EAPMLoggerLevelInfo	信息级别，表示一般性的运行信息。
EAPMLoggerLevelDebug	调试级别，表示详细的调试信息，主要用于开发阶段排查问题。

代码示例

Object C

        
#import "AlicloudApmCore/AlicloudApmCore.h"

// 设置日志级别
[EAPMConfiguration.sharedInstance setLoggerLevel:EAPMLoggerLevelDebug];

// 获取日志级别
EAPMLoggerLevel loggerLevel = [EAPMConfiguration.sharedInstance loggerLevel];