perf_tools

# perf-tools

An assortment of tools to track resources in Crystal applications.

## Usage

To log the number of allocations, objects, their sizes, or their linking graph:

```crystal
require "perf_tools/mem_prof"

PerfTools::MemProf.log_object_counts(STDOUT)
PerfTools::MemProf.log_object_sizes(STDOUT)
PerfTools::MemProf.log_allocations(STDOUT)
PerfTools::MemProf.pretty_log_allocations(STDOUT)
PerfTools::MemProf.pretty_log_object_graph(STDOUT)
```

To log all fibers:

```crystal
require "perf_tools/fiber_trace"

PerfTools::FiberTrace.log_fibers(STDOUT)
PerfTools::FiberTrace.pretty_log_fibers(STDOUT)
```

To print the runtime status of execution contexts and fibers:

```crystal
require "perf_tools/scheduler_trace"

PerfTools::SchedulerTrace.print_runtime_status
PerfTools::SchedulerTrace.every(5.seconds)
PerfTools::SchedulerTrace.on(Signal::USR1, details: true)
```

And for a full runtime status, with the yield stack of suspended fibers:

```crystal
require "perf_tools/fiber_trace"
require "perf_tools/scheduler_trace"

PerfTools::SchedulerTrace.print_runtime_status(details: true)
```

Check each tool's instructions for more information.

## Installation

Add this to your application's `shard.yml`:

```yml
development_dependencies:
  perf_tools:
    github: crystal-lang/perf-tools
```

## Contributing

1. Fork it ( <https://github.com/crystal-lang/perf-tools/fork> )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request