Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
koute committed Aug 18, 2021
1 parent d82a303 commit 010a004
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# A memory profiler for Linux
# Bytehound - a memory profiler for Linux

## Features

Expand All @@ -18,6 +18,9 @@
* Can dynamically stream the profiling data to another machine instead
of saving it locally, which is useful for profiling on memory-constrained systems
* Supports AMD64, ARM, AArch64 and MIPS64 architectures (where MIPS64 requires a tiny out-of-tree kernel patch for `perf_event_open`)
* Supports profiling of applications which use jemalloc as their allocator (only works on AMD64 with the `jemallocator` crate)
* Supports an embedded DSL based on [Rhai](https://rhai.rs) to allow for programmatic
and/or automated data analysis

[Heaptrack GUI]: https://github.com/KDE/heaptrack

Expand Down Expand Up @@ -59,6 +62,10 @@

Then open your Web browser and point it at `https://localhost:8080` to access the GUI.

## Documentation

You can find the full documentation for the profiler in our [Memory profiling for fun and profit](https://koute.github.io/bytehound/) book.

## Enabling full debug logs

By default the profiler is compiled with most of its debug logs disabled for performance reasons.
Expand Down

0 comments on commit 010a004

Please sign in to comment.