vectordotdev / vectordotdev/vector
Add healthchecks for transforms
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 22.6k
- Forks
- 2.3k
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 146
Description
Some of our transforms need to fetch data from external systems. This means the data may not be available by the time the first event comes through the system. Currently, the behavior is to just let the event pass through without enriching it. To avoid this we can instead add healthchecks for these transforms that will block the topology from being ready until data is available. This achieves the proper healthcheck requirement but will also provide a much more consistent experience for users.
We most likely want to update the TransformConfig trait to add a healthcheck method that has a default implementation that always resolves to ready.
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 with the TransformConfig trait and inspect the transform implementations that fetch data from external systems. Define how the default healthcheck reports readiness and how those transforms block topology readiness until their data is available; verify the behavior with the relevant existing transform or topology tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- backend, observability
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100