pyroscope_beta 0.1.4 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3c7eafd4afc7874abb603bf1e90beef62ed3d67242b9a8f447de91eb5e0b07e9
4
- data.tar.gz: 2afee9302648b2e31124c12d858cb9ef2569b32853253e88ff04cea8c94a11f0
3
+ metadata.gz: 1ed92a6ebe4f73b663e77c992950ec3e8608fa33d34c756aace54a3b0629b71a
4
+ data.tar.gz: 70c19cc237afaea2b4c90bd563df0f1d326849a0e0f304690c72df64e13ec002
5
5
  SHA512:
6
- metadata.gz: 14cb359c5250dfd8b980f63dc80eb3b64ad970bbdc0e4e112d6030b3df607194c17d3793b992a3d5e6e56cd29d7c35572e7ded9411f15096e6ba50f311d44d06
7
- data.tar.gz: 02dca542a440a1f0b421286df0563a411fb8f4500cfd8d1201177d3dff074a854a34d9a51af851d0884a19bc5d9db340836bf0410fff0b643dd1df5bf779c5ef
6
+ metadata.gz: 84b0db48c1125447a061ac0fc3f9bb27dacf3909b39ab51cc49daf161c9b1cbb3a6de49726764fc5a6b8467911fec6c5b12f02f7c9211765712b829f72cf0f98
7
+ data.tar.gz: 03e1ba52e9a92556b05d82aa2b1d98199cdbf185b284ff71ac433656eb46e299ee214ee04d28f90212adf709c9a20f027a35d10d53918a8c5a2a43a53ba9209c
data/README.md CHANGED
@@ -1,9 +1,57 @@
1
- Building
1
+ Pyroscope Ruby Integration --Beta--
2
+ =====================================
3
+
4
+ **note**: This is a beta release. It requires local compilation, might be
5
+ 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).
6
+
7
+ ## Installation
8
+
9
+ 1. You need the Rust toolchain to compile the library locally. To install
10
+ Rust:
11
+
12
+ ```
13
+ curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain stable -y
14
+ export PATH=$PATH:/root/.cargo/bin
15
+ ```
16
+
17
+ 2. Building/Insalling from Rubygems
18
+
19
+ ```
20
+ gem install pyroscope_beta
21
+ ```
22
+
23
+ 3. Building/Installing from source
24
+
25
+ Change directory to `pyroscope_ffi/ruby` and run
26
+
2
27
  ```
3
28
  gem build pyroscope.gemspec
29
+ gem install ./pyroscope.gemspec
30
+ ```
31
+
32
+ ## Configuration
33
+
34
+ Configuration is similar to the old package except for `application_name`:
35
+
36
+ ```
37
+ require 'pyroscope_beta'
38
+
39
+ Pyroscope.configure do |config|
40
+ config.application_name = "ruby.app"
41
+ config.server_address = "http://localhost:4040"
42
+ config.detect_subprocesses = true
43
+ config.tags = {
44
+ :key => "value",
45
+ }
46
+ end
4
47
  ```
5
48
 
6
- Install
49
+ ## Adding tags
50
+
51
+ Tags passed to configure are global. To tag code locally, you can use:
52
+
7
53
  ```
8
- gem install ./pyroscope.gem
54
+ Pyroscope.tag_wrapper({"profile": "profile-1"}) do
55
+ // Tagged profile
56
+ end
9
57
  ```