ai-otel-setup 1.0.6 → 1.0.8

package/cli.js

@@ -24,19 +24,47 @@
 const fs = require("fs");
 const path = require("path");
 const os = require("os");
+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）。
-const NODE_BIN = process.execPath;
+// Windows 上立刻转 8.3 短路径，规避 PowerShell 解析空格切 token 的问题。
+const NODE_BIN = toWindowsShortPath(process.execPath);
 
-// 跨平台 hook 命令：固定形式 `<NODE_BIN> <launcher> <hook>`，三段都是绝对路径，
-// 对 shell 完全透明（POSIX sh / cmd.exe / PowerShell 5.1+ / PowerShell 7+ 全 cover）。
+// 跨平台 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，会被坑。
 function buildHookCommand(launcherPath, scriptPath) {
-  return `"${NODE_BIN}" "${launcherPath}" "${scriptPath}"`;
+  const node = NODE_BIN;
+  const launcher = toWindowsShortPath(launcherPath);
+  const script = toWindowsShortPath(scriptPath);
+  return `"${node}" "${launcher}" "${script}"`;
 }
 
 // 把 launcher 模板拷到 hook 同目录，返回 launcher 的绝对路径
@@ -131,6 +159,164 @@ function mergeNoProxy(existing, host) {
   return list.join(",");
 }
 
