基础配置 API_移动研发平台(EMAS)-阿里云帮助中心

本文档介绍移动监控 Unity SDK 提供的基础 API，包括启动 SDK 、更新用户ID和昵称、设置自定义维度、调整日志级别。

1. 启动SDK

使用配置选项ApmOptions启动 SDK。

接口定义

namespace Alicloud.Apm
{
  public sealed class Apm
  {
    public static void Start(ApmOptions options) {}
  }
}

ApmOptions参数说明

参数	类型	是否必填	说明
AppKey	string	是	应用监控服务的 appKey
AppSecret	string	是	应用监控服务的 appSecret
AppRsaSecret	string	是	应用监控服务的 appRsaSecret
SdkComponents	enum	是	应用监控 SDK加载的业务组件崩溃分析：SDKComponents.CrashAnalysis
UserId	string	否	用户ID，建议保持唯一，字符串最大长度不超过128
UserNick	string	否	用户昵称，字符串最大长度不超过128
Channel	string	否	渠道标识

代码示例

using Alicloud.Apm;

// 以下是代码示例
var options = new ApmOptions("Your AppKey", "Your AppSecret", "Your AppRsaSecret")
{
  // 可选配置项
  UserId = "Your UserId",
  UserNick = "Your UserNick",
  Channel = "Your Channel",
  SdkComponents = SDKComponents.CrashAnalysis // 默认设置
};

Apm.Start(options);

2. 获取 Apm 启动状态

接口定义

namespace Alicloud.Apm
{
  public sealed class Apm
  {
    public static bool IsStarted() {}
  }
}

代码示例

using Alicloud.Apm;

// 以下是代码示例
bool apmStarted = Apm.IsStarted();

3. 设置用户ID

接口定义

namespace Alicloud.Apm
{
  public sealed class Apm
  {
     public static void SetUserId(string userId) {}
  }
}

参数说明

参数	类型	是否必填	说明
userId	string	是	用户ID，字符串最大长度不超过128

代码示例

using Alicloud.Apm;

// 以下是代码示例
Apm.SetUserId("Your UserId");

4. 设置用户昵称

接口定义

namespace Alicloud.Apm
{
  public sealed class Apm
  {
     public static void SetUserNick(string userNick) {}
  }
}

参数说明

参数	类型	是否必填	说明
userNick	string	是	用户昵称，字符串最大长度不超过128

代码示例

using Alicloud.Apm;

// 以下是代码示例
Apm.SetUserNick("Your UserNick");

5. 自定义维度

通过以下接口可以自定义维度，SDK最多记录64个自定义维度。

接口定义

namespace Alicloud.Apm
{
  public sealed class Apm
  {
    public static void SetCustomKeyValue(string key, object value) {}
    public static void SetCustomKeysAndValues(IDictionary<string, object> keysAndValues) {}
  }
}

自定义维度参数说明

参数	类型	是否必填	长度范围	说明
key	string	是	1~128	自定义维度的键
value	object	是	1~128	自定义维度的值，转换为字符串

代码示例

using Alicloud.Apm;

// 以下是代码示例
Apm.SetCustomKeyValue("level", 1);

var map = new Dictionary<string, object>
{
    { "hp", 100 },
    { "scene", "field" },
    { "hasBuff", true }
};
Apm.SetCustomKeysAndValues(map);

5. 设置 SDK 日志级别

接口定义

namespace Alicloud.Apm
{
  public static class ApmConfiguration
  {
    public static ApmLoggerLevel LoggerLevel {}
    
    public enum ApmLoggerLevel : int
    {
        Error = 3,
        Warning = 4,
        Notice = 5,
        Info = 6,
        Debug = 7
    }
  }
}

自定义维度参数说明

参数

类型

是否必填

说明

LoggerLevel

enum

是

SDK 日志打印级别，默认是Notice级别

Error : 错误级别
Warning : 警告级别
Notice : 通知级别
Info : 信息级别
Debug : 调试级别

代码示例

using Alicloud.Apm;

// 以下是代码示例
ApmConfiguration.LoggerLevel = ApmLoggerLevel.Debug;