docs(config): Make example in guides/level-up/managing-complex-configs work with Vector 0.18 #10168
Conversation
It is not invalid as of 0.18 but should be. At least lets stop giving such examples.
|
|
|
✔️ Deploy Preview for vector-project ready! 🔨 Explore the source changes: 64c02f1 🔍 Inspect the deploy log: https://app.netlify.com/sites/vector-project/deploys/619e2f5aff984e000732acc5 😎 Browse the preview: https://deploy-preview-10168--vector-project.netlify.app |
There was a problem hiding this comment.
Thanks @ypid-geberit !
Regarding the generated examples showing path and address for the socket source even though they are required differently depending on the mode is something we trying to address by replacing the generated examples with hand-written examples. #9870 was the first stab at it, but we need to revisit it.
…s work with Vector 0.18 (#10168) * docs: For sources in tcp/udp mode, the path param does not make sense It is not invalid as of 0.18 but should be. At least lets stop giving such examples. * docs: Fix typo * docs: Fix example config: encoding.codec is required now for console sink
|
Thanks for merging and linking the other PR. Works for me. Lets improve the docs one step after the other :) |
I am opening this PR to help new users getting into Vector. I actually wanted to fix https://vector.dev/docs/reference/configuration/sinks/socket/#example-configurations, but I assume that is auto generated with all the required options. I don’t know how that can be fixed.
addressandpathare not required in all cases, depending onmode.