transparency-dev / transparency-dev/incubator
[VIndex] Add metrics
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Go
- Stars
- 4
- Forks
- 6
- Avg merge
- 3d 23h
- Merged PRs (30d)
- 3
Description
There are no metrics recorded nor exposed at the moment. We should have some basic ones:
- time since last output log checkpoint update (equivalently, time since last tree update)
- histogram of number of keys updated per batch
- histogram of number of keys returned from map function
Until this bug is closed, feel free to add comments to this requesting other metrics.
Contributor guide
No contributing guide indexed for this repository
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
Locate the VIndex code that updates the output log checkpoint or tree, processes batches, and returns keys from the map function. Read those paths first and identify how metrics are currently exposed, if at all. Done means recording and exposing the three requested measurements: checkpoint age, updated-keys-per-batch histogram, and map-returned-keys histogram.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- observability
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100