Repository navigation
docs(transform-vrl): correct docs against the code - #151
Merged
Merged
Conversation
Corrects md files and config.example.yaml to match the code, scalo-rs at the Cargo.lock version, dfe-infra and hyperi-ci. - config-check exits 2 with --config after the subcommand. --config goes before config-check. cargo run needs --bin because there is also a pgo-driver binary. - --run-ignored needs a value, so the full tier is --run-ignored all --ignore-default-filter. - The idle gate wakes on a config-file change or SIGHUP, never on a program written into transforms.dir. - The env table lists all 21 flat names. The double-underscore form reaches every key. DFE_TRANSFORM_VRL_CONFIG reaches neither cascade. - The contract's one writable path is the DLQ directory. Outside the image, the DLQ needs a writable dlq.file.path. - Remove references to Format auto-sensing, FormatDetector, a /config route, a dfe-docker infra profile, skip_if_no_kafka callers and the splack chart. None exist. - The internals.md transform example failed to compile with E651. Its Rust snippets did not match compile_vrl or run_vrl. - CONTRIBUTING links the DCO 1.1 text. A release needs the Release: true trailer. revert bumps a patch. - Counts, sizes and version literals point at the file that owns them.
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.
README.md, CONTRIBUTING.md, SECURITY.md and every page under docs/ now match the code. So do the two filebeat READMEs, tests/TESTING.md and config.example.yaml's comments. They also match scalo-rs v2.14.30, vrl 0.35.0, hyperi-ci, dfe-infra, dfe-docker and the development build's binary.
The ledger has 235 rows: PASS 132, FAIL 93, UNCHECKABLE 10. Some rows group similar claims. All 93 FAIL rows are fixed or cut. Of those, 13 fix prose and 9 remove stale numbers or versions.
UNCHECKABLE rows are design rationale, Vector's own behaviour, or claims nothing in the repo measures.
dfe-transform-vrl config-check --config config.yamlexits 2.--configgoes before the subcommand.cargo runneeds--binto distinguish it frompgo-driver.--run-ignoredwith no value exits 2. The full tier is--run-ignored all --ignore-default-filter.transforms.diralone does not wake the gate.DFE_TRANSFORM_VRL_CONFIGreaches neither cascade.dlq.file.path.FormatDetector, the/configroute, dfe-docker'sinfraprofile, askip_if_no_kafka!caller and a splack chart are cut. None exists.compile_vrlnorrun_vrl.Release: truetrailer or afrom-headdispatch.revertbumps a patch.docs:and carries no release trailer.93 corrected rows
cargo build --releasewith no prerequisitesrdkafka-sysversionconfig-check --config config.yaml--config config.yaml config-checkdlq.file.pathmust be writablerevert"Varies"Release: truetrailer or afrom-headdispatch--run-ignored--run-ignored all --ignore-default-filtercargo run -- config-check --config ...cargo run --bin dfe-transform-vrl -- --config ... config-checkskip_if_no_kafka!()--run-ignoredand a broker--run-ignored alloronly, live broker firstchecked_in_dockerfile_matches_emit_dockerfilefails on itmemory/configdumpconfig-checkdumpengine::budgetemit-dockerfilecommanddlqmemoryrun_appdoesDFE_TRANSFORM_VRL_CONFIG)ServiceAppwiringFormatDetectoremit-dockerfileand the smoke testemit-contractprints itemit-contractprints themKafkaTransport::send(), box characterssend_batchper block, a listvrl::compiler::compile(source, &stdlib::all())compile_vrlruntime.resolve(&mut target, &program)run_vrlwith UTC and panic handling.labels.env ?? "unknown"(E651)string(.labels.env) ?? "unknown"max_chunk_sizeenv only--configor envmemorymax_chunk_sizevia the env layerdlq.*, sink transport and endpoint, enrichment tablesskip_if_no_kafka!()connectivityalpine/openssl:3.5.9skip_if_no_kafka!,ensure_docker_infraensure_kafka_or_skip!--fetch_testdata.pyACCEPTED_MISMATCHESin filebeat_pipeline.rstests/common/filebeat.rs--.envalways a layer--configmemorywithout a warning