rillrate icon indicating copy to clipboard operation
rillrate copied to clipboard

Add documentation

Open eze-kiel opened this issue 4 years ago • 1 comments

Currently the documentation on Rillrate website is empty. As a Rust newbie, I would love to have more infos, at least about how to get started.

Thanks ! :chart_with_upwards_trend: :crab:

image

eze-kiel avatar Oct 14 '21 07:10 eze-kiel

For anyone trying to get the readme example to work, I had to clone the repo and install from master ('trunk') Since I couldn't find the FlowMode enum in 0.41.0, the latest version from cargo.

    rillrate::install("my-app");
    let tracer = rillrate::prime::Pulse::new(
        "package.dashboard.group.tracer-name",
        rillrate::core::FlowMode::Realtime,
        rillrate::prime::PulseOpts::default().min(0).max(50).higher(true)
    );

Is what my Example looked like with qualified names.

Then I had to visit port 6361 for the dashboard (took me 10 minutes to find the port number -_- )

aprowe avatar Nov 17 '21 09:11 aprowe