vector
vector copied to clipboard
vectordotdev
Documentation of output types for sources that support codecs is inaccurate
A note for the community
- Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
- If you are interested in working on this issue or have submitted a pull request, please leave a comment
Problem
Sources that support codecs, generally, support emitting any data type but the docs for these sources generally only document support for emitting logs.
Example, kafka source:
The kafka source supports codecs and so can emit any data type (log, metric, or trace).
Configuration
No response
Version
n/a
Debug Output
No response
Example Data
No response
Additional Context
No response
References
- https://github.com/vectordotdev/vector/discussions/21027#discussion-7025391
Idea: We can probably automate this based on the inputs() and outputs() implementations and make it a part of component docs generation.
Edit: This might be challenging since some components delegate to the codecs and we have to inspect what the codecs support. A manual audit is probably good enough given the ROI here.
