Installation

Tracelet v0.1.0 is published as prebuilt archives on GitHub Releases.

Each archive has a sibling .sha256 file.

macOS and LinuxCopy Anchor Link

curl -fsSL https://github.com/SATVIKsynopsis/Tracelet/releases/latest/download/install.sh | sh

The installer:

1. detects the OS with uname -s and the architecture with uname -m;
2. downloads otel-test-<target>.tar.gz and its .sha256 file with curl (or wget);
3. compares the SHA-256 with sha256sum (or shasum) and stops on a mismatch;
4. copies otel-test to ~/.local/bin, and tells you if that directory isn't on your PATH.

It reads two environment variables. Because the script runs in sh, set them for sh:

curl -fsSL https://github.com/SATVIKsynopsis/Tracelet/releases/latest/download/install.sh \
  | OTEL_TEST_VERSION=v0.1.0 OTEL_TEST_INSTALL_DIR=/usr/local/bin sh

If ~/.local/bin isn't on your PATH, add it to your shell profile:

export PATH="$HOME/.local/bin:$PATH"

WindowsCopy Anchor Link

The shell installer exits with an error on Windows. Download the .zip from the release instead. In PowerShell:

Invoke-WebRequest -OutFile otel-test.zip `
  https://github.com/SATVIKsynopsis/Tracelet/releases/download/v0.1.0/otel-test-x86_64-pc-windows-msvc.zip
Expand-Archive otel-test.zip -DestinationPath .
.\otel-test-x86_64-pc-windows-msvc\otel-test.exe --version

Move otel-test.exe to a directory on your PATH. To check the archive, compare (Get-FileHash otel-test.zip -Algorithm SHA256).Hash with the release's .zip.sha256 file.

From sourceCopy Anchor Link

Building from source needs Rust 1.88 or newer:

git clone https://github.com/SATVIKsynopsis/Tracelet.git
cd Tracelet
cargo install --path crates/otel-test-cli

Verify the installCopy Anchor Link

otel-test --version

otel-test 0.1.0

The Collector binaryCopy Anchor Link

otel-test doesn't bundle the Collector. The first command that needs one (test or validate) downloads otelcol-contrib v0.164.0 for your platform (about 100 MB). Before it is unpacked, the download is checked against a SHA-256 compiled into otel-test. The binary is then cached:

While downloading, it prints:

Downloading otelcol-contrib 0.164.0 (darwin_arm64) and verifying its SHA-256…

Checksums are compiled in for darwin_amd64, darwin_arm64, linux_386, linux_amd64, linux_arm64, linux_armv7, linux_ppc64le, linux_riscv64, linux_s390x, windows_386, windows_amd64 and windows_arm64.

To use a Collector you already have instead:

otel-test test --collector-bin /usr/local/bin/otelcol-contrib
# or
export OTEL_TEST_COLLECTOR_BIN=/usr/local/bin/otelcol-contrib

A custom build works if it includes the otlp receiver and the otlp_http exporter (or otlphttp on older builds). If it also includes the health_check extension, Tracelet uses it to check readiness.

Pass --offline to forbid the download. If the Collector isn't cached, the command fails with exit code 4.