+// ---------- git config 兜底 (跨平台) ----------
+//
+// hook 进程偶有"压根没跑"的场景（网络/超时/进程崩溃），导致 git.user.email/name 永久丢失。
+// 装机时把全局 git config 写到 OTEL_RESOURCE_ATTRIBUTES，CC SDK 自动把 resource attr
+// 带到每条 metric/log，service 端在 SessionStore miss 时用它兜底（参见 translator.js
+// 的 RESOURCE_FALLBACK_KEYS）。
+//
+// 跨平台细节：
+//   - execFileSync(cmd, args)：不经过 shell，Win/Mac 行为一致
+//   - windowsHide:true：Windows 上不弹 cmd 黑窗
+//   - stdio[2]="ignore"：屏蔽 stderr，避免 git 报错刷屏
+//   - timeout:1000：超时直接当成"读不到"，不让 installer 卡住
+//   - ENOENT (git 没装) / 退出码非 0 (key 没设) 都吞掉返回空串
+function readGlobalGitUser() {
+  function readGitVal(key) {
+    try {
+      return execFileSync("git", ["config", "--global", "--get", key], {
+        encoding: "utf8",
+        windowsHide: true,
+        timeout: 1000,
+        stdio: ["ignore", "pipe", "ignore"],
+      }).trim();
+    } catch (_) {
+      return "";
+    }
+  }
+  return {
+    name: readGitVal("user.name"),
+    email: readGitVal("user.email"),
+  };
+}
+
+// ---------- 装机上报到 cc-view-server ----------
+//
+// 安装完成时打一发 POST 到 cc-view-server，让运营侧能看到"谁/在哪台机/装了哪个版本"。
+// 设计原则：
+//   - fire-and-forget：3s 超时、不重试、任何失败绝不让安装本身退出非 0
+//   - 复用用户传给 OTel collector 的 host：172.31.250.57，port 8081 写死
+//   - URL 本身是公司内网地址，自带隐式凭据，不带 SSO header
+//   - 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;
+    try {
+      u = new URL(targetUrl);
+    } catch (e) {
+      return reject(e);
+    }
+    const isHttps = u.protocol === "https:";
+    const lib = isHttps ? require("https") : require("http");
+    const body = Buffer.from(JSON.stringify(payload), "utf8");
+    const req = lib.request(
+      {
+        method: "POST",
+        hostname: u.hostname,
+        port: u.port || (isHttps ? 443 : 80),
+        path: (u.pathname || "/") + (u.search || ""),
+        headers: {
+          "Content-Type": "application/json",
+          "Content-Length": body.length,
+        },
+        timeout: timeoutMs,
+      },
+      (res) => {
+        // 排空 body，让 socket 进入 keepalive/释放
+        res.on("data", () => {});
+        res.on("end", () => resolve(res.statusCode || 0));
+        res.on("error", reject);
+      }
+    );
+    req.on("error", reject);
+    req.on("timeout", () => {
+      req.destroy(new Error("timeout"));
+    });
+    req.write(body);
+    req.end();
+  });
+}
+
+async function reportInstall(otelEndpoint, gitUser, allResults, debug) {
+  if (!gitUser || !gitUser.email) {
+    if (debug) console.error("[ai-otel-setup] 跳过装机上报：无 git user.email");
+    return;
+  }
+  const reportUrl = buildReportUrl(otelEndpoint);
+  if (!reportUrl) return;
+  const findOk = (tool) =>
+    allResults.find((r) => r.tool === tool)?.status === "installed";
+  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,
+  };
+  try {
+    await postJsonWithTimeout(reportUrl, payload, 3000);
+    if (debug) console.error("[ai-otel-setup] 装机上报已发送");
+  } catch (e) {
+    if (debug) {
+      console.error("[ai-otel-setup] 装机上报失败（不影响安装）:", e.message || e);
+    }
+  }
+}
+
+// ---------- OTEL_RESOURCE_ATTRIBUTES (W3C baggage 风格) ----------
+
+// "k1=urlencoded,k2=urlencoded2" → { k1: "decoded", k2: "decoded2" }
+function parseResourceAttrs(s) {
+  const out = {};
+  if (!s || typeof s !== "string") return out;
+  for (const pair of s.split(",")) {
+    const idx = pair.indexOf("=");
+    if (idx <= 0) continue;
+    const k = pair.slice(0, idx).trim();
+    if (!k) continue;
+    const raw = pair.slice(idx + 1).trim();
+    try {
+      out[k] = decodeURIComponent(raw);
+    } catch (_) {
+      out[k] = raw; // decode 失败原样保留，不抛
+    }
+  }
+  return out;
+}
+
+function serializeResourceAttrs(obj) {
+  const parts = [];
+  for (const [k, v] of Object.entries(obj)) {
+    if (v === "" || v === null || v === undefined) continue;
+    parts.push(`${k}=${encodeURIComponent(v)}`);
+  }
+  return parts.join(",");
+}
+
+// parse-merge-serialize：保留用户自定义 attr（如 region=us-east），仅注入/覆盖 git.user.*
+function mergeResourceAttrs(existing, gitUser) {
+  const attrs = parseResourceAttrs(existing || "");
+  if (gitUser.email) attrs["git.user.email"] = gitUser.email;
+  if (gitUser.name) attrs["git.user.name"] = gitUser.name;
+  return serializeResourceAttrs(attrs);
+}
+
 // ---------- 文件操作 ----------
 
 function readJSONSafe(p) {
@@ -164,12 +350,11 @@ function backup(p) {
 function buildEnv(template, args, endpoint) {
   const env = { ...template.env };
   env.OTEL_EXPORTER_OTLP_ENDPOINT = endpoint;
-  // OTEL_RESOURCE_ATTRIBUTES 已废弃：bg/dept/team 不再上报
-  delete env.OTEL_RESOURCE_ATTRIBUTES;
+  // OTEL_RESOURCE_ATTRIBUTES 由 mergeSettings 单独处理（parse-merge 用户已有 + 注入 git.user.*）
   return env;
 }
 
-function mergeSettings(existing, newEnv, hookEntry, promptHookEntry, collectorHost) {
+function mergeSettings(existing, newEnv, hookEntry, promptHookEntry, collectorHost, gitUser) {
   const merged = { ...existing };
 
   // env：plugin 优先（组织规范不允许个人改红线），但保留用户独有的 env
@@ -177,8 +362,14 @@ function mergeSettings(existing, newEnv, hookEntry, promptHookEntry, collectorHo
   for (const k of OTEL_KEYS) {
     merged.env[k] = newEnv[k];
   }
-  // 清理历史遗留：旧版本 installer 写过 OTEL_RESOURCE_ATTRIBUTES，删掉
-  delete merged.env.OTEL_RESOURCE_ATTRIBUTES;
+
+  // OTEL_RESOURCE_ATTRIBUTES：parse-merge 用户已有 attr + 注入 git.user.email/name。
+  // 不进 OTEL_KEYS（OTEL_KEYS 走 overwrite，会丢掉用户自定义如 region=us-east）。
+  // 只在 readGlobalGitUser 拿到非空值时写；全空时保持用户已有值不动（包括不删）。
+  if (gitUser && (gitUser.name || gitUser.email)) {
+    const ra = mergeResourceAttrs(merged.env.OTEL_RESOURCE_ATTRIBUTES, gitUser);
+    if (ra) merged.env.OTEL_RESOURCE_ATTRIBUTES = ra;
+  }
 
   // 兜底用户写坏的 HTTP(S)_PROXY：把 collector host 加进 NO_PROXY，让 OTel gRPC 绕过代理
   // 仅追加，不动用户原有的 NO_PROXY 值，也不动 HTTP_PROXY / HTTPS_PROXY
@@ -424,7 +615,7 @@ function installGemini(home, endpoint) {
 
 // ---------- 主流程 ----------
 
-function main() {
+async function main() {
   const args = parseArgs(process.argv.slice(2));
 
   if (args.help || args.h || process.argv.includes("--help")) {
@@ -505,6 +696,10 @@ function main() {
     logsEndpoint: logsEndpointFromGrpc(endpoint),
   });
 
+  // 读全局 git config，作为 hook 进程没跑时的 SDK 层兜底来源
+  // 失败/缺失返回空串；mergeSettings 见空就跳过 OTEL_RESOURCE_ATTRIBUTES 写入
+  const gitUser = readGlobalGitUser();
+
   const existing = readJSONSafe(settingsPath);
   const bak = backup(settingsPath);
   const merged = mergeSettings(
@@ -512,7 +707,8 @@ function main() {
     newEnv,
     hookEntry,
     promptHookEntry,
-    extractHost(endpoint)
+    extractHost(endpoint),
+    gitUser
   );
   writeJSONAtomic(settingsPath, merged);
 
@@ -555,6 +751,9 @@ function main() {
         "SessionStart 中 id=" + HOOK_ID + " 与 UserPromptSubmit 中 id=" + PROMPT_HOOK_ID + " 的条目。"
     );
   }
+
+  // 装机上报：fire-and-forget 语义，3s 内完成或放弃；任何错误都不冒泡
+  await reportInstall(endpoint, gitUser, allResults, debug);
 }
 
 function printUsage() {
@@ -569,9 +768,7 @@ function printUsage() {
 `);
 }
 
-try {
-  main();
-} catch (e) {
+main().catch((e) => {
   console.error("[ai-otel-setup] 失败：" + (e && e.message ? e.message : e));
   process.exit(1);
-}
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai-otel-setup",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "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",