Expose structured stats to application
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- C
- Stars
- 732
- Forks
- 67
- PR merge metrics
- No merged PRs in 30d
Description
Feature request: An application may need to monitor splinterdb stats and do its own processing on that data (e.g. push data to an external metrics aggregator, expose data in a UI, etc).
Possible solution: We could add a simple API in the splinterdb.h layer that allows the application to retrieve stats, for example something roughly like
typedef struct {
... // contains numeric fields for the various stats
// that get printed by the current stats-printing code
} splinterdb_stats;
void splinterdb_stats_get(splinterdb *kvs, splinterdb_stats *stats_out);
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in splinterdb.h and locate the current stats-printing code to identify the numeric fields exposed there. Define the structured stats API around those values, then verify that an application can retrieve the same statistics for its own processing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- databases, observability
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100