Repository navigation
docs(readme): explain the supervisor, build and config - #157
Merged
Merged
Conversation
The README opens with the supervisor's role around Vector, the build, the two transports and the config cascade in about 530 words. Endpoints, the metrics merge, reload and the chart stay in docs/internals.md. The README links there. The working guide moved to CONTRIBUTING.md. The crate description matches the GitHub description.
The cascade now lists the working directory's .env between the environment and the config file. The readiness row says /readyz proves the child is alive after spawn and the sink isn't stalled. It proves nothing about traffic. The docs site link is an autolink for markdownlint.
The bite table wrongly says a ${VAR} credential reaches the broker. The loader refuses any credential holding ${ before Vector starts.
The version pin, unwired config key and auto-commit rows describe current behaviour. Old measurements and dates are removed.
The README says hot reload needs enabling. Changes that fail validation are never sent. It names metrics.vector_metrics_address as the exporter address setting. The address stays on loopback.
The validator note counts eight ignored cases across two files. The lag-trigger row says the default scales on CPU alone. A deployment can add a pressure trigger through keda.extraTriggers if needed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README opens with the supervisor's role around Vector, the build, the two transports and the config cascade in about 530 words. Endpoints, the metrics merge, reload and the chart stay in docs/internals.md. The README links there.
The working guide moved to CONTRIBUTING.md. The crate description matches the GitHub description.