bfi-cli 0.1.69 → 0.1.71

package/dist/cli.mjs

@@ -7996,15 +7996,23 @@ const YMC_DEFAULT_BASE = process.env.BFI_YMC_BASE || "http://172.20.35.178:8901/
 var YmcApi = class {
 	baseUrl;
 	token;
-	constructor(token = null, baseUrl) {
+	dryRun;
+	constructor(token = null, baseUrl, dryRun = false) {
 		this.baseUrl = (baseUrl || YMC_DEFAULT_BASE).replace(/\/$/, "");
+		this.dryRun = dryRun;
 		if (token) {
 			this.token = token;
 			return;
 		}
 		this.token = loadGlobalConfig()?.token ?? null;
 	}
+	_dryRunExit(method, path, body) {
+		console.log(`[dry-run] ${method} ${this.baseUrl}/${path.replace(/^\//, "")}`);
+		if (body !== void 0 && Object.keys(body).length > 0) console.log(JSON.stringify(body, null, 2));
+		process.exit(0);
+	}
 	async call(path, body = {}, timeoutMs = 9e4) {
+		if (this.dryRun) this._dryRunExit("POST", path, body);
 		const url = `${this.baseUrl}/${path.replace(/^\//, "")}`;
 		const payload = JSON.stringify(body);
 		const mod = url.startsWith("https://") ? https : http;
@@ -8045,6 +8053,11 @@ var YmcApi = class {
 		};
 	}
 	async download(path, body, outFile, timeoutMs = 18e4) {
+		if (this.dryRun) {
+			console.log(`[dry-run] POST ${this.baseUrl}/${path.replace(/^\//, "")} （响应写盘 → ${outFile}）`);
+			if (Object.keys(body).length > 0) console.log(JSON.stringify(body, null, 2));
+			process.exit(0);
+		}
 		const url = `${this.baseUrl}/${path.replace(/^\//, "")}`;
 		const payload = JSON.stringify(body);
 		const mod = url.startsWith("https://") ? https : http;
@@ -8078,6 +8091,7 @@ var YmcApi = class {
 		return raw.length;
 	}
 	async get(path, timeoutMs = 3e4) {
+		if (this.dryRun) this._dryRunExit("GET", path);
 		const url = `${this.baseUrl}/${path.replace(/^\//, "")}`;
 		const mod = url.startsWith("https://") ? https : http;
 		const raw = await new Promise((resolve, reject) => {
@@ -8189,13 +8203,22 @@ async function runYmc(args, globalOpts) {
 	const sub = args[0];
 	const rest = args.slice(1);
 	const jsonMode = flag(rest, "--json");
+	const dryRun = flag(rest, "--dry-run");
 	const token = globalOpts.token;
-	const api = new YmcApi(token ?? null);
-	requireToken(api);
+	const api = new YmcApi(token ?? null, void 0, dryRun);
 	if (!sub || sub === "--help" || sub === "-h") {
 		printHelp();
 		return;
 	}
+	if (sub === "help") {
+		printCommandHelp(rest[0] || "");
+		return;
+	}
+	if (flag(rest, "--help") || flag(rest, "-h")) {
+		printCommandHelp(sub);
+		return;
+	}
+	if (!dryRun) requireToken(api);
 	switch (sub) {
 		case "status":
 			emit(await api.get("ymc/auth/status"), jsonMode, (data) => {
@@ -8279,6 +8302,7 @@ async function runYmc(args, globalOpts) {
 				...opt(rest, "--days") ? { days: Number(opt(rest, "--days")) } : {},
 				...opt(rest, "--line") ? { line: Number(opt(rest, "--line")) } : {}
 			};
+			if (!opt(rest, "-t", "--time") && !opt(rest, "--start-time") && !opt(rest, "--days")) console.error("⚠️ 未指定时间窗：服务端按超大窗口兜底，命中可能含数天前记录——取证请显式 -t/--start-time");
 			emit(await api.call("sls/raw", body), jsonMode, (data) => {
 				const d = data;
 				const rows = Array.isArray(d) ? d : d.rows ?? d.data ?? [];
@@ -8732,6 +8756,133 @@ async function runYmc(args, globalOpts) {
 			process.exit(1);
 	}
 }
+const HELP = {
+	status: `bfi ymc status — 查询 YMC 登录会话状态
+  说明：显示 dev/prod 两个 host 组的登录态与过期时间。
+  注意：显示"未登录"不影响取数——首次取数会自动登录（多等几秒），不要停下。`,
+	trace: `bfi ymc trace <trace_id> -e <env> [--ts <毫秒>] [--json]
+  三源合一查询：SLS 业务日志 + warningChain 链路 + ingress 访问日志（诊断首选入口）。
+  参数：
+    <trace_id>            追踪 ID（全局唯一，跨服务，无需 appCode）
+    -e <env>              环境：test/daily/pre/core1-4/commldev
+    --ts <毫秒>           Epoch 毫秒时间锚点；默认自动推导（SLS 首条日志时间），
+                          SLS 无日志时须显式提供
+    --json                输出完整信封 {code,msg,data}
+  摘要含：span 数/异常数/最大耗时/慢调用与慢SQL告警数/Top慢span/ingress 入口。
+  注意：trace 摘要的入口 URL 可能混入同链路其他入口记录——与目标不符时核对 ingress 明细。`,
+	chain: `bfi ymc chain <trace_id> -e <env> [--ts <毫秒>] [--json]
+  原子源：warningChain 全量 Span 链路（耗时分解/调用树）。trace 三源合一的链路通道单独调用。`,
+	"sls-logs": `bfi ymc sls-logs <trace_id> -e <env> [--ts <毫秒>] [--json]
+  原子源：SLS 业务日志（异常全文/堆栈）。按 traceid 索引检索。`,
+	"sls-raw": `bfi ymc sls-raw "<查询>" -e <env> [-t <time> | --start-time <s> --end-time <e> | --days N] [--line N] [--json]
+  SLS 原始查询（阿里云 SLS 完整语法透传：索引检索 + | SELECT 分析语句）。
+  参数：
+    "<查询>"              查询语句。核心规则：索引检索前置（traceid: xx / "关键词" AND applicationname: xx），
+                          禁止 * | SELECT * WHERE 字段=... （WHERE 全扫描必超时）
+    -t <time>             时间简写 10m/2h/3d/4w（默认无时间=服务端超大窗兜底，会命中数天前记录，务必显式指定）
+    --start-time/--end-time  精确窗口 yyyy-MM-dd HH:mm:ss 北京时间（优先于 -t）
+    --days N              按天数回溯（旧参数，等价 -t Nd）
+    --line N              返回行数上限
+  示例：
+    bfi ymc sls-raw 'traceid: abc | SELECT * LIMIT 200' -e daily -t 1d
+    bfi ymc sls-raw '"Exception" AND applicationname: yonbip-scm-pu | SELECT count(*) AS cnt' -e pre -t 3d
+    bfi ymc sls-raw 'applicationname: yonbip-scm-scmmp AND "unaudit" | SELECT traceid, time LIMIT 10' -e core3 -t 1d
+  注意：业务关键词检索必须 applicationname: 限定目标服务（共享路径 URL 全平台都有）；
+  traceid/spanid 检索例外（全局唯一）。非索引字段（logger/requesturl）不能进检索语法，只能在 SELECT 里引用。`,
+	"sls-grep": `bfi ymc sls-grep "<关键词>" -e <env> -t <time> [--json]
+  SLS 全文检索聚合（每组计数）。注意：计数上限 100 可能封顶，影响面/精确计数用 sls-raw + GROUP BY。`,
+	slowsql: `bfi ymc slowsql -t <time> -e <env> [--sql-str <表名或片段>] [--md5 <指纹>] [--trace-id <id>] [--app <appCode>] [--no-profiler] [--page N] [--page-size N] [--json]
+  慢 SQL 告警明细（耗时降序；摘要含 服务/耗时/行数/SQL 前段/指纹/调用栈首帧）。
+  参数：
+    -t <time>             时间窗（必填语义，服务端强校验）
+    --sql-str             按 SQL 片段过滤（表名/语句片段）
+    --md5                 按 SQL MD5 指纹精确过滤（同类 SQL 归类）
+    --trace-id            按链路过滤。⚠️ 按 trace 查询时不带 --app（traceId 已唯一限定，
+                          --app 会截断其他服务的告警行——慢 SQL 归属哪个服务事先未知）
+    --app                 服务维度过滤（无 traceId 时必带，裸 appCode）
+    --no-profiler         显式关闭 enableProfiler（默认自动带 'true'——不带该字段上游 500，
+                          带了才返回 sqlStack 调用栈）
+  示例：
+    bfi ymc slowsql -t 1d --app yonbip-scm-scmmp -e core3          # 服务维度（SQL 画像）
+    bfi ymc slowsql -t 1d --trace-id abc -e core3                  # 链路维度（勿带 --app）`,
+	slowcall: `bfi ymc slowcall -t <time> -e <env> [--trace-id <id>] [--app <appCode>] [--method <方法>] [--min-cost <ms>] [--page N] [--page-size N] [--json]
+  慢调用告警明细（耗时降序；摘要含 服务/耗时/sql/rpc/redis 分解/方法/pod）。
+  参数：
+    --trace-id            按链路过滤。⚠️ 不带 --app（同 slowsql，--app 会截断下游服务告警行）
+    --app                 服务维度过滤（裸 appCode）
+    --method              按调用方法过滤
+    --min-cost <ms>       最小耗时过滤（body.costTime=[ms, 999999]）
+    （无 --profiler）      历史参数已移除映射——上游 enableProfiler 是"仅返回有 CPU 采样
+                          记录"的过滤器，实测任何组合均空集。CPU 热点走 dump-list。
+  示例：
+    bfi ymc slowcall -t 1d --trace-id abc -e core3                 # 链路分层分解（跨服务根因链必用）
+    bfi ymc slowcall -t 4w --app yonbip-scm-pu -e pre              # 服务慢调用趋势`,
+	exceptions: `bfi ymc exceptions -t <time> -e <env> [--app <appCode>] [--json]
+  异常聚合（exceptionHistory）。--app 传裸微服务名（appId 需 <env>-<appCode> 格式，传裸名上游才查得到）。`,
+	alerts: `bfi ymc alerts -t <time> -e <env> [--level error|warn|info] [--page-size N] [--json]
+  告警明细。--page-size 默认 10；--level 可省。`,
+	"url-stats": `bfi ymc url-stats </uri> -t <time> -e <env> --app <service_name> [--json]
+  URL 性能统计（ingress 访问日志聚合）：QPS/avg/P50/P90/P95/P99/状态码分布/慢请求Top10（含 traceId）。
+  参数：
+    --app <service_name>  ⚠️ 必带（诊断纪律）：共享路径 URL（/bill/* 等通用单据接口）全平台
+                          每个业务域都有——不限定服务=全平台混合假面。传裸 appCode 即可
+                          （服务端自适应环境前缀 wildcard，如 online-dc-core3-<app>-out）
+  示例：
+    bfi ymc url-stats /bill/unaudit -t 1d -e core3 --app yonbip-scm-scmmp`,
+	ingress: `bfi ymc ingress --trace-id <id> | --uri </path> [-t <time>] -e <env> [--exact] [--app <service_name>] [--size N] [--json]
+  ingress 访问日志明细（网关视角：request_time vs upstream_response_time/状态码/pod/租户）。
+  参数：
+    --trace-id            按链路查（时间可省，默认 30d）
+    --uri                 按 URI 查（默认子串匹配，--exact 精确；time 必填）
+    --app                 service_name 过滤（uri 模式必带，裸 appCode 自适应前缀）
+    --size N              返回条数（默认 100，最大 5000）`,
+	"dump-list": `bfi ymc dump-list -t <time> -e <env> [--app <appCode>] [--type profiler|heap|...] [--json]
+  诊断文件列表（火焰图/JVM dump；CPU 热点取数的正确入口）。`,
+	cases: `bfi ymc cases <search|show|upload|index> [参数]
+  KEDB 案例库（内部诊断先验第一源）。
+    search [--type <t>] [--finger "<指纹>"] [--service <svc>] [--kw "<关键词>"] [--limit N]
+    show <case_id>
+    upload --file <报告.html> [--type slow-req] [--finger "词1,词2"] [--env] [--service]
+    index                 案例库索引重建`,
+	wiki: `bfi ymc wiki <search|show> [参数]
+  知识库统一检索（confluence + jira + 文库 ecfile 三源——诊断先验的外部源，勿只查其一）。
+    search "<关键词>" [--source confluence|jira|ecfile] [--limit N] [--titles]
+    show <id> [--source wiki|uap-wiki|gfwiki|gfjira|ecfile]
+  示例：
+    bfi ymc wiki search "/bill/unaudit 超时"          # 三源全查（默认）
+    bfi ymc wiki show BIP-BUG-00157126 --source gfjira`,
+	callstat: `bfi ymc callstat -t <time> -e <env> [--page N] [--page-size N] [--json]
+  慢调用统计版（warningCallstat 聚合视图；体检/趋势用）。--app 经 --data 传（见 call）。`,
+	sqlstat: `bfi ymc sqlstat -t <time> -e <env> [--page N] [--page-size N] [--json]
+  慢 SQL 统计版（warningSqlstat 聚合视图）。`,
+	events: `bfi ymc events -e <env> [--type <类型>] [--start-time <s>] [--end-time <e>] [--app <appCode>] [--pipeline <code>] [--histogram] [--json]
+  集群事件明细/直方图。`,
+	"log-url": `bfi ymc log-url -e <env> [--type ingressLog|appLog|instanceLog] [--app <appId>] [--filter-app <ids>]
+  生成 SLS 日志直通 URL（浏览器直接打开的访问/业务/实例日志页签）。`,
+	"sample-list": `bfi ymc sample-list -t <time> -e <env> [--json]
+  采样数据列表。`,
+	rca: `bfi ymc rca -e <env> [-t <time> | --start-time <s> --end-time <e>] [--app <appId>] [--app-code <appCode>] [--json]
+  YMC 官方智能诊断 RCA 全报告。⚠️ 长耗时（实测约 300s），上游需 podId 等参数，失败多因参数不足；客户端超时已设 300s。`,
+	"bpr-download": `bfi ymc bpr-download <pk> -e <env> [-o <输出文件>]
+  BPR 报告 HTML 下载（文件流写盘）。pk 来源：bfi ymc call bpr/list --data '{"page":1,"pageSize":10}' -e <env>。
+  输出默认 bpr_<pk前16>.html。`,
+	call: `bfi ymc call <route> -e <env> [--data '<json>'] [-t <time> | --start-time <s> --end-time <e>] [--timeout <秒>] [--json]
+  通用透传：覆盖全部注册表端点（warningCall/warningSql/exceptionHistory/bpr/list/alert/detail/tool/list/app/history/environment/uba/query ...）。
+  完整清单与参数声明：curl http://172.20.35.178:8901/openapi.json 或 /docs（Swagger UI）。
+  时间参数（-t/--start-time/--end-time）由服务端按端点 time_fields 展开为 beginTs/endTs 等。
+  示例：
+    bfi ymc call warningCallstat --data '{"curAppCode":"yonbip-scm-scmmp","page":1,"pageSize":10}' -e core3 -t 1h
+    bfi ymc call app/history --data '{"appId":"daily-x","queryType":"podCpuUsage"}' -e daily -t 1d`
+};
+function printCommandHelp(cmd) {
+	const h = HELP[cmd];
+	if (h) console.log(h);
+	else {
+		console.error(`未知子命令：${cmd}`);
+		printHelp();
+		process.exit(1);
+	}
+}
 function printHelp() {
 	console.log(`
 bfi ymc — 观测查询（v2 API：YMC/Kibana/SLS/trace）
@@ -8761,8 +8912,11 @@ bfi ymc — 观测查询（v2 API：YMC/Kibana/SLS/trace）
   -t, --time           时间简写（10m/2h/3d/4w = 过去 N 单位到现在）
   --start-time <t>     开始时间 yyyy-MM-dd HH:mm:ss（与 -t 二选一；只传它=到当前）
   --end-time <t>       结束时间（须与 --start-time 同传）
-  --json       输出原始 JSON
+  --json       输出原始 JSON（完整信封 {code,msg,data}）
+  --dry-run    只打印将发送的 method/URL/body，不实际请求（无需登录）
   --token      覆盖已登录 token（默认用 bfi auth login 的）
+
+详细帮助：bfi ymc help <命令>（或 bfi ymc <命令> -h）——含参数说明/默认值/示例。
 `);
 }
 const __dirname = dirname(fileURLToPath(import.meta.url));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bfi-cli",
-  "version": "0.1.69",
+  "version": "0.1.71",
   "description": "用友大业财BFI统一命令行工具，支持技能，技能包，元数据，UI元数据等",
   "type": "module",
   "bin": {