Skip to content

cli.md

Latest commit

 

History

History
138 lines (96 loc) · 2.44 KB

cli.md

File metadata and controls

138 lines (96 loc) · 2.44 KB
Raw

Command-Line Interface

The bugdna-cli module analyzes BugDNA fingerprint IDs already present in text log files. It does not parse Java stack traces or generate new fingerprints from raw exception text.

Build

Build the executable JAR:

mvn -pl bugdna-cli clean package

The result is:

bugdna-cli/target/bugdna-cli-1.1.2.jar

Run it directly:

java -jar bugdna-cli/target/bugdna-cli-1.1.2.jar analyze app.log

Repository launcher scripts are also provided:

bin/bugdna analyze app.log

Windows:

bin\bugdna.cmd analyze app.log

Add the repository bin directory to PATH to use the short command:

bugdna analyze app.log

Analyze a Log File

Given a log file containing repeated IDs:

2026-06-12 ERROR [BUGDNA-001] Payment failed
2026-06-12 ERROR [BUGDNA-002] Customer lookup failed
2026-06-12 ERROR [BUGDNA-001] Payment failed

Run:

bugdna analyze app.log

Output:

Unique Failures: 2

BUGDNA-001 : 2
BUGDNA-002 : 1

Results are sorted by occurrence count descending, then fingerprint ID for deterministic ties.

Compare Log Files

Compare an older log with a newer log:

bugdna compare app-v1.log app-v2.log

Output:

New fingerprints: 3
Resolved fingerprints: 7
Recurring fingerprints: 5

New fingerprints counts IDs found only in the newer log. Resolved fingerprints counts IDs found only in the older log. Recurring fingerprints counts IDs present in both logs. Occurrence-count changes do not alter these classifications.

Include deployment versions:

bugdna compare 1.2.0 app-v1.log 1.3.0 app-v2.log
Version 1.2.0 -> Version 1.3.0

New fingerprints: 4
Resolved fingerprints: 12
Recurring fingerprints: 8

Matching Rules

The analyzer:

  • Reads the file as UTF-8
  • Finds every BUGDNA-* hexadecimal token
  • Matches IDs case-insensitively and prints uppercase IDs
  • Counts multiple fingerprint occurrences on the same line
  • Ignores lines without a BugDNA ID

An empty log or a log without fingerprint IDs returns:

Unique Failures: 0

Exit Codes

Code Meaning
0 Analysis completed
2 Invalid command or arguments
3 Invalid or unreadable log file

Invalid usage prints:

Usage:
  bugdna analyze <log-file>
  bugdna compare <old-log-file> <new-log-file>
  bugdna compare <old-version> <old-log-file> <new-version> <new-log-file>