Skip to Content
快速开始概览

快速开始

每端 SDK 的接入都遵循同样的三步:拿 DSN → 初始化 → 上报。挑你的平台开始。

DSN:所有 SDK 的统一凭据

接入任何 Argus SDK 都需要一个 DSN(Data Source Name)。它在你于 Argus Console 创建项目时 自动颁发,格式统一:

argus://<public_key>:<secret_key>@<host>[:port]/<project_id>
片段含义
public_key公钥,随上报放进 X-Argus-DSN 头,标识是哪个项目
secret_key密钥,仅用于本地 HMAC 签名,不出网
host[:port]上报端点(ingestion 网关),本地默认 localhost:4318:443 走 https
project_id数据归属的项目

本地 demo 栈固定用:argus://demo-public:demo-secret@localhost:4318/demo

统一上报协议:所有端的 SDK 共享同一份 HMAC-SHA256 签名 + 批量上报 + 离线降级队列。 日志 / 崩溃 / 性能 / 埋点 只是 channel / event_type 字段的差异,走同一条链路。签名算法跨 Go / TypeScript / Swift / Kotlin / Dart 逐字节一致(CI 用同一份 fixture 交叉校验)。

上报通道一览

API通道说明
log(...)/v1/events日志,自动记入崩溃前的 breadcrumb 环形缓冲
自动 / captureCrash(...)/v1/events(channel=crash)崩溃,按版本 + 栈顶聚合成 issue
metric(...) / counter/gauge/histogram/v1/apm性能指标,服务端按 metric_name 聚合
track(...)/v1/track埋点事件,喂漏斗 / 留存 / 分群
出站 traceparent/v1/traces端到端 Trace span,详见 Trace 指南

接入后在哪看数据

  • Console:日志在 /logs、崩溃 issue 在 /issues、性能在 /apm、Trace 瀑布图在 /traces
  • MCP / AI:在 Claude / Cursor 里用自然语言查,详见 MCP 接入

本文档的每个 quickstart 都基于仓库 examples/ 下的真实可运行示例。页面里的代码片段与示例工程保持一致。