Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add subtitles to benchmark charts. #522

Merged
merged 3 commits into from
Dec 11, 2024
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions dev/benchmark-results/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ func buildCharts(inputFile, outputFile string) error {
page.SetLayout("flex")

for _, c := range allCharts {
c.Subtitle = getSubTitle(c.Title)
page.AddCharts(c)
}

Expand Down Expand Up @@ -243,6 +244,21 @@ func shortSHA(sha string) string {
return sha[:7]
}

func getSubTitle(title string) string {
switch {
case strings.HasPrefix(title, "Backfill"):
return "Each line represents the rows per second backfilled for a database with the row count indicated. The x-axis shows the commits to main ordered by time."
case strings.HasPrefix(title, "WriteAmplification/NoTrigger"):
andrew-farries marked this conversation as resolved.
Show resolved Hide resolved
return "Each line represents the rows per second written for a database with the row count indicated. This is a baseline benchmark without the pgroll trigger. The x-axis shows the commits to main ordered by time."
case strings.HasPrefix(title, "WriteAmplification/WithTrigger"):
return "Each line represents the rows per second written for a database with the row count indicated. This is a benchmark with the pgroll trigger installed and should be compared with the WriteAmplification/NoTrigger benchmarks. The x-axis shows the commits to main ordered by time."
case strings.HasPrefix(title, "ReadSchema"):
return "This benchmark shows the executions per second of an important internal SQL function, ReadSchema. The x-axis shows the commits to main ordered by time"
}

return ""
}

type BenchmarkReports struct {
GitSHA string
PostgresVersion string
Expand Down