google/benchmark

Memory reporting capabilities are unclear and undocumented.

Open

#1,217 opened on Aug 27, 2021

View on GitHub
 (11 comments) (12 reactions) (1 assignee)C++ (7,968 stars) (1,539 forks)batch import
enhancementgood first issue

Description

I am currently using google/benchmark to benchmark https://github.com/protocolbuffers/upb. I would very much like for those benchmarks to also include memory usage.

Does this project support memory benchmarking? The user guide does not mention memory usage benchmarking at all. However I notice that the header has a RegisterMemoryManager() function, and there is a unit test verifying this functionality.

From running the test, it appears that the memory usage data is surfaced to JSON, but not CSV or console reports. Is this an oversight or intentional? Ideally this data would be shown on CSV and console reports also.

Contributor guide

Tech stack
cpp
Domain
performancedocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C++ programmingGoogle Benchmark library structureUnderstanding of output formats (JSON, CSV, console)
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the benchmark output formatters to understand how memory data is currently emitted in JSON. Then implement changes to include memory usage in CSV and console output formats. Look at benchmark.h for RegisterMemoryManager and test/memory manager test.cc for reference. Ensure the new output is consistent with existing report structure.
Memory reporting capabilities are unclear and undocumented. · google/benchmark#1217 | Good First Issue