Crate optick

Optick Profiler - Super Lightweight Performance Profiler

How to use

In Cargo.toml add:

[dependencies]
optick = "1.3.1"

Example usage:

fn calc(n: u32) {
	// Profile current scope (automatically extracts current function name)
	// You could also specify a custom name if needed - e.g. optick::scope!("calc");
    optick::event!();
 
	// Attach custom data tag to the capture (i32, u32, u64, f32, str, vec3)
    optick::tag!("number", n);
    optick::tag!("name", "Bob");
    optick::tag!("position", (10.0f32, -12.0f32, 14.0f32));
 
	...
}
 
pub fn main() {
	// Start a new capture
    optick::start_capture();
     
	calc(42);
 	
	// Stop and save current capture 
    optick::stop_capture("capture_name"); // => Saves capture to {working_dir}/capture_name(date-time).opt
}

GUI

Use Optick GUI to open saved *.opt capture for further analysis: https://github.com/bombomby/optick/releases

Feature flags

• enable - this flag is used by default and enables Optick instrumentation

Run as Administartor to collect ETW events

Optick uses ETW to collect hardware counters: switch-contexts, auto-sampling, CPU core utilization, etc. Run your app as administrator to enable the collection of ETW events:

Start-Process cargo run -Verb runAs

Macros

event	Instrument current scope
function	Extract current function name
tag	Attach custom data to the current scope

Structs

OptickCounter

Scoped event

Traits

OptickTag

Optick Tag

Functions

create_description	Create event description
enabled	Check whether profiler is enabled
next_frame	Mark frame update
pop_event	Pop profiling event
push_event	Push profiling event
register_thread	Register thread for profiling
start_capture	Start a new capture
stop_capture	Stop and save current capture to the specified path