Skip to content

Guide: Compiling Vector with local changes to VRL

Jump to bottom
neuronull edited this page Sep 13, 2023 · 1 revision

This guide describes the steps needed to compile VRL locally and use that in the compilation of Vector.

  1. Clone the VRL repo to your workspace directory, alongside your copy of the Vector repo.

  2. Open the git log and search for “Prepare for” or “release” , look for the most recent commit such as: eeb2736cb - (HEAD) chore: prepare for 0.6.0 release (#364) (6 weeks ago)

  3. This should generally line up with the latest published release of the VRL crate , but double check the Version of the crate that is specified in the dep listing for VRL in the Vector Cargo.toml files.

  4. Checkout that commit in the VRL clone.

  5. In Vector, edit the Cargo.toml files in the repo that specify the vrl crate. At the time of this writing this includes:

    • Cargo.toml

    • lib/codecs/Cargo.toml

    • lib/vector-core/Cargo.toml

The edit to make is to specify the path to your checkout of the VRL repo:

-vrl = { version = "0.6.0", features = ["cli", "test", "test_framework", "arbitrary"] }
+vrl = { version = "0.6.0", features = ["cli", "test", "test_framework", "arbitrary"], path = "../vrl" }
  1. Build Vector. This should work. 🙏
Clone this wiki locally