Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Onboarding funnel events cannot be correlated into a single run

未关闭
#1,048 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
55/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
冷清
技术栈
typescript
领域
analytics, cli

调研方向

从 issue 中描述的 CLI 入口路径和 worker 启动开始,然后跟踪现有 telemetry 事件信封在每个 thread 中的创建方式。完成意味着一次启动中的每个已列出的 onboarding 和 gateway-auth 事件,在两个 telemetry 模块实例之间都携带相同的非持久化标识符;验证现有的 telemetry 流程,并在属于范围的情况下验证 machine-id 创建时的竞争条件。

由索引模型根据 Issue 内容生成。

描述

enhancement onboarding

Problem

Onboarding telemetry events cannot be correlated into a single user's funnel, because the events that make up one first run are emitted from two different threads at times when no common identifier exists.

altimate-code tui runs the TUI on the process main thread and the HTTP server in a worker. Each loads its own instance of the telemetry module. The first-run UI events (onboarding_started, model_picker_shown, provider_selected, the Big Pickle pair, onboarding_completed, the scan-gate pair) and the gateway auth events all fire before any chat session exists, so they stamp an empty session_id and land under the synthetic startup session. The activation events (activation_menu_shown, activation_job_selected, first_job_completed, first_prompt_sent) fire later from a real session and carry its real id.

The result: the top of the funnel and the bottom of the funnel share no key.

There is a fallback identifier — machine_id, a random UUID at ~/.altimate/machine-id — but it is unreliable for exactly this case. On a genuinely new install both threads can observe the file missing and independently create it, so a single first run can emit two different machine_id values. (That race is worth fixing regardless, and is cheap: create the file exclusively and re-read on collision.)

Impact

Countable today: impressions, choices, gateway auth outcomes, scan/skip splits, sample setup invocations — anything that is a simple tally of one event type.

Not answerable today:

  • End-to-end conversion. "How many people who saw the picker ended up connected?" requires linking a model_picker_shown to an onboarding_completed.
  • Per-attempt drop-off. onboarding_abandoned carries a last_stage, but it cannot be tied to the events that led there.
  • Retry behaviour. A user who fails gateway auth and succeeds on the second attempt is indistinguishable from two users.
  • time_to_connect_ms attribution when a user retries.

In other words: the events are individually correct, but the funnel is not reconstructable, which is the main thing the taxonomy exists for.

Proposal

Generate one random id per process launch and stamp it on every onboarding event, from both threads.

  • Generated once in the CLI entry path, before either thread emits.
  • Passed to the worker at startup so both telemetry module instances use the same value.
  • Not persisted, not derived from anything about the machine or user, and not reused across launches. It carries no identifying information — it exists only to group events that belong to the same run.

A launch is the right grain here: onboarding state already resets on every process start by design, so "one launch" and "one onboarding attempt" are the same thing in practice.

Alternatives considered

  • Reuse machine_id. Groups a machine, not an attempt, so retries and repeat launches collapse together. Also affected by the creation race above.
  • Reuse session_id. Does not exist for most of the funnel, which is the original problem.
  • Fix attribution after the fact by joining on timestamp proximity. Fragile, and impossible to do correctly for concurrent instances on the same machine.

Notes

This does not require a new sink, endpoint, or storage. It is one value threaded through the existing event envelope.

主要语言
TypeScript
星标
813
派生
134
平均合并
2 天 2 小时
30 天内合并 PR
67

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

AltimateAI/altimate-code 的其他 Issue

查看 AltimateAI/altimate-code 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。