Embrace Apple SDK 使用教程

Embrace Apple SDK 使用教程

embrace-apple-sdkThe Embrace SDK in Swift项目地址:https://gitcode.com/gh_mirrors/em/embrace-apple-sdk

1. 项目的目录结构及介绍

Embrace Apple SDK 是一个用于收集 iOS、iPadOS、tvOS、visionOS 和 watchOS 应用的可观测性数据的工具。以下是该项目的目录结构概览：

embrace-apple-sdk/
├── Examples/
│   └── BrandGame/
├── EmbraceIO/
│   ├── Core/
│   ├── Extensions/
│   ├── OpenTelemetry/
│   └── Utilities/
├── Scripts/
├── Tests/
├── README.md
├── GETTING_STARTED.md
├── LICENSE
└── CONTRIBUTING.md

• Examples/: 包含示例项目，如 BrandGame，展示如何集成和使用 Embrace SDK。
• EmbraceIO/: 核心代码目录，包含 SDK 的主要功能模块。
  • Core/: 核心功能实现。
  • Extensions/: 扩展功能模块。
  • OpenTelemetry/: 支持 OpenTelemetry 标准的相关实现。
  • Utilities/: 工具类和辅助函数。
• Scripts/: 包含项目构建和部署相关的脚本。
• Tests/: 单元测试和集成测试代码。
• README.md: 项目介绍和基本使用说明。
• GETTING_STARTED.md: 详细的使用指南和入门教程。
• LICENSE: 项目许可证（Apache-2.0）。
• CONTRIBUTING.md: 贡献指南。

2. 项目的启动文件介绍

Embrace Apple SDK 的启动文件主要涉及在应用启动时初始化和启动 SDK。以下是一个典型的启动文件示例：

import EmbraceIO

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    do {
        try Embrace.setup(options: Embrace.Options(appId: "myAppId"))
        try Embrace.client().start()
    } catch {
        // 处理启动失败的情况
    }
    return true
}

• import EmbraceIO: 导入 Embrace SDK 模块。
• Embrace.setup(options:): 初始化 Embrace SDK，传入应用的唯一标识 appId。
• Embrace.client().start(): 启动 Embrace SDK。

3. 项目的配置文件介绍

Embrace Apple SDK 的配置文件主要涉及初始化选项和一些全局配置。以下是配置文件的相关内容：

Embrace.Options

Embrace.Options 类用于配置 Embrace SDK 的初始化参数：

let options = Embrace.Options(
    appId: "myAppId",
    enableCrashReporting: true,
    enableNetworkCapture: true,
    enableBreadcrumbs: true
)

• appId: 应用的唯一标识，必须从 Embrace 控制台获取。
• enableCrashReporting: 是否启用崩溃报告功能。
• enableNetworkCapture: 是否启用网络请求捕获功能。
• enableBreadcrumbs: 是否启用自定义日志和事件记录功能。

其他配置

Embrace SDK 还支持其他一些配置选项，如用户数据和自定义属性：

Embrace.client().metadata.userEmail = "user@example.com"
Embrace.client().metadata.userIdentifier = "uniqueUserId"
Embrace.client().metadata.userName = "User Name"

• metadata.userEmail: 用户邮箱。
• metadata.userIdentifier: 用户唯一标识。
• metadata.userName: 用户名。

通过这些配置，可以更详细地记录和跟踪用户行为和应用性能。

embrace-apple-sdkThe Embrace SDK in Swift项目地址:https://gitcode.com/gh_mirrors/em/embrace-apple-sdk