Giter Club home page Giter Club logo

wachy's Introduction

wachy

Logo


ย  A dynamic tracing profiler for Linux


Wachy provides a UI for interactive eBPF-based userspace performance debugging. For an overview, see the website: https://rubrikinc.github.io/wachy/. For background see the introductory blog post.

For more details see the guide.

Compatibility

Wachy requires:

  1. Linux 4.6 or later kernel
  2. Traced binary should be in a compiled language, and have debugging symbols

1 is due to availability of certain eBPF features, and 2 is due to the techniques used by wachy (eBPF uprobes and address to line number mappings from debugging symbols). Wachy also supports C++ symbol demangling - it has mostly been tested with C++ binaries. If you'd like demangling support for a new compiled language, please open an issue (note: despite being compiled, Go does not play well with eBPF). If you have ideas on how to do something similar on other platforms or with other unsupported languages, I'm interested in hearing it!

Wachy also currently only supports x86-64 binaries. If you are interested in other architectures, please open an issue.

Install

Download the latest version from the Releases page.

Wachy relies on bpftrace and the following shared libraries to run: libgcc_s, libncursesw. On ubuntu some of these may be installed by default, but to install them all you can run

sudo apt install bpftrace libgcc1 libncursesw5

If you see strange characters in the TUI, ensure your LANG is set correctly, e.g. before starting wachy, run

export LANG=en_US.UTF-8

Compiling

If you want to build wachy from source, it requires the following development packages: libiberty, ncurses, cmake. On ubuntu you can install them with

sudo apt install libiberty-dev libncurses5-dev libncursesw5-dev cmake

You also need Rust installed.

Then build with cargo

cargo build --release
target/release/wachy --help

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as per LICENSE.md, without any additional terms or conditions.

Contributions to this project must be accompanied by a Contributor License Agreement. We use https://cla-assistant.io to automate this process.

wachy's People

Contributors

viveksjain avatar mgaurav avatar cfsnyder avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.