feat: add --out-json flag for structured report output#17
Merged
Conversation
sokovmd
requested changes
May 18, 2026
Member
sokovmd
left a comment
There was a problem hiding this comment.
Could you add an example of the JSON output to the PR description?
Contributor
Author
|
Added an |
Member
|
Add example to example |
Member
|
Update README.md and RU.md |
sokovmd
requested changes
May 18, 2026
Member
sokovmd
left a comment
There was a problem hiding this comment.
Update README.md and RU.md
+
and example to https://github.com/pg-tools/pgcompare/tree/main/example
Adds: - example/report.json paired with example/report.html, mirroring its three-query (top_rated_blocked_drivers / latest_ride_status / failed_payments_by_amount) before/after shape so reviewers can see the full ReportData layout produced by --out-json. - README.md and RU.md sections under "Write the report to a custom path" + "Notes / Примечания" covering: the flag is independent of --out, opt-in (no JSON without it), the JSON document is the ReportData struct directly, time.Duration fields serialize as integer nanoseconds via Go's encoding/json, and when set the JSON path is printed as the last stdout line after the HTML path.
Contributor
Author
|
Pushed
Verified |
sokovmd
approved these changes
May 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #5.
Adds an optional
--out-json <path>flag topgcompare run. When omitted, behavior is unchanged. When provided, the fullReportDatais written as pretty-printed JSON next to the existing HTML report.Changes
main.go: new--out-jsoncobra flag; if set, callpgcompare.GenerateJSON(data, flagOutJSON)after the existingGeneratecall and print the JSON path to stdout alongside the HTML path.internal/pgcompare/report.go: addGenerateJSON(data ReportData, outPath string) errorusingencoding/jsonwithMarshalIndent(2-space indent,0644).internal/pgcompare/report_test.go: addTestGenerateJSONthat round-trips a smallReportDataand assertsGeneratedAt,Iterations,Speedups,Before.Stats[0].QueryName, andDiffs[0].QueryNameare present in the JSON.Stats.{Min,Max,P50,P95,P99,Mean,StdDev}aretime.Duration, whichencoding/jsonserializes as int64 nanoseconds — matches the structured-automation use case described in the issue.Example JSON output
The exact values depend on the benchmark run; duration fields are encoded as nanoseconds by Go's
encoding/jsonfortime.Durationvalues.{ "GeneratedAt": "2026-05-18T11:06:00Z", "Iterations": 10, "WarmupIterations": 1, "Concurrency": 1, "Repeats": 1, "Speedups": [ 1.5 ], "Before": { "Phase": "before", "Stats": [ { "QueryName": "q1", "P95": 2000000, "QPS": 0, "ErrorRate": 0, "Errors": null } ], "Plans": [ { "NodeType": "Seq Scan", "RelationName": "", "IndexName": "", "ActualRows": 0, "ActualTotalTime": 0, "Children": null } ] }, "After": { "Phase": "after", "Stats": [ { "QueryName": "q1", "P95": 1000000, "QPS": 0, "ErrorRate": 0, "Errors": null } ], "Plans": [ { "NodeType": "Index Scan", "IndexName": "idx_q1", "ActualRows": 0, "ActualTotalTime": 0, "Children": null } ] }, "Diffs": [ { "QueryName": "q1", "Before": { "NodeType": "Seq Scan" }, "After": { "NodeType": "Index Scan", "IndexName": "idx_q1" }, "Summary": null } ], "Description": null }Verification
Default behavior unchanged: running
pgcompare run --config ... --out report.htmlproduces onlyreport.html.