vectordotdev / vectordotdev/vector
Building a source/transform/sink guide
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 22.6k
- Forks
- 2.3k
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 146
Description
This is a follow up to https://github.com/timberio/vector/issues/558#issuecomment-543372635. It'd be helpful if we had simple guides that new contributors could follow to build "Hello World" style sinks and then progress into more advanced concepts (batching, partitioning, health checks, etc).
In addition, timberio/vector#1041 would be a good issue to formalize for anyone wanting to add a new scripting language.
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 by reading the linked issue comment and issue #1041, then review how Vector organizes source, transform, and sink contributions. The guide should take new contributors from a Hello World sink through batching, partitioning, and health checks, while clarifying the scripting-language contribution path.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100