macOS 应用接入¶
观测云应用监测能够通过收集各个 macOS 应用的指标数据,以可视化的方式分析各个 macOS 应用端的性能。
阅读路径¶
- 首次接入:先选择接入方式;手动接入可参考快速开始
- 完整接入:继续阅读本文
- 初始化参数:查看 SDK 初始化、RUM 配置、Log 配置、Trace 配置
- 自定义能力:查看 自定义标签使用、数据采集自定义规则
- 数据模型:查看 应用数据采集
- 问题排查:查看 故障排查
前置条件¶
注意
若已开通 RUM Headless 服务,前置条件已自动配置,可直接接入应用。
使用本地环境部署时,需完成以下数据接收端配置;使用公网 DataWay 时无需自行部署 DataKit。
应用接入¶
- 进入用户访问监测 > 新建应用 > macOS;
- 输入应用名称;
- 输入应用 ID;
- 在「选择接入方式」中选择 Agent 自动接入或手动接入,再完成「接入配置」。
选择接入方式¶
在应用配置页面选择「Agent 自动接入」或「手动接入」,再完成「接入配置」。已有应用可直接进入配置页面继续接入。
| 接入方式 | 适用场景 | 操作入口 |
|---|---|---|
| Agent 自动接入 | 希望由编程助手分析项目并完成 SDK 接入 | 复制控制台生成的提示词,在应用代码仓库中交给编程助手执行 |
| 手动接入 | 希望自行安装 SDK 并配置参数 | 确认数据上报方式,再按本文和快速开始完成配置 |
Agent 自动接入¶
- 在当前应用的配置页面选择「Agent 自动接入」。
- 复制「接入配置」中的完整提示词,确保使用当前应用的接入信息。
- 在应用代码仓库中打开编程助手,粘贴提示词,由 Agent 按接入指引分析项目并完成 SDK 配置。
- 构建并运行应用,触发页面访问等操作,在当前应用的查看器中确认收到数据。
若页面提示个人 API Key 或临时授权码未就绪,请按提示补齐后重新复制提示词。
手动接入¶
在应用配置页面选择「手动接入」,确认数据上报方式:
- 公网 DataWay:直接接收 RUM 数据,无需安装 DataKit 采集器。
- 本地环境部署:满足前置条件后接收 RUM 数据。
按下文安装和快速开始完成 SDK 安装、初始化与验证。已有 SDK 配置时,应先核对并复用,避免重复初始化。
安装¶
源码地址:https://github.com/GuanceCloud/datakit-macos
Demo:https://github.com/GuanceCloud/datakit-macos/Example
1.配置 Podfile 文件。
2.在 Podfile 目录下执行 pod install 安装 SDK。
1.选中 PROJECT -> Package Dependency ,点击 Packages 栏目下的 +。
2.在弹出的页面的搜索框中输入 https://github.com/GuanceCloud/datakit-macos,这是代码的存储位置。
3.Xcode 获取软件包成功后,会展示 SDK 的配置页。
Dependency Rule :建议选择 Up to Next Major Version 。
Add To Project :选择支持的工程。
填好配置后点击 Add Package 按钮,等待加载完成。
4.在弹窗 Choose Package Products for datakit-macos 中选择需要添加 SDK 的 Target,点击 Add Package 按钮,此时 SDK 已经添加成功。
如果您的项目由 SPM 管理,将 FTMacOSSDK 添加为依赖项,添加 dependencies 到 Package.swift。
```swift dependencies: [
.package(url: "https://github.com/GuanceCloud/datakit-macos.git", .upToNextMajor(from: "[latest_version]")) ] ```
添加头文件¶
详细配置入口¶
高级场景¶
常见问题¶
关于崩溃日志分析¶
崩溃日志分析和 dSYM 说明请查看 故障排查。
出现 Include of non-modular header inside framework module 报错¶
因为 SDK 的 .h 文件中引⼊了依赖库的 .h 文件,所以需要设置
Target -> Build Settings -> CLANG_ALLOW_NON_MODULAR_INCLUDES_IN_FRAMEWORK_MODULES 设置为 YES.