google/benchmark

Memory reporting capabilities are unclear and undocumented.

Open

#1.217 geöffnet am 27. Aug. 2021

Auf GitHub ansehen
 (11 Kommentare) (12 Reaktionen) (1 zugewiesene Person)C++ (7.968 Stars) (1.539 Forks)batch import
enhancementgood first issue

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
C++ programmingGoogle Benchmark library structureUnderstanding of output formats (JSON, CSV, console)
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40
Research-Richtung
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.