快速开始
每端 SDK 的接入都遵循同样的三步:拿 DSN → 初始化 → 上报。挑你的平台开始。
Web(TypeScript)iOS(Swift)Android(Kotlin)Flutter(Dart)React NativeGo 后端Node 后端Python 后端Java 后端Rust 后端
DSN:所有 SDK 的统一凭据
接入任何 Argus SDK 都需要一个 DSN(Data Source Name)。它在你于 Argus Console 创建项目时 自动颁发。原生端与后端使用带密钥 DSN;浏览器 Web SDK 使用仅公钥 DSN:
# 原生端 / 后端
argus://<public_key>:<secret_key>@<host>[:port]/<project_id>
# 浏览器 Web SDK(配合服务端 Origin 白名单)
argus://<public_key>@<host>[:port]/<project_id>| 片段 | 含义 |
|---|---|
public_key | 公钥,随上报放进 X-Argus-DSN 头,标识是哪个项目 |
secret_key | 原生端 / 后端的 HMAC 密钥;绝不能写入浏览器、网页源码或公开仓库 |
host[:port] | 上报端点;loopback 本地开发使用 HTTP,远程 host 默认使用 HTTPS |
project_id | 数据归属的项目 |
本地 demo 栈固定用:argus://demo-public:demo-secret@localhost:4318/demo。
统一上报协议:日志 / 崩溃 / 性能 / 埋点以 channel / event_type 区分,走同一条事件链路。
原生端与后端使用 HMAC-SHA256;浏览器不能保守 secret,必须使用「仅公钥 + 服务端 Origin 精确
白名单」。HMAC 签名算法跨 Go / TypeScript / Swift / Kotlin / Dart 由同一份 fixture 交叉校验。
上报通道一览
| API | 通道 | 说明 |
|---|---|---|
log(...) | /v1/events | 日志,自动记入崩溃前的 breadcrumb 环形缓冲 |
自动 / captureCrash(...) | /v1/events(channel=crash) | 崩溃,按版本 + 栈顶聚合成 issue |
metric(...) / counter/gauge/histogram | /v1/events(channel=apm) | 性能指标,服务端按 metric_name 聚合 |
track(...) | /v1/events(channel=track) | 埋点事件,喂漏斗 / 留存 / 分群 |
| 出站 traceparent | /v1/events(channel=trace) | 端到端 Trace span,详见 Trace 指南 |
接入后在哪看数据
- Console:日志在
/logs、崩溃 issue 在/issues、性能在/apm、Trace 瀑布图在/traces。 - MCP / AI:在 Claude / Cursor 里用自然语言查,详见 MCP 接入。
本文档的每个 quickstart 都基于仓库 examples/
下的真实可运行示例。页面里的代码片段与示例工程保持一致。