@opscompass/skills 0.1.0

package/skills/opscompass-resources/scripts/summarize_latest_configuration.js

@@ -0,0 +1,254 @@
+import { readFileSync } from "node:fs";
+import { isMainModule } from "../.opscompass-runtime/tools/cli-entrypoint.js";
+const COMMON_DOC_KEYS = [
+    "hostname",
+    "name",
+    "type",
+    "platform",
+    "version",
+    "edition",
+    "created",
+    "mostRecentCollection",
+    "lastSampleDate",
+    "dbid",
+    "engine",
+    "engineVersion",
+    "instanceType",
+    "size",
+];
+function parseArgs(argv) {
+    const args = { top: 5, input: null };
+    for (let i = 0; i < argv.length; i += 1) {
+        if (argv[i] === "--input") {
+            if (++i >= argv.length)
+                throw new Error("argument --input: expected one argument");
+            args.input = argv[i];
+        }
+        else if (argv[i] === "--top") {
+            if (++i >= argv.length)
+                throw new Error("argument --top: expected one argument");
+            args.top = Number(argv[i]);
+            if (!Number.isInteger(args.top))
+                throw new Error(`argument --top: invalid int value: '${argv[i]}'`);
+        }
+        else if (argv[i] === "--help" || argv[i] === "-h") {
+            console.log("Summarize OpsCompass get-latest-configuration output.");
+            process.exit(0);
+        }
+        else
+            throw new Error(`unrecognized arguments: ${argv[i]}`);
+    }
+    return args;
+}
+async function loadPayload(filePath) {
+    if (filePath)
+        return JSON.parse(readFileSync(filePath, "utf8"));
+    const chunks = [];
+    for await (const chunk of process.stdin)
+        chunks.push(chunk);
+    return JSON.parse(Buffer.concat(chunks).toString("utf8"));
+}
+export function asConfigList(payload) {
+    if (payload !== null &&
+        typeof payload === "object" &&
+        !Array.isArray(payload))
+        return [payload];
+    if (Array.isArray(payload))
+        return payload.filter((item) => item !== null && typeof item === "object" && !Array.isArray(item));
+    throw new Error("expected a JSON object or array of objects");
+}
+const getDict = (obj, key) => obj[key] !== null && typeof obj[key] === "object" && !Array.isArray(obj[key])
+    ? obj[key]
+    : {};
+export function scalarPreview(value) {
+    if (value === null || value === undefined)
+        return "null";
+    if (typeof value === "boolean")
+        return value ? "true" : "false";
+    const text = String(value);
+    return text.length <= 80 ? text : `${text.slice(0, 77)}...`;
+}
+export function summarizeUsageConcern(name, value) {
+    if (value !== null && typeof value === "object" && !Array.isArray(value)) {
+        const concern = value;
+        const details = [
+            "name",
+            "feature",
+            "product",
+            "option",
+            "pack",
+            "value",
+            "usage",
+            "detected",
+            "isConcerning",
+            "message",
+        ]
+            .filter((key) => Object.hasOwn(concern, key) &&
+            (concern[key] === null || typeof concern[key] !== "object"))
+            .map((key) => `${key}=${scalarPreview(concern[key])}`);
+        return details.length
+            ? `${name}: ${details.join(", ")}`
+            : `${name}: object (${Object.keys(value).length} keys)`;
+    }
+    return `${name}: ${scalarPreview(value)}`;
+}
+export function summarizeOne(cfg, topN) {
+    const lines = [], doc = getDict(cfg, "document");
+    const cfgId = scalarPreview(cfg.id), cfgName = scalarPreview(cfg.name), cfgType = scalarPreview(cfg.type), cfgLocation = scalarPreview(cfg.location), accountId = scalarPreview(cfg.accountId);
+    lines.push(`Resource: ${cfgName} (type=${cfgType}, id=${cfgId})`, `- accountId: ${accountId}`, `- location: ${cfgLocation}`);
+    if (Object.keys(doc).length) {
+        lines.push("- document scalar fields:");
+        let shown = false;
+        for (const key of COMMON_DOC_KEYS)
+            if (Object.hasOwn(doc, key) &&
+                (doc[key] === null || typeof doc[key] !== "object")) {
+                lines.push(`  - ${key}: ${scalarPreview(doc[key])}`);
+                shown = true;
+            }
+        const extras = Object.keys(doc)
+            .filter((key) => !COMMON_DOC_KEYS.includes(key) &&
+            (doc[key] === null || typeof doc[key] !== "object"))
+            .sort();
+        for (const key of extras.slice(0, Math.max(0, topN - (shown ? 3 : 0)))) {
+            lines.push(`  - ${key}: ${scalarPreview(doc[key])}`);
+            shown = true;
+        }
+        if (!shown)
+            lines.push("  - none");
+        const nested = Object.keys(doc)
+            .filter((key) => doc[key] !== null && typeof doc[key] === "object")
+            .sort();
+        if (nested.length) {
+            lines.push("- document nested sections:");
+            for (const key of nested.slice(0, topN)) {
+                const value = doc[key];
+                lines.push(`  - ${key}: ${Array.isArray(value) ? `array (${value.length} items)` : `object (${Object.keys(value).length} keys)`}`);
+            }
+        }
+        const concerns = getDict(doc, "productUsageConcerns");
+        if (Object.keys(concerns).length) {
+            lines.push(`- productUsageConcerns: ${Object.keys(concerns).length} concern(s)`);
+            for (const [name, value] of Object.entries(concerns).slice(0, topN))
+                lines.push(`  - ${summarizeUsageConcern(name, value)}`);
+        }
+        else if (cfgType === "databases/oracle")
+            lines.push("- productUsageConcerns: none");
+        const parameters = getDict(doc, "parameters");
+        if (Object.keys(parameters).length) {
+            const concerning = Object.entries(parameters)
+                .filter((entry) => {
+                const value = entry[1];
+                return (value !== null &&
+                    typeof value === "object" &&
+                    !Array.isArray(value) &&
+                    "isConcerning" in value &&
+                    value.isConcerning === true);
+            })
+                .map(([name, value]) => [name, scalarPreview(value.value)]);
+            lines.push(`- parameters: ${Object.keys(parameters).length} total, ${concerning.length} concerning`);
+            if (concerning.length) {
+                lines.push("- concerning parameters:");
+                for (const [name, value] of concerning.slice(0, topN))
+                    lines.push(`  - ${name}: ${value}`);
+            }
+        }
+    }
+    else
+        lines.push("- document: missing or not an object");
+    return lines;
+}
+function bump(map, key) {
+    map.set(key, (map.get(key) || 0) + 1);
+}
+export function summarizeMany(configs, topN) {
+    if (configs.length === 1)
+        return summarizeOne(configs[0], topN).join("\n");
+    const byType = new Map(), byLocation = new Map(), scalarByType = new Map(), params = [], usage = [];
+    for (const cfg of configs) {
+        const type = String(cfg.type || "unknown");
+        bump(byType, type);
+        bump(byLocation, String(cfg.location || "unknown"));
+        const doc = getDict(cfg, "document");
+        if (!scalarByType.has(type))
+            scalarByType.set(type, new Map());
+        for (const [key, value] of Object.entries(doc))
+            if (value === null || typeof value !== "object")
+                bump(scalarByType.get(type), key);
+        const parameterValues = getDict(doc, "parameters");
+        const concerning = Object.values(parameterValues).filter((value) => value !== null &&
+            typeof value === "object" &&
+            !Array.isArray(value) &&
+            "isConcerning" in value &&
+            value.isConcerning === true).length;
+        const name = String(cfg.name || "(unnamed)");
+        if (concerning > 0)
+            params.push([name, concerning]);
+        const concerns = getDict(doc, "productUsageConcerns");
+        if (Object.keys(concerns).length)
+            usage.push([name, Object.keys(concerns).length]);
+    }
+    const mostCommon = (map, limit) => [...map].sort((a, b) => b[1] - a[1]).slice(0, limit);
+    const lines = [
+        `Total configurations: ${configs.length}`,
+        "",
+        "Configurations by type:",
+    ];
+    for (const [key, count] of mostCommon(byType, Infinity))
+        lines.push(`- ${key}: ${count}`);
+    lines.push("", "Top locations:");
+    for (const [key, count] of mostCommon(byLocation, topN))
+        lines.push(`- ${key}: ${count}`);
+    lines.push("", "Document scalar fields commonly present by type:");
+    for (const [type, map] of [...scalarByType].sort((a, b) => a[0].localeCompare(b[0])))
+        lines.push(`- ${type}: ${mostCommon(map, topN)
+            .map(([key]) => key)
+            .join(", ") || "none"}`);
+    lines.push("");
+    if (params.length) {
+        params.sort((a, b) => b[1] - a[1]);
+        lines.push(`Top ${topN} resources by concerning parameter count:`);
+        for (const [name, count] of params.slice(0, topN))
+            lines.push(`- ${name}: ${count}`);
+    }
+    else
+        lines.push("No concerning parameters found in provided configurations.");
+    lines.push("");
+    if (usage.length) {
+        usage.sort((a, b) => b[1] - a[1]);
+        lines.push(`Top ${topN} resources by product usage concern count:`);
+        for (const [name, count] of usage.slice(0, topN))
+            lines.push(`- ${name}: ${count}`);
+    }
+    else
+        lines.push("No product usage concerns found in provided configurations.");
+    lines.push("", "Per-resource snapshots:");
+    for (const cfg of configs.slice(0, topN))
+        for (const line of summarizeOne(cfg, 3))
+            lines.push(line.startsWith("Resource:") ? `- ${line}` : `  ${line}`);
+    return lines.join("\n");
+}
+export async function main(argv = process.argv.slice(2)) {
+    try {
+        const args = parseArgs(argv);
+        if (args.top <= 0) {
+            console.error("Error: --top must be greater than 0.");
+            return 2;
+        }
+        const configs = asConfigList(await loadPayload(args.input));
+        if (!configs.length) {
+            console.log("No configuration objects found.");
+            return 0;
+        }
+        console.log(summarizeMany(configs, args.top));
+        return 0;
+    }
+    catch (error) {
+        console.error(error instanceof SyntaxError
+            ? `Error: invalid JSON: ${error.message}`
+            : `Error: ${error instanceof Error ? error.message : String(error)}`);
+        return 2;
+    }
+}
+if (isMainModule(import.meta.url)) {
+    process.exitCode = await main();
+}

