Sha256: fafd5b3c8217296b4b7b8b93fb0b4c95317e0e7ed2d8cef738658735b5dbec03
Contents?: true
Size: 1.28 KB
Versions: 34
Compression:
Stored size: 1.28 KB
Contents
Pyroscope Ruby Integration --Beta--
=====================================
**note**: This is a beta release. It requires local compilation, might be
buggy and is frequently updated. For the initial implementation, find it [here](https://github.com/pyroscope-io/pyroscope-ruby). Please report any [issues](https://github.com/pyroscope-io/pyroscope-rs/issues).
## Installation
1. You need the Rust toolchain to compile the library locally. To install
Rust:
```
curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain stable -y
export PATH=$PATH:/root/.cargo/bin
```
2. Building/Insalling from Rubygems
```
gem install pyroscope_beta
```
3. Building/Installing from source
Change directory to `pyroscope_ffi/ruby` and run
```
gem build pyroscope.gemspec
gem install ./pyroscope.gemspec
```
## Configuration
Configuration is similar to the old package except for `application_name`:
```
require 'pyroscope_beta'
Pyroscope.configure do |config|
config.application_name = "ruby.app"
config.server_address = "http://localhost:4040"
config.detect_subprocesses = true
config.tags = {
:key => "value",
}
end
```
## Adding tags
Tags passed to configure are global. To tag code locally, you can use:
```
Pyroscope.tag_wrapper({"profile": "profile-1"}) do
// Tagged profile
end
```
Version data entries
34 entries across 34 versions & 2 rubygems