@lark-apaas/miaoda-cli 0.1.2 → 0.1.3-alpha.09899c4

package/dist/cli/handlers/observability/log.js

@@ -0,0 +1,94 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleObservabilityLog = handleObservabilityLog;
+const api = __importStar(require("../../../api/index"));
+const output_1 = require("../../../utils/output");
+const index_1 = require("../../../api/observability/index");
+const helpers_1 = require("./helpers");
+/** miaoda observability log */
+async function handleObservabilityLog(opts) {
+    const appID = opts.appId;
+    const appEnv = 'runtime';
+    const limit = (0, helpers_1.validateLimit)(opts.limit ?? 50);
+    // 过滤 key 对齐 BAM 查询字段名：
+    //   - 顶层字段：severity_text / trace_id（输出仍映射成 severityText / traceID）
+    //   - attributes 里的业务字段：module / user_id / page / api / ob_data_id（snake_case，
+    //     依据 BAM IDL 的 LogItem.attributes 描述："包括 tenant_id, module, user_id, page, api 等"）
+    //   - duration_ms 暂未在 BAM 描述里明确列出，留 TODO 等 e2e 验证
+    const fieldFilters = (0, helpers_1.buildFieldFilters)([
+        { key: 'severity_text', value: opts.level ? (0, helpers_1.eqFilter)(opts.level) : undefined },
+        { key: 'attributes.ob_data_id', value: opts.logId ? (0, helpers_1.eqFilter)(opts.logId) : undefined },
+        { key: 'trace_id', value: opts.traceId ? (0, helpers_1.eqFilter)(opts.traceId) : undefined },
+        { key: 'module', value: opts.module ? (0, helpers_1.eqFilter)(opts.module) : undefined },
+        { key: 'user_id', value: opts.userId ? (0, helpers_1.eqFilter)(opts.userId, 'i64') : undefined },
+        { key: 'page', value: opts.page ? (0, helpers_1.eqFilter)(opts.page) : undefined },
+        { key: 'api', value: opts.api ? (0, helpers_1.eqFilter)(opts.api) : undefined },
+        {
+            // TODO: 确认 BAM 是否真用 duration_ms 作为 attribute key
+            key: 'duration_ms',
+            value: opts.minDuration !== undefined || opts.maxDuration !== undefined
+                ? (0, helpers_1.rangeFilter)({ gte: opts.minDuration, lte: opts.maxDuration })
+                : undefined,
+        },
+    ]);
+    const fuzzyFilter = opts.grep
+        ? {
+            include: {
+                words: [opts.grep],
+                operator: 1, // AND
+            },
+        }
+        : undefined;
+    const req = {
+        appID,
+        appEnv,
+        startTimestampNs: (0, helpers_1.parseToNs)(opts.since),
+        endTimestampNs: (0, helpers_1.parseToNs)(opts.until),
+        limit,
+        pageToken: opts.cursor,
+        fieldFilters,
+        fuzzyFilter,
+    };
+    const resp = await api.observability.searchLogs(req);
+    emitSearchLogsResponse(resp);
+}
+function emitSearchLogsResponse(resp) {
+    (0, output_1.emit)({
+        data: resp.logItems ?? [],
+        next_cursor: resp.hasMore ? resp.nextPageToken : null,
+        has_more: resp.hasMore,
+    }, index_1.logItemSchema);
+}

package/dist/cli/handlers/observability/metric.js

