ai-otel-setup 1.0.8 → 1.0.10

package/LICENSE

@@ -1,20 +1,21 @@
-Proprietary License - iFlyTek BG Internal
+MIT License
 
-Copyright (c) 2026 iFlyTek BG Productivity. All rights reserved.
+Copyright (c) 2026 decent-yu
 
-The source code in this repository is visible publicly to enable installation
-via `npx github:decent-yu/cc-otel-setup` from corporate machines. Visibility
-does NOT grant any license to use, modify, distribute, or sublicense the code
-outside of authorized iFlyTek internal contexts.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-Permitted use:
-  - Running the installer (`npx -y github:decent-yu/cc-otel-setup ...`)
-    on machines authorized to send observability data to iFlyTek-internal
-    OTel collectors.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-Prohibited without prior written permission:
-  - Copying, forking, vendoring the source for non-iFlyTek deployments
-  - Republishing under a different name or marketplace
-  - Embedding the code in third-party products
-
-For licensing questions: productivity@iflytek.example
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/cli.js

@@ -28,43 +28,39 @@ const { execFileSync } = require("child_process");
 
 const PKG_VERSION = require("./package.json").version;
 
-// Windows 8.3 短路径：把 "C:\Program Files\nodejs\node.exe" 这种带空格的长路径
-// 转成 "C:\Progra~1\nodejs\node.exe" 形式。**必要性**：codex 在 Windows 下走
-// PowerShell 解析 hooks command，PS 把外层引号脱掉之后会按空白拆 token，导致
-// "C:\Program Files\..." 被切成 "C:\Program" + "Files\..."，hook 进程起不来，
-// exit code 1。用 8.3 短路径就根本没空格，cmd.exe 和 PowerShell 都能正确解析。
-// 拿不到短路径（NTFS 卷禁用了 8.3 名）就回退原路径——比起死掉，至少 cmd.exe 还能跑。
-function toWindowsShortPath(p) {
-  if (process.platform !== "win32" || !p) return p;
-  try {
-    const out = execFileSync(
-      "cmd.exe",
-      ["/c", `for %A in ("${p}") do @echo %~sA`],
-      { encoding: "utf8", windowsHide: true, timeout: 3000 },
-    );
-    const short = out.trim();
-    if (short && short.length > 0) return short;
-  } catch (_) {
-    /* 卷禁用了 8.3 / cmd.exe 不可用：吞掉，回退原路径 */
-  }
-  return p;
-}
-
-// 安装时这台机器的 node 绝对路径，给 hook 命令做兜底（见 buildHookCommand）。
-// Windows 上立刻转 8.3 短路径，规避 PowerShell 解析空格切 token 的问题。
-const NODE_BIN = toWindowsShortPath(process.execPath);
+// 安装时这台机器的 node 绝对路径，POSIX 上拿来构造 hook command 用。
+// Windows 上不再写 node 绝对路径（见 buildHookCommand 注释）。
+const NODE_BIN = process.execPath;
 
-// 跨平台 hook 命令：固定形式 `<NODE_BIN> <launcher> <hook>`，三段都是绝对路径。
-// 三段均做 8.3 短路径转换（仅 Windows 生效，POSIX 直接透传）：node 在 Program Files、
-// 或者用户名/目录里有空格（如 "C:\Users\张 三\.codex\..."）都靠这步消歧义。
-// "PATH 上 node 优先 → 否则用 baked 绝对路径" 的兜底逻辑放在 launch-hook.js 里做，
-// 不再依赖 shell `||` 操作符——PS 5.1 不支持 `||`，cc/gemini 在 Windows 上默认就
-// 是 PS，会被坑。
+// 跨平台 hook 命令构造。
+//
+// **Windows 上的关键决策（v1.0.9 重构）**：不再写 node 绝对路径，也不再加引号，
+// 让 shell 自己按空白 split + 用 PATH lookup node。原因：
+//   - 写绝对路径如 "C:\Program Files\nodejs\node.exe"，PowerShell 5.1（cc/gemini
+//     在 Windows 默认 shell）解析时会把外层引号脱掉，按空白把 "C:\Program" 切成
+//     一个 token，"Files\nodejs\..." 切成另一个，hook 进程起不来，exit code 1。
+//   - 用 8.3 短路径 (C:\Progra~1\...) 在 NTFS 8dot3name 禁用的卷上失效，
+//     更糟的是 cmd /c for 在某些 locale 下输出会带额外引号，被 installer
+//     二次拼装成 ""\"C:\\\"C:\\Program Files\\nodejs\\node.exe\\\"\"" 这种
+//     非法嵌套，比原 bug 更难修。
+//   - 改写 wrapper .cmd / .sh 让用户用别的 shell 接管 → 整体复杂度+30 行，
+//     而且 wrapper 路径本身仍可能带空格，治标不治本。
+//
+// 务实最稳的解：让 shell 自己 PATH 找 node，命令字符串本身不含空格路径段。
+// 假设 ~/.codex/ai-otel/ 这条路径不含空格（取决于用户名）：
+//   - 99% 用户名是 ASCII 无空格 → 完美工作
+//   - 用户名带空格的极少数（如 "John Smith"）→ 文档化处理（见
+//     docs/codex-windows-troubleshooting.md "用户名含空格" 一节）
+//
+// launch-hook.js 内部还会再做一次 PATH 上探 node、失败时 fallback baked
+// execPath 的兜底，所以 PATH 上 node 临时失踪也能起来。
+//
+// POSIX：保持 quoted 三段格式，shell 行为统一，路径有空格也安全。
 function buildHookCommand(launcherPath, scriptPath) {
-  const node = NODE_BIN;
-  const launcher = toWindowsShortPath(launcherPath);
-  const script = toWindowsShortPath(scriptPath);
-  return `"${node}" "${launcher}" "${script}"`;
+  if (process.platform === "win32") {
+    return `node ${launcherPath} ${scriptPath}`;
+  }
+  return `"${NODE_BIN}" "${launcherPath}" "${scriptPath}"`;
 }
 
 // 把 launcher 模板拷到 hook 同目录，返回 launcher 的绝对路径
