Skip to content

Add offheap memory tracking to Bench YAML reports #671

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.

Sign up for GitHub

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

Open
MarkWolters wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add offheap memory tracking to Bench YAML reports #671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 12 additions & 6 deletions jvector-examples/src/main/java/io/github/jbellis/jvector/example/benchmarks/QueryTester.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,17 +98,23 @@ public List<Metric> run(
diagnostics.capturePostPhaseSnapshot("Query");

// Add memory and disk metrics to results
var systemSnapshot = diagnostics.getLatestSystemSnapshot();
// Get both pre and post snapshots to calculate maximum memory usage
var preSnapshot = diagnostics.getPrePhaseSystemSnapshot();
var postSnapshot = diagnostics.getLatestSystemSnapshot();
var diskSnapshot = diagnostics.getLatestDiskSnapshot();

if (systemSnapshot != null) {
// Max heap usage in MB
if (preSnapshot != null && postSnapshot != null) {
// Calculate max heap usage across pre and post snapshots
long maxHeapUsed = Math.max(preSnapshot.memoryStats.heapUsed,
postSnapshot.memoryStats.heapUsed);
results.add(Metric.of("search.system.max_heap_mb", "Max heap usage (MB)", ".1f",
systemSnapshot.memoryStats.heapUsed / (1024.0 * 1024.0)));
maxHeapUsed / (1024.0 * 1024.0)));

// Max off-heap usage (direct + mapped) in MB
// Calculate max off-heap usage (direct + mapped) across pre and post snapshots
long maxOffHeapUsed = Math.max(preSnapshot.memoryStats.getTotalOffHeapMemory(),
postSnapshot.memoryStats.getTotalOffHeapMemory());
results.add(Metric.of("search.system.max_offheap_mb", "Max offheap usage (MB)", ".1f",
systemSnapshot.memoryStats.getTotalOffHeapMemory() / (1024.0 * 1024.0)));
maxOffHeapUsed / (1024.0 * 1024.0)));
}

if (diskSnapshot != null) {
Expand Down
7 changes: 7 additions & 0 deletions ...n/java/io/github/jbellis/jvector/example/benchmarks/diagnostics/BenchmarkDiagnostics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,13 @@ public SystemMonitor.SystemSnapshot getLatestSystemSnapshot() {
return snapshots.isEmpty() ? null : snapshots.get(snapshots.size() - 1);
}

/**
* Gets the pre-phase system snapshot (second to last), or null if not available
*/
public SystemMonitor.SystemSnapshot getPrePhaseSystemSnapshot() {
return snapshots.size() < 2 ? null : snapshots.get(snapshots.size() - 2);
}

/**
* Gets the latest disk usage snapshot, or null if none captured
*/
Expand Down
2 changes: 1 addition & 1 deletion jvector-examples/yaml-configs/run-config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ console:
count: [ visited ] # [visited, expanded, expanded base layer]
accuracy: [ recall ] # [recall, MAP]
metrics:
system: [ max_heap_mb ] # [ max_heap_mb, max_offheap_mb ]
system: [ max_heap_mb, max_offheap_mb ] # [ max_heap_mb, max_offheap_mb ]
# disk: total_file_size_mb # [ total_file_size_mb, file_count ]
# construction: index_build_time_s # [ index_build_time_s, index_quant_time_s, search_quant_time_s ]

Expand Down
Loading