@@ -0,0 +1,208 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleObservabilityMetric = handleObservabilityMetric;
+const api = __importStar(require("../../../api/index"));
+const output_1 = require("../../../utils/output");
+const args_1 = require("../../../utils/args");
+const helpers_1 = require("./helpers");
+/**
+ * PRD <metric-name> + --series → 服务端 metric name → 表头列名（=对应 --series 取值）。
+ *
+ * - 缺省 --series 时返回该 cliName 下所有相关线。
+ * - latency / requests 的 error 线 v1.0.122 起由独立 metric 提供（不再 is_error filter）。
+ *
+ * 表头标签直接用 --series 名（"total"/"error"/"p50"/"p99"）；单一指标则用 cliName。
+ */
+const METRIC_LABELS = {
+    cpu: { cpu_usage: 'cpu' },
+    memory: { mem_usage: 'memory' },
+    requests: {
+        client_api_request_count: 'total',
+        client_api_request_error_count: 'error',
+    },
+    latency: {
+        client_api_request_latency_p50: 'p50',
+        client_api_request_latency_p99: 'p99',
+    },
+};
+/** miaoda observability metric <metric-name> */
+async function handleObservabilityMetric(opts) {
+    if (!opts.metricName)
+        (0, args_1.failArgs)('<metric-name> 必填');
+    const appID = opts.appId;
+    const { metricNames, labelByMetric, extraFilters } = resolveMetricSelection(opts.metricName, opts.series);
+    const filters = (0, helpers_1.buildFieldFilters)([
+        { key: 'referer_path', value: opts.page ? (0, helpers_1.eqFilter)(opts.page) : undefined },
+        { key: 'api', value: opts.api ? (0, helpers_1.eqFilter)(opts.api) : undefined },
+        ...extraFilters,
+    ]);
+    // since/until 直接以秒透传到 BAM；当前未做桶对齐（如需开启把 until
+    // 用 ceilMsToBucket(untilMs, downSample as GranularityBucket) 包一层即可）。
+    const downSample = opts.downSample ?? '1m';
+    const nowMs = Date.now();
+    const sinceMs = (0, helpers_1.parseToMs)(opts.since) ?? nowMs - 30 * 86_400_000;
+    const untilMs = (0, helpers_1.parseToMs)(opts.until) ?? nowMs;
+    const req = {
+        appID,
+        appEnv: 'runtime',
+        metricNames,
+        startTimestamp: (0, helpers_1.msToSec)(sinceMs),
+        endTimestamp: (0, helpers_1.msToSec)(untilMs),
+        filters,
+        downSample,
+        needPackLackPoint: false,
+    };
+    const resp = await api.observability.queryMetricsData(req);
+    // requests 的 count / error_count：
+    //   - BAM 在该时间点无数据时会传 null，或者 values 里干脆缺 key
+    //   - CLI 按"请求过的 metricNames"逐一兜底为 0，让"没有请求"和"没有数据"
+    //     在表格 / JSON 里都显式呈现成 0，避免空格 / 缺字段被误解为缺失
+    // latency / cpu / memory 不做这个兜底——p50 没数据 ≠ 延迟为 0。
+    if (opts.metricName === 'requests') {
+        fillRequestedMetricsWithZero(resp, metricNames);
+    }
+    emitMetricsResponse(resp, labelByMetric);
+}
+/**
+ * 按"客户端请求过的 metricNames"兜底缺失/为 null 的值为 0；不去动 BAM 多返回的
+ * 其他字段（防御性，避免误改不属于本次查询的数据）。
+ */
+function fillRequestedMetricsWithZero(resp, requestedMetricNames) {
+    for (const point of resp.points ?? []) {
+        for (const name of requestedMetricNames) {
+            point.values[name] ??= 0;
+        }
+    }
+}
+// ── 渲染 ─────────
+//
+// BAM v1.0.123 起返回 points: [{timestamp, dimensions, values: {metricName: v}}]——
+// 服务端已把多 metric 合并到同 timestamp 的 row，下游直接平铺即可。
+// JSON 模式：原样透传 points（保留 BAM 原 metricName 作为 values 的 key）。
+// Pretty 模式：把 values 里的 metricName 重命名成 CLI label（p50/p99/total 等），
+//   再走 buildPivotSchema 渲染。
+function emitMetricsResponse(resp, labelByMetric) {
+    const points = resp.points ?? [];
+    // metric 不分页，但仍补齐 has_more / next_cursor 以对齐 log/trace 的信封形状
+    if ((0, output_1.isJsonMode)()) {
+        (0, output_1.emit)({ data: points, next_cursor: null, has_more: false });
+        return;
+    }
+    const { rows, seriesLabels } = renameAndSort(points, labelByMetric);
+    if (rows.length === 0) {
+        (0, output_1.emit)({ data: [], next_cursor: null, has_more: false });
+        return;
+    }
+    const hasLatency = Object.keys(labelByMetric).some((n) => n.includes('latency'));
+    (0, output_1.emit)({ data: rows, next_cursor: null, has_more: false }, buildPivotSchema(seriesLabels, hasLatency));
+}
+function renameAndSort(points, labelByMetric) {
+    // 列顺序按 labelByMetric 声明顺序，避免 BAM 返回顺序波动影响表头
+    const seriesLabels = Object.values(labelByMetric);
+    // TODO: 当 dimensions 非空（groupBy 多 series）时，把 dimensions 也并入 row
+    const rows = points.map((point) => {
+        const row = { timestamp: point.timestamp };
+        for (const [metricName, value] of Object.entries(point.values)) {
+            const label = labelByMetric[metricName] ?? metricName;
+            row[label] = value;
+        }
+        return row;
+    });
+    // 按时间倒序，与 log/trace 的"最新在前"风格一致
+    rows.sort((a, b) => b.timestamp - a.timestamp);
+    return { rows, seriesLabels };
+}
+function buildPivotSchema(seriesLabels, hasLatency) {
+    const valueFormat = hasLatency ? output_1.fmt.durationMs() : undefined;
+    return {
+        columns: [
+            { key: 'timestamp', label: 'time', format: output_1.fmt.sec() },
+            ...seriesLabels.map((label) => ({
+                key: label,
+                label,
+                ...(valueFormat ? { format: valueFormat } : {}),
+            })),
+        ],
+        strict: true,
+    };
+}
+/**
+ * 解析 <metric-name> + --series 的组合：决定最终 metricNames、表头 label 映射、附加过滤。
+ *
+ * label 直接用 --series 取值（"total"/"error"/"p50"/"p99"）；单一指标 cliName 也作为 label。
+ */
+function resolveMetricSelection(cliName, series) {
+    const extras = [];
+    if (cliName === 'latency') {
+        if (series === 'p99') {
+            return single('client_api_request_latency_p99', 'p99', extras);
+        }
+        if (series === 'p50') {
+            return single('client_api_request_latency_p50', 'p50', extras);
+        }
+        return all(METRIC_LABELS.latency, extras);
+    }
+    if (cliName === 'requests') {
+        // v1.0.122 起 error 线由独立 metric 提供，不再走 is_error filter
+        if (series === 'total') {
+            return single('client_api_request_count', 'total', extras);
+        }
+        if (series === 'error') {
+            return single('client_api_request_error_count', 'error', extras);
+        }
+        return all(METRIC_LABELS.requests, extras);
+    }
+    if (cliName === 'cpu')
+        return all(METRIC_LABELS.cpu, extras);
+    if (cliName === 'memory')
+        return all(METRIC_LABELS.memory, extras);
+    // 兜底：CLI 名直接作为 metric name + label
+    return single(cliName, cliName, extras);
+}
+function single(metricName, label, extras) {
+    return {
+        metricNames: [metricName],
+        labelByMetric: { [metricName]: label },
+        extraFilters: extras,
+    };
+}
+function all(labelByMetric, extras) {
+    return {
+        metricNames: Object.keys(labelByMetric),
+        labelByMetric,
+        extraFilters: extras,
+    };
+}

