Skip to main content
v1.0.0 will introduce breaking changes to this documentation
  • Rust version 1.89.0 or higher is required when building from source, run rustup update to update your Rust version. See installing Rust
  • libprotoc version 30.2 or higher is required to run VES. Make sure you have an updated version of Protoc installed. Visit protobuf.dev to install libprotoc.
1

Install the repo locally

Clone the repo locally in $HOME directory, and enter the root directory
git clone https://github.com/H3IMD3LL-Labs-Inc/VES.git
cd VES
To update your current version of VES to try new features, run the following command before each configuration + build
cd VES
git pull origin main
Updating your version from the main repo may introduce breaking changes as this will often contain the latest-unstable version
2

Configure VES before building

Currently, the Core Agent is configured via the TOML configuration file. To set your own configuration options, edit the file located at
cd VES/services/log-collector/src/config
Edit the configuration file based on how you’d like to use the Core Agent. See configuration options
The current version of VES (v0.1.0) does not support does not support configuration at runtime. Ensure you have configured your instance before building.
3

Build an executable binary from your local repo

Go to the repo’s root directory and run the cargo build command to get an executable binary
cd VES
cargo build --release --locked
The --locked when building the source ensures you use the exact dependency version specified in the Cargo.lock file, DO NOT manually edit this file!
4

Run the executable binary 🚀

Go to the executable binary’s location, set execute instructions(for Linux) and run it
  • Linux
  • Windows
Go to the compiled binary location and grant execute permissions
cd target/release
chmod +x ves
Confirm the binary has execute permissions
./ves help
You should see instructions for running the binary in your terminal after running the above command, otherwise the binary does not have execute permissions
Run the binary 🚀
./ves run
You should now have a local running VES (Core Agent) instance! You are now collecting and processing observability data from the source you configured earlier.

​
Best Practices

​
Next Steps

Building from source

Solutions to common issues

Configuration Guides

More on configurion options