package/skills/opscompass-resources/scripts/summarize_resources_list.js

@@ -0,0 +1,126 @@
+import { readFileSync } from "node:fs";
+import { isMainModule } from "../.opscompass-runtime/tools/cli-entrypoint.js";
+function parseArgs(argv) {
+    const args = { top: 10, input: null };
+    for (let i = 0; i < argv.length; i += 1) {
+        const flag = argv[i];
+        if (flag === "--input") {
+            if (++i >= argv.length)
+                throw new Error("argument --input: expected one argument");
+            args.input = argv[i];
+        }
+        else if (flag === "--top") {
+            if (++i >= argv.length)
+                throw new Error("argument --top: expected one argument");
+            args.top = Number(argv[i]);
+            if (!Number.isInteger(args.top))
+                throw new Error(`argument --top: invalid int value: '${argv[i]}'`);
+        }
+        else if (flag === "--help" || flag === "-h") {
+            console.log("Summarize OpsCompass resources list output.");
+            process.exit(0);
+        }
+        else
+            throw new Error(`unrecognized arguments: ${flag}`);
+    }
+    return args;
+}
+export function loadResources(inputPath, inputText) {
+    const payload = inputPath
+        ? JSON.parse(readFileSync(inputPath, "utf8"))
+        : JSON.parse(inputText ?? "");
+    if (!Array.isArray(payload))
+        throw new Error("expected top-level JSON array.");
+    return payload.filter((item) => item !== null && typeof item === "object" && !Array.isArray(item));
+}
+async function loadResourcesAsync(inputPath) {
+    if (inputPath)
+        return loadResources(inputPath);
+    const chunks = [];
+    for await (const chunk of process.stdin)
+        chunks.push(chunk);
+    return loadResources(null, Buffer.concat(chunks).toString("utf8"));
+}
+const text = (value) => String(value);
+const num = (value) => Number(value || 0);
+const resourceName = (resource) => text(resource.name || "(unnamed)");
+const resourceId = (resource) => text(resource.id || "");
+const nestedId = (value) => value !== null && typeof value === "object"
+    ? value.id
+    : undefined;
+export function summarize(resources, topN) {
+    const byProvider = new Map(), byRegion = new Map(), byAccount = new Map();
+    let changesTotal = 0, complianceTotal = 0;
+    const withChanges = [], withCompliance = [];
+    const bump = (map, key) => {
+        map.set(key, (map.get(key) || 0) + 1);
+    };
+    for (const resource of resources) {
+        const provider = text(resource.cloud_provider || "unknown");
+        const region = text(nestedId(resource.region) || "unknown");
+        const account = text(nestedId(resource.account) || "unknown");
+        const changes = num(resource.unacknowledged_changes), compliance = num(resource.compliance_problems);
+        bump(byProvider, provider);
+        bump(byRegion, region);
+        bump(byAccount, account);
+        changesTotal += changes;
+        complianceTotal += compliance;
+        if (changes > 0)
+            withChanges.push(resource);
+        if (compliance > 0)
+            withCompliance.push(resource);
+    }
+    const sortCounts = (a, b) => b[1] - a[1] || a[0].localeCompare(b[0]);
+    withChanges.sort((a, b) => num(b.unacknowledged_changes) - num(a.unacknowledged_changes));
+    withCompliance.sort((a, b) => num(b.compliance_problems) - num(a.compliance_problems));
+    const lines = [
+        `Total resources: ${resources.length}`,
+        `Total unacknowledged changes: ${changesTotal}`,
+        `Total compliance problems: ${complianceTotal}`,
+        "",
+        "Resources by provider:",
+    ];
+    for (const [key, count] of [...byProvider].sort(sortCounts))
+        lines.push(`- ${key}: ${count}`);
+    lines.push("", "Top regions by resource count:");
+    for (const [key, count] of [...byRegion].sort(sortCounts).slice(0, topN))
+        lines.push(`- ${key}: ${count}`);
+    lines.push("", "Top accounts by resource count:");
+    for (const [key, count] of [...byAccount].sort(sortCounts).slice(0, topN))
+        lines.push(`- ${key}: ${count}`);
+    lines.push("", `Top ${topN} resources by unacknowledged changes:`);
+    if (withChanges.length)
+        for (const item of withChanges.slice(0, topN))
+            lines.push(`- ${resourceName(item)} (id=${resourceId(item)}): ${num(item.unacknowledged_changes)}`);
+    else
+        lines.push("- none");
+    lines.push("", `Top ${topN} resources by compliance problems:`);
+    if (withCompliance.length)
+        for (const item of withCompliance.slice(0, topN))
+            lines.push(`- ${resourceName(item)} (id=${resourceId(item)}): ${num(item.compliance_problems)}`);
+    else
+        lines.push("- none");
+    return lines.join("\n");
+}
+export async function main(argv = process.argv.slice(2)) {
+    try {
+        const args = parseArgs(argv);
+        if (args.top <= 0) {
+            console.error("Error: --top must be greater than 0.");
+            return 2;
+        }
+        const resources = await loadResourcesAsync(args.input);
+        console.log(summarize(resources, args.top));
+        return 0;
+    }
+    catch (error) {
+        if (error instanceof SyntaxError)
+            console.error(`Error: invalid JSON: ${error.message}`);
+        else
+            console.error(`Error: ${error instanceof Error ? error.message : String(error)}`);
+        return 2;
+    }
+}
+if (isMainModule(import.meta.url)) {
+    process.exitCode = await main();
+}

package/skills/opscompass-resources/scripts/tools.js

@@ -0,0 +1,16 @@
+import { buildResourcesCommandTool } from "./build-resources-command.tool.js";
+import { listAndFetchLatestConfigsTool } from "./list-and-fetch-latest-configs.tool.js";
+import { mapOracleWorkloadsToPlatformCpusTool } from "./map-oracle-workloads-to-platform-cpus.tool.js";
+import { opscompassDefaultsTool } from "./opscompass-defaults.tool.js";
+import { opscompassResourcesTool } from "./opscompass-resources.tool.js";
+import { summarizeLatestConfigurationTool } from "./summarize-latest-configuration.tool.js";
+import { summarizeResourcesListTool } from "./summarize-resources-list.tool.js";
+export const tools = [
+    opscompassResourcesTool,
+    buildResourcesCommandTool,
+    listAndFetchLatestConfigsTool,
+    mapOracleWorkloadsToPlatformCpusTool,
+    opscompassDefaultsTool,
+    summarizeLatestConfigurationTool,
+    summarizeResourcesListTool,
+];