package/dist/cli/handlers/observability/trace.js

@@ -0,0 +1,102 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleObservabilityTraceList = handleObservabilityTraceList;
+exports.handleObservabilityTraceGet = handleObservabilityTraceGet;
+const api = __importStar(require("../../../api/index"));
+const output_1 = require("../../../utils/output");
+const args_1 = require("../../../utils/args");
+const index_1 = require("../../../api/observability/index");
+const helpers_1 = require("./helpers");
+/** miaoda observability trace list */
+async function handleObservabilityTraceList(opts) {
+    const appID = opts.appId;
+    const appEnv = 'runtime';
+    const limit = (0, helpers_1.validateLimit)(opts.limit ?? 50);
+    // 过滤 key 对齐 BAM Span 字段名：
+    //   - 顶层字段：traceID（注意大小写）
+    //   - attributes 业务字段：user_id（snake_case）
+    //   - 入口 span：BAM 没有 entrySpanName fieldFilter，统一走 fuzzyFilter（trace endpoint
+    //     默认作用于 span name），所以 --root-span 不进 fieldFilters
+    const fieldFilters = (0, helpers_1.buildFieldFilters)([
+        { key: 'trace_id', value: opts.traceId ? (0, helpers_1.eqFilter)(opts.traceId) : undefined },
+        { key: 'user_id', value: opts.userId ? (0, helpers_1.eqFilter)(opts.userId, 'i64') : undefined },
+    ]);
+    const req = {
+        appID,
+        appEnv,
+        startTimestampNs: (0, helpers_1.parseToNs)(opts.since),
+        endTimestampNs: (0, helpers_1.parseToNs)(opts.until),
+        limit,
+        pageToken: opts.cursor,
+        fieldFilters,
+        fuzzyFilter: opts.rootSpan ? (0, helpers_1.fuzzyFilter)(opts.rootSpan) : undefined,
+    };
+    const resp = await api.observability.searchTraces(req);
+    emitSearchTracesResponse(resp);
+}
+function emitSearchTracesResponse(resp) {
+    (0, output_1.emit)({
+        data: resp.spans ?? [],
+        next_cursor: resp.hasMore ? resp.nextPageToken : null,
+        has_more: resp.hasMore,
+    }, index_1.spanSchema);
+}
+/** miaoda observability trace get <trace-id> */
+async function handleObservabilityTraceGet(opts) {
+    if (!opts.traceId)
+        (0, args_1.failArgs)('<trace-id> 必填');
+    const appID = opts.appId;
+    const appEnv = 'runtime';
+    const resp = await api.observability.getTraces({
+        appID,
+        appEnv,
+        traceID: opts.traceId,
+        withLogSeverityCount: opts.withLogSeverityCount,
+    });
+    emitGetTraceResponse(resp);
+}
+function emitGetTraceResponse(resp) {
+    // JSON 模式：保持单条信封语义，便于下游一次解析
+    if ((0, output_1.isJsonMode)()) {
+        (0, output_1.emit)({
+            data: { spans: resp.spans ?? [], isBreak: resp.isBreak },
+        });
+        return;
+    }
+    // Pretty 模式：先打头部 key-value（断链状态等元信息），再按 spanSchema 渲染主表
+    (0, output_1.emit)({ data: { isBreak: resp.isBreak } });
+    (0, output_1.emit)({ data: resp.spans ?? [] }, index_1.spanSchema);
+}