mirror of
https://github.com/KeygraphHQ/shannon.git
synced 2026-04-01 18:30:35 +02:00
## Unified Audit System (v3.0)
- Implemented crash-safe, append-only logging to audit-logs/{hostname}_{sessionId}/
- Added session.json with comprehensive metrics (timing, cost, attempts)
- Agent execution logs with turn-by-turn detail
- Prompt snapshots saved to audit-logs/.../prompts/{agent}.md
- SessionMutex prevents race conditions during parallel execution
- Self-healing reconciliation before every CLI command
## Session Metadata Standardization
- Fixed critical bug: standardized on 'id' field (not 'sessionId') throughout codebase
- Updated: shannon.mjs (recon, report), src/phases/pre-recon.js
- Added validation in AuditSession to fail fast on incorrect field usage
- JavaScript shorthand syntax was causing wrong field names
## Schema Improvements
- session.json: Added cost_usd per phase, removed redundant final_cost_usd
- Renamed 'percentage' -> 'duration_percentage' for clarity
- Simplified agent metrics to single total_cost_usd field
- Removed unused validation object from schema
## Legacy System Removal
- Removed savePromptSnapshot() - prompts now only saved by audit system
- Removed target repo pollution (prompt-snapshots/ no longer created)
- Single source of truth: audit-logs/{hostname}_{sessionId}/prompts/
## Export Script Simplification
- Removed JSON export mode (session.json already exists)
- CSV-only export with clean columns: agent, phase, status, attempts, duration_ms, cost_usd
- Tested on real session data
## Documentation
- Updated CLAUDE.md with audit system architecture
- Added .gitignore entry for audit-logs/
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
151 lines
4.1 KiB
JavaScript
Executable File
151 lines
4.1 KiB
JavaScript
Executable File
#!/usr/bin/env node
|
|
|
|
/**
|
|
* Export Metrics Script
|
|
*
|
|
* Export session metrics from audit logs to CSV format for analysis.
|
|
*
|
|
* Use Cases:
|
|
* - Performance analysis across sessions
|
|
* - Cost tracking and budgeting
|
|
* - Agent success rate analysis
|
|
* - Benchmarking improvements
|
|
*/
|
|
|
|
import chalk from 'chalk';
|
|
import { fs, path } from 'zx';
|
|
import { getSession } from '../src/session-manager.js';
|
|
import { AuditSession } from '../src/audit/index.js';
|
|
|
|
// Parse command-line arguments
|
|
function parseArgs() {
|
|
const args = {
|
|
sessionId: null,
|
|
output: null
|
|
};
|
|
|
|
for (let i = 2; i < process.argv.length; i++) {
|
|
const arg = process.argv[i];
|
|
|
|
if (arg === '--session-id' && process.argv[i + 1]) {
|
|
args.sessionId = process.argv[i + 1];
|
|
i++;
|
|
} else if (arg === '--output' && process.argv[i + 1]) {
|
|
args.output = process.argv[i + 1];
|
|
i++;
|
|
} else if (arg === '--help' || arg === '-h') {
|
|
printUsage();
|
|
process.exit(0);
|
|
} else {
|
|
console.log(chalk.red(`❌ Unknown argument: ${arg}`));
|
|
printUsage();
|
|
process.exit(1);
|
|
}
|
|
}
|
|
|
|
return args;
|
|
}
|
|
|
|
function printUsage() {
|
|
console.log(chalk.cyan('\n📊 Export Metrics to CSV'));
|
|
console.log(chalk.gray('\nUsage: ./scripts/export-metrics.js [options]\n'));
|
|
console.log(chalk.white('Options:'));
|
|
console.log(chalk.gray(' --session-id <id> Session ID to export (required)'));
|
|
console.log(chalk.gray(' --output <file> Output CSV file path (default: stdout)'));
|
|
console.log(chalk.gray(' --help, -h Show this help\n'));
|
|
console.log(chalk.white('Examples:'));
|
|
console.log(chalk.gray(' # Export to stdout'));
|
|
console.log(chalk.gray(' ./scripts/export-metrics.js --session-id abc123\n'));
|
|
console.log(chalk.gray(' # Export to file'));
|
|
console.log(chalk.gray(' ./scripts/export-metrics.js --session-id abc123 --output metrics.csv\n'));
|
|
}
|
|
|
|
// Export metrics for a session
|
|
async function exportMetrics(sessionId) {
|
|
const session = await getSession(sessionId);
|
|
if (!session) {
|
|
throw new Error(`Session ${sessionId} not found`);
|
|
}
|
|
|
|
const auditSession = new AuditSession(session);
|
|
await auditSession.initialize();
|
|
const metrics = await auditSession.getMetrics();
|
|
|
|
return exportAsCSV(session, metrics);
|
|
}
|
|
|
|
// Export as CSV
|
|
function exportAsCSV(session, metrics) {
|
|
const lines = [];
|
|
|
|
// Header
|
|
lines.push('agent,phase,status,attempts,duration_ms,cost_usd');
|
|
|
|
// Phase mapping
|
|
const phaseMap = {
|
|
'pre-recon': 'pre-recon',
|
|
'recon': 'recon',
|
|
'injection-vuln': 'vulnerability-analysis',
|
|
'xss-vuln': 'vulnerability-analysis',
|
|
'auth-vuln': 'vulnerability-analysis',
|
|
'authz-vuln': 'vulnerability-analysis',
|
|
'ssrf-vuln': 'vulnerability-analysis',
|
|
'injection-exploit': 'exploitation',
|
|
'xss-exploit': 'exploitation',
|
|
'auth-exploit': 'exploitation',
|
|
'authz-exploit': 'exploitation',
|
|
'ssrf-exploit': 'exploitation',
|
|
'report': 'reporting'
|
|
};
|
|
|
|
// Agent rows
|
|
for (const [agentName, agentData] of Object.entries(metrics.metrics.agents)) {
|
|
const phase = phaseMap[agentName] || 'unknown';
|
|
|
|
lines.push([
|
|
agentName,
|
|
phase,
|
|
agentData.status,
|
|
agentData.attempts.length,
|
|
agentData.final_duration_ms,
|
|
agentData.total_cost_usd.toFixed(4)
|
|
].join(','));
|
|
}
|
|
|
|
return lines.join('\n');
|
|
}
|
|
|
|
// Main execution
|
|
async function main() {
|
|
const args = parseArgs();
|
|
|
|
if (!args.sessionId) {
|
|
console.log(chalk.red('❌ Must specify --session-id'));
|
|
printUsage();
|
|
process.exit(1);
|
|
}
|
|
|
|
console.log(chalk.cyan.bold('\n📊 Exporting Metrics to CSV\n'));
|
|
console.log(chalk.gray(`Session ID: ${args.sessionId}\n`));
|
|
|
|
const output = await exportMetrics(args.sessionId);
|
|
|
|
if (args.output) {
|
|
await fs.writeFile(args.output, output);
|
|
console.log(chalk.green(`✅ Exported to: ${args.output}`));
|
|
} else {
|
|
console.log(chalk.cyan('CSV Output:\n'));
|
|
console.log(output);
|
|
}
|
|
|
|
console.log();
|
|
}
|
|
|
|
main().catch(error => {
|
|
console.log(chalk.red.bold(`\n🚨 Fatal error: ${error.message}`));
|
|
if (process.env.DEBUG) {
|
|
console.log(chalk.gray(error.stack));
|
|
}
|
|
process.exit(1);
|
|
});
|