@hanzogui/遥测
任何汉佐地表的零配置遥测——网络,桌面和原生.
如果你挂载 <GuiProvider> 从 @hanzo/gui你已经有了它. 有一个
不安装、导入或接线:页面视图、未处理错误、反应渲染
错误和交互捕捉到达一个半藏端点,与产品
从运行时间和从环境读取的摄入密钥中解析出名称.
import { GuiProvider } from '@hanzo/gui'
<GuiProvider config={config}>{children}</GuiProvider> // telemetry included
<GuiProvider config={config} telemetry={false}>… // opt out
<GuiProvider config={config} telemetry={{ product: 'studio' }}>…
只有当你不是Gui应用程序时,或者当你需要开车时,才能自己挂上 路由器的页面视图 :
import { TelemetryProvider } from '@hanzogui/telemetry'
export default function Root({ children }) {
return <TelemetryProvider path={usePathname()}>{children}</TelemetryProvider>
}
也可以从组件层获得,因为 @hanzo/ui/telemetry,哪个
重新导出此软件包时, 无需修改 。 所以一个已经依赖于
@hanzo/ui 没有增加什么.
一道溪流,两道溪流
GuiProvider 挂载 <TelemetryProvider owner="gui">,这种姿态是
每一个应用都安全启动: 贵州自有供应商
只有在没有其他收藏时才收集.
| 应用程序挂载 | 何处 | 阿贵做什么 |
|---|---|---|
| 无 | —— 说 | 收集——这是免费案例 |
<AnalyticsProvider> 编号 : <TelemetryProvider> | 上文 GuiProvider | 然后把应用程序的客户端直接通过 |
<TelemetryProvider> | 下级 GuiProvider | 读取惰性; 应用程序拥有流 |
秒数 <GuiProvider> | 任何地方 | 一个客户端, 一个流 |
所有权是模块镜槽上的权利要求,不是渲染时间猜想,所以
幸存后山(一条懒行道取出溪口)和出山(取出溪口)
回来. owner="app" 是供货商的默认情况,您会自动挂载自己,并且总是
赢了.
一个形状的Gui看不见 是一个生的 @hanzo/event <AnalyticsProvider>
下级 GuiProvider:反应上下文不向下看,与
<TelemetryProvider> 生的一无所有。 这些应用程序通过
telemetry={false} 直到他们放弃了自己的线路.
一个端口 三道镜头
一切——网页视图,产品事件,例外,互动捕捉——是 作为分批流到 一个 汉佐端点 :
POST https://api.hanzo.ai/v1/event { batch: [Event, …] }
云镜将单流分入三个视图:
| 镜头 | 东道主 | 显示什么 |
|---|---|---|
| 错误 | sentry.hanzo.ai | 例外、 堆栈、 会话抓取 |
| 网络分析 | analytics.hanzo.ai | 页面视图、裁判、活动 |
| 产品见解 | insights.hanzo.ai | 漏斗,笔记本, analytics_errors |
洞察力也出错 所以漏斗滴会加入这个例外 这个 这三位主持人是 仪表板。它们从来不是摄入的终点: 正是一个 API 主机, 这就是为什么没有任何配置.
你免费得到的
- 页面视图,包括SPA路由更改. 过
path(下一个:usePathname()(中文(简体) ) 要从你的路由器中驱动它们, 或通过什么 和历史API驱动它们. - 错误 —— 说
window.onerror,无处理的拒绝, 和反应产生错误. 这是@sentry替换; 没有浏览器 SDK 和 CDN 脚本,所以default-src 'none'CSP无法突破. - 会话抓取 ——每次点击/输入/投递都附加了语义说明
等级 (
navigation/Dashboard/UserCard/button[save]),所以重播为 可读取而不是像素电影. 装入了动态import()在一个 空闲的回调,在自己的块, 所以它永远不会花费LCP. - 一触即发 和组别
channel, (中文(简体) ),refCode, (中文(简体) ),signupWeek(中文(简体) ) 每一事件. - 产品推论 从主机名 -
console.hanzo.ai报告为:console, (中文(简体) ),hanzo.chat作为chat, (中文(简体) ),hanzo.ai作为site。 。 。 .
隐私
-
Do-not-Track和Global 隐私控制被默认遵守. 与 要么是信号集,要么是没有明确的应用选择,任何信息都无法收集 什么也没有写到存储.
-
发觉同意. 一个人在你的UI中做出明确的选择,比 浏览器双向默认 :
import { setConsent, useConsent } from '@hanzogui/telemetry' const choice = useConsent() // 'granted' | 'denied' | undefined setConsent('denied') // takes effect immediately, everywhere setConsent('unset') // forget it; DNT/GPC applies again退取为前想:一时收取停止. 已经缓冲的事件 在得到现场同意的情况下,可以完成飞行冲洗.
-
输入值被扣 从默认抓取.
data-hz-private在任意 元素不包括整个子树.
别的地方
非反应代码不需要提供者——环境客户端自建 从环境开始使用,供应商登记自己的客户 进入同一个槽,所以有 一种实例和一流的方式.
import { track, identify, captureError, EVENTS } from '@hanzogui/telemetry'
identify(user.id)
track(EVENTS.PLAN_CLICKED, { plan: 'pro' })
try {
risky()
} catch (err) {
captureError(err, { properties: { where: 'checkout' } })
}
组件
import { useTelemetry, useTrack } from '@hanzogui/telemetry'
const t = useTelemetry() // total: never null, never throws, SSR-safe
const track = useTrack() // just the recorder
配置( 全部可选)
环境,从 process.env (下个), import.meta.env (vit/Expo),或 a (中文(简体) )
window.__HANZO_TELEMETRY__ 没有构建步骤的页面对象 :
| 变量 | 默认 | 含义 |
|---|---|---|
NEXT_PUBLIC_PUBLISHABLE_KEY 编号 : VITE_PUBLISHABLE_KEY 编号 : EXPO_PUBLIC_PUBLISHABLE_KEY | —— 说 | 可出版 pk-… 键 - 一个名字KMS搭载的那个 deploy/PUBLISHABLE_KEY 和一个 @hanzo/event 读取。 只有写,而且安全 没有它,信标是无属性的,边缘拒绝它。 (老年人) …_HANZO_INGEST_KEY 拼写仍然读取,第二并正在被退役. ) |
NEXT_PUBLIC_HANZO_API_URL 编号 : VITE_HANZO_API_URL | https://api.hanzo.ai | 摄入最上主. |
NEXT_PUBLIC_HANZO_PRODUCT 编号 : VITE_HANZO_PRODUCT | 从运行时间解析, 然后是主机名 | 隐形地表。 Tauri 窗口报告为 desktop 它服务于来自三个来源的一捆货物(tauri://localhost, (中文(简体) ), http://tauri.localhost,dev服务器),所以URL是唯一不能命名它的东西. |
NEXT_PUBLIC_HANZO_TELEMETRY 编号 : VITE_HANZO_TELEMETRY | 打开 | 0编号 :false编号 :off 是一个建置时杀开关. |
道具,当你想要它们时:
<TelemetryProvider
path={usePathname()} // drive pageviews from your router
product="console" // override the inferred surface
host="" // same-origin, cookie-auth apps
getToken={() => token} // bearer-auth apps
replay={false} // no interaction capture
errors={false} // no error capture
pageviews={false} // no pageviews
consent="granted" // your own consent gate decided
enabled={false} // hard kill switch, wins over everything
fallback={(err, reset) => <Crash error={err} onReset={reset} />}
/>
没有 fallback,然后报告一个渲染错误 重新投掷 所以你们自己
仍然运行错误 。 观察不能改变行为.
保证
- 安全无虞. 导入无所事事; 服务器上的渲染无所作为 .
- 原始山地,暂时保持沉默.
GuiProvider电线遥测 完全相同,但DOM仍然是 收集:@hanzo/event是因为init()读取window.location.search财务报告和审定财务报表document.referrer后面一个typeof window校验,并且 React 本地定义window也没有。 满足本地需求 检查需要document- 一个@hanzo/event固定,不是一个gui。 在那之前,土生土长 和惰性而不是崩溃. - 失败的软. 每一个公共方法 吞下自己的错误,网络损失是 被忽略,一个失败的抓取引擎块 仅仅意味着没有抓取.
- 树可摇.
sideEffects: false无害环境管理,每起出口一次. - 没有CDN. 没有从第三方来源装货的.
组成
@hanzo/event the ONE client — batching, attribution, the wire, the endpoint
@hanzo/observe the capture engine — semantics, redaction, playback stream
@hanzogui/telemetry ← this: the zero-config policy that wires them together
@hanzo/ui/telemetry re-export, so the component layer needs no new dependency
机制生活在下面,政策生活在这里,每个机制都有一个.