@@ -191,25 +187,19 @@ function readGlobalGitUser() {
   };
 }
 
-// ---------- 装机上报到 cc-view-server ----------
+// ---------- 装机上报：走同一条 OTel 管线 ----------
+//
+// 历史：原 POST 到 cc-view-server :8081/api/installer/report 直写 Doris。
+// otel-prod 部署到公网、cc-view-web 留在内网后，installer 只能跟 OTel collector
+// 说话；改成发一条 OTLP/HTTP log（event.name = installer_register），由 forwarder
+// 走同一条管线落到 iData，cc-view-server 端从事件表 reduce 出装机记录。
+// 这样 installer 命令依旧只暴露一个 url，跟数据上报完全同源。
 //
-// 安装完成时打一发 POST 到 cc-view-server，让运营侧能看到"谁/在哪台机/装了哪个版本"。
 // 设计原则：
-//   - fire-and-forget：3s 超时、不重试、任何失败绝不让安装本身退出非 0
-//   - 复用用户传给 OTel collector 的 host：172.31.250.57，port 8081 写死
-//   - URL 本身是公司内网地址，自带隐式凭据，不带 SSO header
+//   - fire-and-forget：2.5s 超时、不重试、任何失败绝不让安装本身退出非 0
+//   - 复用 logsEndpointFromGrpc：4317 → 4318，path 自动补 /v1/logs
 //   - debug 模式下才打错误，正常运行不污染 stdout
 
-function buildReportUrl(otelEndpoint) {
-  try {
-    const u = new URL(otelEndpoint);
-    // cc-view-server 跑在同机 :8081（与 collector 4317/4318 同主机）
-    return `http://${u.hostname}:8081/api/installer/report`;
-  } catch (_) {
-    return null;
-  }
-}
-
 function postJsonWithTimeout(targetUrl, payload, timeoutMs) {
   return new Promise((resolve, reject) => {
     let u;
@@ -254,24 +244,56 @@ async function reportInstall(otelEndpoint, gitUser, allResults, debug) {
     if (debug) console.error("[ai-otel-setup] 跳过装机上报：无 git user.email");
     return;
   }
-  const reportUrl = buildReportUrl(otelEndpoint);
-  if (!reportUrl) return;
+  const logsUrl = logsEndpointFromGrpc(otelEndpoint);
+  if (!logsUrl) return;
   const findOk = (tool) =>
     allResults.find((r) => r.tool === tool)?.status === "installed";
+
+  // OTLP/HTTP log record。translator (lib/translate/installer_register.js) 按
+  // event.name = "installer_register" 路由到对应 eid，把 git.user.* / hostname
+  // 经 contextBlocksFromAttrs 落进 user 块，installer_* / os_* / node_version /
+  // *_cli_detected 走 phase1UdmapFields 白名单进 udmap。
+  const sessionId = `installer-${Date.now()}-${Math.random().toString(36).slice(2, 10)}`;
+  const attrs = {
+    "tool_kind": "installer",
+    "event.name": "installer_register",
+    "event.timestamp": new Date().toISOString(),
+    "session.id": sessionId,
+    "git.user.email": gitUser.email,
+    "git.user.name": gitUser.name || "",
+    "hostname": os.hostname() || "",
+    "installer_version": PKG_VERSION,
+    "os_platform": os.platform(),
+    "os_arch": os.arch(),
+    "node_version": process.version,
+    "cc_cli_detected": findOk("claude") ? "1" : "0",
+    "codex_cli_detected": findOk("codex") ? "1" : "0",
+  };
   const payload = {
-    git_email: gitUser.email,
-    git_name: gitUser.name || "",
-    hostname: os.hostname(),
-    installer_version: PKG_VERSION,
-    os_platform: os.platform(),
-    os_arch: os.arch(),
-    node_version: process.version,
-    cc_cli_detected: findOk("claude") ? 1 : 0,
-    codex_cli_detected: findOk("codex") ? 1 : 0,
+    resourceLogs: [
+      {
+        resource: { attributes: [] },
+        scopeLogs: [
+          {
+            logRecords: [
+              {
+                timeUnixNano: `${Date.now()}000000`,
+                body: { stringValue: "installer_register" },
+                attributes: Object.entries(attrs).map(([k, v]) => ({
+                  key: k,
+                  value: { stringValue: String(v ?? "") },
+                })),
+              },
+            ],
+          },
+        ],
+      },
+    ],
   };
+
   try {
-    await postJsonWithTimeout(reportUrl, payload, 3000);
-    if (debug) console.error("[ai-otel-setup] 装机上报已发送");
+    await postJsonWithTimeout(logsUrl, payload, 2500);
+    if (debug) console.error("[ai-otel-setup] 装机上报已发送 →", logsUrl);
   } catch (e) {
     if (debug) {
       console.error("[ai-otel-setup] 装机上报失败（不影响安装）:", e.message || e);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai-otel-setup",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "One-shot installer for AI CLI OpenTelemetry forwarding. Writes Claude Code, Codex CLI, and Gemini CLI telemetry config in a single npx command.",
   "bin": {
     "ai-otel-setup": "cli.js",