weaselab/weaseldb
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve metric.hpp documentation

Browse Source
This commit is contained in:
Andrew Noyes
2025-08-31 14:39:24 -04:00
parent b6809d8700
commit 58649103e5
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/metric.hpp
View File

@@ -164,7 +164,6 @@ private:
}; };
// Factory functions for creating metric families // Factory functions for creating metric families
// IMPORTANT: name and help must point to static memory (string literals)
// Create counter family (monotonically increasing values) // Create counter family (monotonically increasing values)
// ERROR: Aborts if family with same name is registered with different help // ERROR: Aborts if family with same name is registered with different help
@@ -205,9 +204,9 @@ std::vector<double> exponential_buckets(double start, double factor, int count);
// Returns chunks of Prometheus exposition format (includes # HELP and # TYPE // Returns chunks of Prometheus exposition format (includes # HELP and # TYPE
// lines) Each string_view may contain multiple lines separated by '\n' String // lines) Each string_view may contain multiple lines separated by '\n' String
// views are NOT null-terminated - use .size() for length All string data // views are NOT null-terminated - use .size() for length All string data
// allocated in provided arena for zero-copy efficiency // allocated in provided arena for zero-copy efficiency. The caller is
// TODO: Implement Prometheus text exposition format // responsible for the arena's lifecycle. THREAD SAFETY: Serialized by global
// THREAD SAFETY: Serialized by global mutex - callbacks need not be thread-safe // mutex - callbacks need not be thread-safe
std::span<std::string_view> render(ArenaAllocator &arena); std::span<std::string_view> render(ArenaAllocator &arena);
// Validation functions for Prometheus compatibility // Validation functions for Prometheus compatibility