@jcit/signoz 0.1.3 → 0.2.0

package/dist/cli.mjs

@@ -2,11 +2,19 @@
 import { createRequire } from 'node:module';
 import { formatOutput, addExamples, credential, installErrorHandler, defineCliApp } from '@jcit/core';
 import { c as createSignozClient } from './shared/signoz.DH9MeMIj.mjs';
+import { Option } from 'commander';
 import { consola } from 'consola';
 import { readFileSync } from 'node:fs';
 
+function addCommonOptions(cmd) {
+  return cmd.addOption(
+    new Option("--format <format>", "Output format: json | table | text").default("json")
+  ).addOption(new Option("--url <url>", "SigNoz API base URL").hideHelp()).addOption(new Option("--token <token>", "SigNoz API token").hideHelp());
+}
+
 function registerAlerts(program) {
-  const cmd = program.command("alerts").description("List all alert rules").option("--format <format>", "Output format: json | table | text", "text").option("--url <url>", "SigNoz API base URL").option("--token <token>", "SigNoz API token").action(async (opts) => {
+  const cmd = program.command("alerts").description("List all alert rules");
+  addCommonOptions(cmd).action(async (opts) => {
     const client = createSignozClient({ url: opts.url, token: opts.token });
     const alerts = await client("/api/v1/rules");
     formatOutput(alerts, opts.format);
@@ -35,6 +43,60 @@ function registerAuth(program) {
   });
 }
 
+const LIST_SQL = `SELECT now() as ts,
+	metric_name, temporality, type, unit,
+	count(*) as value
+FROM signoz_metrics.distributed_metadata
+GROUP BY metric_name, temporality, type, unit
+ORDER BY metric_name`;
+function extractMetrics(result) {
+  const series = result.data?.data?.results?.[0]?.aggregations?.[0]?.series;
+  if (!series) return [];
+  return series.map((s) => {
+    const labels = {};
+    for (const l of s.labels ?? []) {
+      labels[l.key.name] = l.value;
+    }
+    const temporality = labels.temporality ?? "";
+    const promqlOk = temporality === "Cumulative" || temporality === "Unspecified";
+    return {
+      name: labels.metric_name ?? "",
+      temporality,
+      type: labels.type ?? "",
+      unit: labels.unit ?? "",
+      promql: promqlOk ? "yes" : "no"
+    };
+  });
+}
+function registerMetrics(program) {
+  const cmd = program.command("metrics").description("List available metrics with temporality and type");
+  addCommonOptions(cmd).action(async (opts) => {
+    const client = createSignozClient({ url: opts.url, token: opts.token });
+    const now = Date.now();
+    const result = await client("/api/v5/query_range", {
+      method: "POST",
+      body: {
+        schemaVersion: "v1",
+        start: now - 36e5,
+        end: now,
+        requestType: "time_series",
+        compositeQuery: {
+          queries: [
+            { type: "clickhouse_sql", spec: { name: "A", query: LIST_SQL, disabled: false } }
+          ]
+        }
+      }
+    });
+    const metrics = extractMetrics(result);
+    if (opts.format === "json") {
+      formatOutput(metrics, "json");
+    } else {
+      formatOutput(metrics, opts.format);
+    }
+  });
+  addExamples(cmd, ["signoz metrics", "signoz metrics --format table"]);
+}
+
 const DURATION_RE = /^(\d+)(s|m|h|d)$/;
 const UNITS = {
   s: 1e3,
@@ -59,19 +121,30 @@ function parseUntil(input) {
   if (input === "now") return Date.now();
   return parseSince(input);
 }
+function injectTimeVars(sql, startMs, endMs) {
+  const startS = Math.floor(startMs / 1e3);
+  const endS = Math.floor(endMs / 1e3);
+  const startNs = BigInt(startMs) * 1000000n;
+  const endNs = BigInt(endMs) * 1000000n;
+  return sql.replaceAll("{{start_ms}}", String(startMs)).replaceAll("{{end_ms}}", String(endMs)).replaceAll("{{start_s}}", String(startS)).replaceAll("{{end_s}}", String(endS)).replaceAll("{{start_ns}}", String(startNs)).replaceAll("{{end_ns}}", String(endNs));
+}
 
 function buildPromqlRequest(query, start, end, step) {
   return {
+    schemaVersion: "v1",
     start,
     end,
     requestType: "time_series",
     compositeQuery: {
-      queries: [{ type: "promql", spec: { name: "A", query, step, disabled: false } }]
+      queries: [
+        { type: "promql", spec: { name: "A", query, step, disabled: false, stats: false } }
+      ]
     }
   };
 }
 function buildSqlRequest(query, start, end) {
   return {
+    schemaVersion: "v1",
     start,
     end,
     requestType: "time_series",
@@ -80,8 +153,14 @@ function buildSqlRequest(query, start, end) {
     }
   };
 }
+function isEmptyResult(res) {
+  const results = res.data?.data?.results;
+  if (!results) return true;
+  return results.every((r) => !r.aggregations?.some((a) => a.series && a.series.length > 0));
+}
 function registerQuery(program) {
-  const cmd = program.command("query").description("Query traces, logs, and metrics via the unified query API").option("--promql <expr>", "PromQL expression").option("--sql <query>", "ClickHouse SQL query (must include timestamp WHERE clause)").option("-f, --file <path>", "Load query from JSON file (v5 query_range format)").option("--since <time>", "Start time: duration ago (1h, 30m, 7d) or ISO date", "1h").option("--until <time>", "End time: 'now', duration ago, or ISO date", "now").option("--step <seconds>", "Step interval in seconds (PromQL only)", "60").option("--format <format>", "Output format: json | table | text", "json").option("--url <url>", "SigNoz API base URL").option("--token <token>", "SigNoz API token").action(async (opts) => {
+  const cmd = program.command("query").description("Query traces, logs, and metrics via the unified query API").option("--promql <expr>", "PromQL expression").option("--sql <query>", "ClickHouse SQL query (use {{start_ms}} etc. for time injection)").option("-f, --file <path>", "Load query from JSON file (v5 query_range format)").option("--since <time>", "Start time: duration ago (1h, 30m, 7d) or ISO date", "1h").option("--until <time>", "End time: 'now', duration ago, or ISO date", "now").option("--step <seconds>", "Step interval in seconds (PromQL only)", "60");
+  addCommonOptions(cmd).action(async (opts) => {
     const modes = [opts.promql, opts.sql, opts.file].filter(Boolean);
     if (modes.length === 0) {
       cmd.error("specify one of --promql, --sql, or --file");
@@ -100,9 +179,10 @@ function registerQuery(program) {
       }
       body = buildPromqlRequest(opts.promql, start, end, step);
     } else if (opts.sql) {
-      body = buildSqlRequest(opts.sql, start, end);
+      body = buildSqlRequest(injectTimeVars(opts.sql, start, end), start, end);
     } else {
       body = JSON.parse(readFileSync(opts.file, "utf-8"));
+      body.schemaVersion ??= "v1";
       body.start = start;
       body.end = end;
     }
@@ -111,17 +191,23 @@ function registerQuery(program) {
       body
     });
     formatOutput(result, opts.format);
+    if (opts.promql && isEmptyResult(result)) {
+      consola.warn(
+        'PromQL returned no data. Common causes:\n  \u2022 Delta-temporality metrics (e.g. signoz_calls_total) are not queryable via PromQL \u2014 use --sql or the builder API instead\n  \u2022 OTel dot-separated names require {__name__="metric.name"} syntax'
+      );
+    }
   });
   addExamples(cmd, [
+    `signoz query --promql '{__name__="http.client.request.duration.bucket"}' --since 1h`,
     "signoz query --promql 'rate(http_requests_total[5m])' --since 1h",
     "signoz query --sql 'SELECT count(*) FROM signoz_logs.distributed_logs_v2 WHERE timestamp >= ...'",
-    "signoz query -f my-query.json --since 7d --until 1d",
-    "signoz query --promql 'up' --format table --step 30"
+    "signoz query -f my-query.json --since 7d --until 1d"
   ]);
 }
 
 function registerServices(program) {
-  const cmd = program.command("services").description("List all SigNoz services").option("--format <format>", "Output format: json | table | text", "text").option("--url <url>", "SigNoz API base URL").option("--token <token>", "SigNoz API token").action(async (opts) => {
+  const cmd = program.command("services").description("List all SigNoz services");
+  addCommonOptions(cmd).action(async (opts) => {
     const client = createSignozClient({ url: opts.url, token: opts.token });
     const services = await client("/api/v1/services/list");
     formatOutput(services, opts.format);
@@ -140,6 +226,7 @@ const program = defineCliApp({
 });
 registerAuth(program);
 registerQuery(program);
+registerMetrics(program);
 registerAlerts(program);
 registerServices(program);
 program.parseAsync();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jcit/signoz",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "CLI for SigNoz observability platform",
   "repository": {
     "type": "git",