@cnpinsight/cnpclawinsights 2.0.1 → 2.0.2

package/README.md

@@ -20,6 +20,69 @@ openclaw plugins install @cnpinsight/cnpclawinsights
 openclaw plugins install @cnpinsight/cnpclawinsights@2.0.0
 ```
 
+## 安装器
+
+如果你不想手动编辑 `openclaw.json`，可以使用安装器命令自动写入插件配置。
+
+最简单的方式：
+
+```bash
+npm exec -y --package=@cnpinsight/cnpclawinsights -- \
+  cnpclawinsights-install \
+  --non-interactive
+```
+
+这会自动把配置写入默认的 `~/.openclaw/openclaw.json`，并生成：
+
+```json
+{
+  "plugins": {
+    "entries": {
+      "cnpclawinsights": {
+        "enabled": true,
+        "config": {
+          "otel": {
+            "endpoint": "http://127.0.0.1:4318"
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+指定 endpoint 并开启 logs：
+
+```bash
+npm exec -y --package=@cnpinsight/cnpclawinsights -- \
+  cnpclawinsights-install \
+  --non-interactive \
+  --endpoint http://127.0.0.1:4318 \
+  --logs
+```
+
+指定 service name 和 header：
+
+```bash
+npm exec -y --package=@cnpinsight/cnpclawinsights -- \
+  cnpclawinsights-install \
+  --non-interactive \
+  --service-name openclaw \
+  --header Authorization="Bearer <token>"
+```
+
+安装器支持的主要参数：
+
+- `--config-path <path>`：指定 `openclaw.json` 路径
+- `--endpoint <url>`：设置 OTLP endpoint
+- `--service-name <name>`：设置 OTel service name
+- `--logs` / `--no-logs`：开启或关闭 logs 导出
+- `--traces` / `--no-traces`：开启或关闭 traces 导出
+- `--metrics` / `--no-metrics`：开启或关闭 metrics 导出
+- `--sample-rate <0..1>`：设置 trace 采样率
+- `--flush-interval-ms <ms>`：设置导出刷新间隔
+- `--header <k=v>`：追加请求头，可重复传入
+
 ## 最小配置
 
 在 `openclaw.json` 中添加：

package/dist/cli.mjs

@@ -0,0 +1,206 @@
+#!/usr/bin/env node
+
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+
+const PLUGIN_ID = "cnpclawinsights";
+const LEGACY_PLUGIN_ID = "cnpclawinsight";
+const DEFAULT_CONFIG_PATH = path.join(os.homedir(), ".openclaw", "openclaw.json");
+const DEFAULT_ENDPOINT = "http://127.0.0.1:4318";
+
+function printHelp() {
+  console.log(`Usage:
+  cnpclawinsights-install [options]
+
+Options:
+  --config-path <path>       Path to openclaw.json
+  --endpoint <url>           OTLP endpoint, default: ${DEFAULT_ENDPOINT}
+  --service-name <name>      OpenTelemetry service name
+  --logs                     Enable logs export
+  --no-logs                  Disable logs export
+  --traces                   Enable traces export
+  --no-traces                Disable traces export
+  --metrics                  Enable metrics export
+  --no-metrics               Disable metrics export
+  --sample-rate <0..1>       Trace sampling rate
+  --flush-interval-ms <ms>   Export flush interval
+  --header <k=v>             Add OTLP header, repeatable
+  --non-interactive          Run without prompts
+  --help                     Show this help
+`);
+}
+
+function fail(message) {
+  console.error(`cnpclawinsights-install: ${message}`);
+  process.exit(1);
+}
+
+function parseArgs(argv) {
+  const options = {
+    configPath: DEFAULT_CONFIG_PATH,
+    endpoint: DEFAULT_ENDPOINT,
+    headers: {}
+  };
+
+  for (let i = 0; i < argv.length; i += 1) {
+    const arg = argv[i];
+    switch (arg) {
+      case "--config-path":
+        options.configPath = argv[++i];
+        break;
+      case "--endpoint":
+        options.endpoint = argv[++i];
+        break;
+      case "--service-name":
+        options.serviceName = argv[++i];
+        break;
+      case "--logs":
+        options.logs = true;
+        break;
+      case "--no-logs":
+        options.logs = false;
+        break;
+      case "--traces":
+        options.traces = true;
+        break;
+      case "--no-traces":
+        options.traces = false;
+        break;
+      case "--metrics":
+        options.metrics = true;
+        break;
+      case "--no-metrics":
+        options.metrics = false;
+        break;
+      case "--sample-rate":
+        options.sampleRate = Number(argv[++i]);
+        break;
+      case "--flush-interval-ms":
+        options.flushIntervalMs = Number(argv[++i]);
+        break;
+      case "--header": {
+        const raw = argv[++i];
+        const eqIndex = raw.indexOf("=");
+        if (eqIndex <= 0) fail(`invalid --header value: ${raw}`);
+        const key = raw.slice(0, eqIndex).trim();
+        const value = raw.slice(eqIndex + 1).trim();
+        if (!key || !value) fail(`invalid --header value: ${raw}`);
+        options.headers[key] = value;
+        break;
+      }
+      case "--non-interactive":
+        options.nonInteractive = true;
+        break;
+      case "--help":
+      case "-h":
+        options.help = true;
+        break;
+      default:
+        fail(`unknown argument: ${arg}`);
+    }
+  }
+
+  return options;
+}
+
+function ensureParentDir(filePath) {
+  fs.mkdirSync(path.dirname(filePath), { recursive: true });
+}
+
+function readConfig(configPath) {
+  if (!fs.existsSync(configPath)) {
+    return {};
+  }
+  try {
+    return JSON.parse(fs.readFileSync(configPath, "utf8"));
+  } catch (error) {
+    fail(`failed to parse config file ${configPath}: ${error instanceof Error ? error.message : String(error)}`);
+  }
+}
+
+function normalizePluginEntry(entries) {
+  const pluralEntry = entries[PLUGIN_ID];
+  if (pluralEntry && typeof pluralEntry === "object") {
+    return pluralEntry;
+  }
+  const legacyEntry = entries[LEGACY_PLUGIN_ID];
+  if (legacyEntry && typeof legacyEntry === "object") {
+    delete entries[LEGACY_PLUGIN_ID];
+    entries[PLUGIN_ID] = legacyEntry;
+    return legacyEntry;
+  }
+  const entry = {};
+  entries[PLUGIN_ID] = entry;
+  return entry;
+}
+
+function buildPluginConfig(options) {
+  const otel = {
+    endpoint: options.endpoint
+  };
+
+  if (options.logs !== undefined) otel.logs = options.logs;
+  if (options.traces !== undefined) otel.traces = options.traces;
+  if (options.metrics !== undefined) otel.metrics = options.metrics;
+  if (options.serviceName) otel.serviceName = options.serviceName;
+  if (options.sampleRate !== undefined) otel.sampleRate = options.sampleRate;
+  if (options.flushIntervalMs !== undefined) otel.flushIntervalMs = options.flushIntervalMs;
+  if (Object.keys(options.headers).length > 0) otel.headers = options.headers;
+
+  return { otel };
+}
+
+function writeConfig(configPath, config) {
+  ensureParentDir(configPath);
+  fs.writeFileSync(configPath, `${JSON.stringify(config, null, 2)}\n`, "utf8");
+}
+
+function main() {
+  const options = parseArgs(process.argv.slice(2));
+  if (options.help) {
+    printHelp();
+    return;
+  }
+
+  if (options.sampleRate !== undefined && (!Number.isFinite(options.sampleRate) || options.sampleRate < 0 || options.sampleRate > 1)) {
+    fail("--sample-rate must be a number between 0 and 1");
+  }
+
+  if (options.flushIntervalMs !== undefined && (!Number.isInteger(options.flushIntervalMs) || options.flushIntervalMs < 1000)) {
+    fail("--flush-interval-ms must be an integer >= 1000");
+  }
+
+  const config = readConfig(options.configPath);
+  if (!config.plugins || typeof config.plugins !== "object" || Array.isArray(config.plugins)) {
+    config.plugins = {};
+  }
+  if (!config.plugins.entries || typeof config.plugins.entries !== "object" || Array.isArray(config.plugins.entries)) {
+    config.plugins.entries = {};
+  }
+  const entry = normalizePluginEntry(config.plugins.entries);
+  entry.enabled = true;
+  entry.config = {
+    ...(entry.config && typeof entry.config === "object" && !Array.isArray(entry.config) ? entry.config : {}),
+    ...buildPluginConfig(options)
+  };
+
+  if (!Array.isArray(config.plugins.allow)) {
+    config.plugins.allow = [];
+  }
+  if (!config.plugins.allow.includes(PLUGIN_ID)) {
+    config.plugins.allow.push(PLUGIN_ID);
+  }
+  config.plugins.allow = config.plugins.allow.filter((value, index, values) => value !== LEGACY_PLUGIN_ID || values.indexOf(PLUGIN_ID) === -1);
+
+  writeConfig(options.configPath, config);
+
+  console.log(`Updated ${options.configPath}`);
+  console.log(`Configured plugins.entries.${PLUGIN_ID}.enabled = true`);
+  console.log(`Configured plugins.entries.${PLUGIN_ID}.config.otel.endpoint = ${options.endpoint}`);
+  if (options.logs !== undefined) {
+    console.log(`Configured plugins.entries.${PLUGIN_ID}.config.otel.logs = ${String(options.logs)}`);
+  }
+}
+
+main();

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@cnpinsight/cnpclawinsights",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "OpenClaw insights OpenTelemetry exporter",
   "repository": {
     "type": "git",
     "url": "https://github.com/openclaw/openclaw"
   },
   "type": "module",
+  "bin": {
+    "cnpclawinsights-install": "dist/cli.mjs"
+  },
   "dependencies": {
     "@opentelemetry/api": "1.9.1",
     "@opentelemetry/api-logs": "0.218.0",