pyroscope 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b9a85beabb3eb41ba48eff7a8d46a026f0cc37eff658cf5486d7529722f3743
-  data.tar.gz: 0f20fbd97f3e8214d2d774917a48f05ee40e33fe6d0daa0d00d115363a91a02c
+  metadata.gz: d844d0ba44d32a1201923e772b917ec927b3c95f0e09a051f7d212e33a603d1c
+  data.tar.gz: ebf2419e55b0fb78cdb8701fce737e274215b8dcec1da30c84c3c91b1cd51643
 SHA512:
-  metadata.gz: 047c69379887ac22426dc575fede65b220a52401c6ae1da2c67111581a1e5cb082213fb430390636a5dfacb652ef8760f75354ed1063d2533b5d6dd4c29ba095
-  data.tar.gz: 3fd5552e8c0ab0700e4639c5a7fef16aa1bd24207c26872fdbf071be5128c1c2a89e8ad607d1564ea0fd1f416e0045cb5fe02da408a33a1314e4c934b241a753
+  metadata.gz: 0aa05eaa6246a501c9e41a7843b13dd91fedbb1ec553e79cad75a03760222a3f8d8b292b12a23364b84e066ea8d5114a4d49eff961d78d894de6bc74b86de723
+  data.tar.gz: ac00d00f2daebcfec6e2cd49665f2406e9ebc238805bef87aa69a3d6a98638aef91f02d765bc7708c605e215dda6eac2176cb18139183587ae269b747d5de2f9

data/LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2021 Pyroscope
+   Copyright 2022 Pyroscope
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -1,47 +1,57 @@
-# Pyroscope Ruby Integration
+Pyroscope Ruby Integration --Beta--
+=====================================
 
-### What is Pyroscope
-[Pyroscope](https://github.com/pyroscope-io/pyroscope) is a tool that lets you continuously profile your applications to prevent and debug performance issues in your code. It consists of a low-overhead agent which sends data to the Pyroscope server which includes a custom-built storage engine. This allows for you to store and query any applications profiling data in an extremely efficient and cost effective way. 
+**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:
 
-### How to install Pyroscope for Ruby Applications
-Adding Pyroscope to your Gemfile
 ```
-bundle add pyroscope
+curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain stable -y 
+export PATH=$PATH:/root/.cargo/bin
 ```
 
-### Basic Usage of Pyroscope
+2. Building/Insalling from Rubygems 
+
+```
+gem install pyroscope_beta
 ```
-require 'pyroscope'
 
-Pyroscope.configure do |config|
-  config.application_name = "my.ruby.app" # replace this with some name for your application
-  config.server_address   = "http://my-pyroscope-server:4040" # replace this with the address of your pyroscope server
-end
+3. Building/Installing from source
+
+Change directory to `pyroscope_ffi/ruby` and run
+
+```
+gem build pyroscope.gemspec
+gem install ./pyroscope.gemspec
 ```
 
-### Adding Tags
-Tags allow for users to view their data at different levels of granularity depending on what "slices" make sense for their application. This can be anything from region or microservice to more dynamic tags like controller or api route.
+## Configuration
+
+Configuration is similar to the old package except for `application_name`:
 
 ```
-require 'pyroscope'
+require 'pyroscope_beta'
 
 Pyroscope.configure do |config|
-  config.application_name = "my.ruby.app"
-  config.server_address   = "http://my-pyroscope-server:4040"
-
+  config.application_name = "ruby.app"
+  config.server_address = "http://localhost:4040"
+  config.detect_subprocesses = true 
   config.tags = {
-    "hostname" => ENV["HOSTNAME"],
+    :key => "value",
   }
 end
-
-# You can use a wrapper:
-Pyroscope.tag_wrapper({ "controller": "slow_controller_i_want_to_profile" }) do
-  slow_code
-end
 ```
 
+## Adding tags
 
-### Examples
-For more examples see [examples/ruby](https://github.com/pyroscope-io/pyroscope/tree/main/examples/ruby) in the main repo.
+Tags passed to configure are global. To tag code locally, you can use:
 
+```
+Pyroscope.tag_wrapper({"profile": "profile-1"}) do
+    // Tagged profile
+end
+```

data/elflib/rbspy/manylinux.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+set -e
+
+# Install tooling
+yum -y -q install wget gcc libffi-devel openssl-devel
+
+# Install Rust
+curl https://sh.rustup.rs -sSf | sh -s -- -y
+export PATH=~/.cargo/bin:$PATH
+
+# Build wheels
+/opt/python/cp37-cp37m/bin/python setup.py bdist_wheel
+
+# Audit wheels
+for wheel in dist/*.whl; do
+  auditwheel repair $wheel -w dist/
+  rm $wheel
+done
+
+# Extract wheels
+for wheel in dist/*.whl; do
+    /opt/python/cp37-cp37m/bin/wheel unpack $wheel -d wheelhouse
+done

data/elflib/rbspy/pyproject.toml

@@ -0,0 +1,7 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel",
+    "milksnakex>=0.1.6"
+]
+build-backend = "setuptools.build_meta"

data/elflib/rbspy/setup.cfg

@@ -0,0 +1,22 @@
+[metadata]
+name = rbspy 
+version= 1.0.0
+description = Fake wheel to generate audtiwheel libs
+url = https://proscope.io
+maintainer = Abid Omar 
+maintainer_email = contact@pyroscope.io 
+license = Apache 2.0
+classifiers =
+    Intended Audience :: Developers
+project_urls =
+    Documentation = https://proscope.io
+    Bug Tracker = https://proscope.io
+    Discussions = https://proscope.io
+    Changelog = https://proscope.io
+
+[options]
+packages = find:
+install_requires =
+    milksnakex>=0.1.6
+include_package_data = True
+zip_safe = False

data/elflib/rbspy/setup.py

@@ -0,0 +1,46 @@
+import os
+import sys
+from setuptools import find_packages, setup
+from pathlib import Path
+
+SCRIPT_DIR = Path(__file__).resolve().parent
+
+os.chdir(SCRIPT_DIR)
+
+# print script_dir
+print(SCRIPT_DIR)
+
+LIB_DIR = str(SCRIPT_DIR / "../../ext/rbspy")
+
+def build_native(spec):
+    # Step 1: build the rust library
+    build = spec.add_external_build(
+        cmd=['cargo', 'build', '--release'],
+        path=LIB_DIR
+    )
+
+    def find_dylib():
+        cargo_target = os.environ.get('CARGO_BUILD_TARGET')
+        if cargo_target:
+            in_path = 'target/%s/release' % (cargo_target)
+        else:
+            in_path = 'target/release'
+        return build.find_dylib('rbspy', in_path=in_path)
+
+    # Step 2: package the compiled library
+    rtld_flags = ["NOW"]
+    if sys.platform == "darwin":
+        rtld_flags.append("NODELETE")
+
+    spec.add_cffi_module(module_path='rbspy._native',
+            dylib=find_dylib,
+            header_filename=lambda:
+            build.find_header('rbspy.h',in_path='include'),
+            rtld_flags=rtld_flags,
+    )
+
+setup(
+    platforms="any",
+    milksnake_tasks=[build_native],
+    setup_requires=["milksnakex>=0.1.6"],
+)

data/elflib/thread_id/manylinux.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+set -e
+
+# Install tooling
+yum -y -q install wget gcc libffi-devel openssl-devel
+
+# Install Rust
+curl https://sh.rustup.rs -sSf | sh -s -- -y
+export PATH=~/.cargo/bin:$PATH
+
+# Build wheels
+/opt/python/cp37-cp37m/bin/python setup.py bdist_wheel
+
+# Audit wheels
+for wheel in dist/*.whl; do
+  auditwheel repair $wheel -w dist/
+  rm $wheel
+done
+
+# Extract wheels
+for wheel in dist/*.whl; do
+    /opt/python/cp37-cp37m/bin/wheel unpack $wheel -d wheelhouse
+done

data/elflib/thread_id/pyproject.toml

@@ -0,0 +1,7 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel",
+    "milksnakex>=0.1.6"
+]
+build-backend = "setuptools.build_meta"

data/elflib/thread_id/setup.cfg

@@ -0,0 +1,22 @@
+[metadata]
+name = thread_id 
+version= 1.0.0
+description = Fake wheel to generate audtiwheel libs
+url = https://proscope.io
+maintainer = Abid Omar 
+maintainer_email = contact@pyroscope.io 
+license = Apache 2.0
+classifiers =
+    Intended Audience :: Developers
+project_urls =
+    Documentation = https://proscope.io
+    Bug Tracker = https://proscope.io
+    Discussions = https://proscope.io
+    Changelog = https://proscope.io
+
+[options]
+packages = find:
+install_requires =
+    milksnakex>=0.1.6
+include_package_data = True
+zip_safe = False

data/elflib/thread_id/setup.py

@@ -0,0 +1,46 @@
+import os
+import sys
+from setuptools import find_packages, setup
+from pathlib import Path
+
+SCRIPT_DIR = Path(__file__).resolve().parent
+
+os.chdir(SCRIPT_DIR)
+
+# print script_dir
+print(SCRIPT_DIR)
+
+LIB_DIR = str(SCRIPT_DIR / "../../ext/thread_id")
+
+def build_native(spec):
+    # Step 1: build the rust library
+    build = spec.add_external_build(
+        cmd=['cargo', 'build', '--release'],
+        path=LIB_DIR
+    )
+
+    def find_dylib():
+        cargo_target = os.environ.get('CARGO_BUILD_TARGET')
+        if cargo_target:
+            in_path = 'target/%s/release' % (cargo_target)
+        else:
+            in_path = 'target/release'
+        return build.find_dylib('thread_id', in_path=in_path)
+
+    # Step 2: package the compiled library
+    rtld_flags = ["NOW"]
+    if sys.platform == "darwin":
+        rtld_flags.append("NODELETE")
+
+    spec.add_cffi_module(module_path='thread_id._native',
+            dylib=find_dylib,
+            header_filename=lambda:
+            build.find_header('thread_id.h',in_path='include'),
+            rtld_flags=rtld_flags,
+    )
+
+setup(
+    platforms="any",
+    milksnake_tasks=[build_native],
+    setup_requires=["milksnakex>=0.1.6"],
+)

data/ext/rbspy/Cargo.toml

@@ -0,0 +1,27 @@
+[package]
+name = "rbspy"
+version = "0.1.0"
+edition = "2021"
+
+[lib]
+name = "rbspy"
+crate-type = ["cdylib"]
+
+[dependencies]
+#pyroscope = {version = "0.5.2" }
+pyroscope = { path = "../../../../" }
+#pyroscope_rbspy = { version = "0.2" }
+pyroscope_rbspy = { path = "../../../../pyroscope_backends/pyroscope_rbspy" }
+
+[patch.crates-io]
+read-process-memory = {git = "https://github.com/omarabid/read-process-memory.git", branch = "0.1.4-fix"}
+rbspy = {git="https://github.com/omarabid/rbspy.git", branch="oncpu-fix"}
+
+[build-dependencies]
+cbindgen = "0.20.0"
+
+[profile.release]
+opt-level= "z"
+debug = false
+lto = true
+codegen-units = 1

data/ext/rbspy/Rakefile

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require "shellwords"
+
+class RbspyRakeCargoHelper
+  attr_reader :gemname
+
+  def initialize(gemname=File.basename(__dir__))
+    @gemname = gemname
+  end
+
+  def self.command?(name)
+    exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+    ENV["PATH"].split(File::PATH_SEPARATOR).any? do |path|
+      exts.any? do |ext|
+        exe = File.join(path, "#{name}#{ext}")
+        File.executable?(exe) && !File.directory?(exe)
+      end
+    end
+  end
+
+  def self.rust_toolchain
+    # return env variable if set
+    target = ENV["RUST_TARGET"]
+    return target if target
+
+    str = `rustc --version --verbose`
+    info = str.lines.map {|l| l.chomp.split(/:\s+/, 2)}.drop(1).to_h
+    info["host"]
+  end
+
+  def self.cargo_target_dir
+    return @cargo_target_dir if defined? @cargo_target_dir
+
+    str = `cargo metadata --format-version 1 --offline --no-deps --quiet`
+    begin
+      require "json"
+      dir = JSON.parse(str)["target_directory"]
+    rescue LoadError # json is usually part of the stdlib, but just in case
+      /"target_directory"\s*:\s*"(?<dir>[^"]*)"/ =~ str
+    end
+    @cargo_target_dir = dir || "target"
+  end
+
+  def self.flags
+    cc_flags = Shellwords.split(RbConfig.expand(RbConfig::MAKEFILE_CONFIG["CC"].dup))
+
+    ["-C", "linker=#{cc_flags.shift}",
+      *cc_flags.flat_map {|a| ["-C", "link-arg=#{a}"] },
+      "-L", "native=#{RbConfig::CONFIG["libdir"]}",
+      *dld_flags,
+      *platform_flags,
+    ]
+  end
+
+  def self.dld_flags
+    Shellwords.split(RbConfig::CONFIG["DLDFLAGS"]).flat_map do |arg|
+      arg = arg.gsub(/\$\((\w+)\)/) do
+        $1 == "DEFFILE" ? nil : RbConfig::CONFIG[name]
+      end.strip
+      next [] if arg.empty?
+
+      transform_flag(arg)
+    end
+  end
+
+  def self.platform_flags
+    return unless RbConfig::CONFIG["target_os"] =~ /mingw/i
+
+    [*Shellwords.split(RbConfig::CONFIG["LIBRUBYARG"]).flat_map {|arg| transform_flag(arg)},
+      "-C", "link-arg=-Wl,--dynamicbase",
+      "-C", "link-arg=-Wl,--disable-auto-image-base",
+      "-C", "link-arg=-static-libgcc"]
+  end
+
+  def self.transform_flag(arg)
+    k, v = arg.split(/(?<=..)/, 2)
+    case k
+    when "-L"
+      [k, "native=#{v}"]
+    when "-l"
+      [k, v]
+    when "-F"
+      ["-l", "framework=#{v}"]
+    else
+      ["-C", "link_arg=#{k}#{v}"]
+    end
+  end
+
+  def install_dir
+    File.expand_path(File.join("..", "..", "lib", gemname), __dir__)
+  end
+
+  def rust_name
+    prefix = "lib" unless Gem.win_platform?
+    suffix = if RbConfig::CONFIG["target_os"] =~ /darwin/i
+      ".dylib"
+    elsif Gem.win_platform?
+      ".dll"
+    else
+      ".so"
+    end
+    "#{prefix}#{gemname}#{suffix}"
+  end
+
+  def ruby_name
+    "#{gemname}.#{RbConfig::CONFIG["DLEXT"]}"
+  end
+
+end
+
+task default: [:rbspy_install, :rbspy_clean]
+task rbspy: [:rbspy_install, :rbspy_clean]
+
+desc "set dev mode for subsequent task, run like `rake dev install`"
+task :rbspy_dev do
+  @dev = true
+end
+
+desc "build gem native extension and copy to lib"
+task rbspy_install: [:rbspy_cd, :rbspy_build] do
+  helper = RbspyRakeCargoHelper.new
+  profile_dir = @dev ? "debug" : "release"
+  arch_dir = RbspyRakeCargoHelper.rust_toolchain
+  source = File.join(RbspyRakeCargoHelper.cargo_target_dir, arch_dir, profile_dir, helper.rust_name)
+  dest = File.join(helper.install_dir, helper.ruby_name)
+  mkdir_p(helper.install_dir)
+  rm(dest) if File.exist?(dest)
+  cp(source, dest)
+end
+
+desc "build gem native extension"
+task rbspy_build: [:rbspy_cargo, :rbspy_cd] do
+  sh "cargo", "rustc", *(["--locked", "--release"] unless @dev), "--target=#{RbspyRakeCargoHelper.rust_toolchain}", "--", *RbspyRakeCargoHelper.flags
+end
+
+desc "clean up release build artifacts"
+task rbspy_clean: [:rbspy_cargo, :rbspy_cd] do
+  sh "cargo clean --release"
+end
+
+desc "clean up build artifacts"
+task rbspy_clobber: [:rbspy_cargo, :rbspy_cd] do
+  sh "cargo clean"
+end
+
+desc "check for cargo"
+task :rbspy_cargo do
+  raise <<-MSG unless RbspyRakeCargoHelper.command?("cargo")
+    This gem requires a Rust compiler and the `cargo' build tool to build the
+    gem's native extension. See https://www.rust-lang.org/tools/install for
+    how to install Rust. `cargo' is usually part of the Rust installation.
+  MSG
+
+  raise <<-MSG if Gem.win_platform? && RbspyRakeCargoHelper.rust_toolchain !~ /gnu/
+    Found Rust toolchain `#{RbspyRakeCargoHelper.rust_toolchain}' but the gem native
+    extension requires the gnu toolchain on Windows.
+  MSG
+end
+
+# ensure task is running in the right dir
+task :rbspy_cd do
+  cd(__dir__) unless __dir__ == pwd
+end

data/ext/rbspy/build.rs

@@ -0,0 +1,12 @@
+extern crate cbindgen;
+
+use cbindgen::Config;
+
+fn main() {
+    let bindings = {
+        let crate_dir = std::env::var("CARGO_MANIFEST_DIR").unwrap();
+        let config = Config::from_file("cbindgen.toml").unwrap();
+        cbindgen::generate_with_config(&crate_dir, config).unwrap()
+    };
+    bindings.write_to_file("include/rbspy.h");
+}

data/ext/rbspy/cbindgen.toml

@@ -0,0 +1,22 @@
+# The language to output bindings in
+language = "C"
+documentation_style = "C"
+
+style = "type"
+
+# An optional name to use as an include guard
+include_guard = "RBSPY_H_"
+# include a comment with the version of cbindgen used to generate the file
+include_version = true
+
+# An optional string of text to output at the beginning of the generated file
+header = "/* Licensed under Apache-2.0 */"
+autogen_warning = "/* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */"
+
+braces = "SameLine"
+tab_width = 2
+line_length = 80
+
+[parse]
+# Do not parse dependent crates
+parse_deps = false

data/ext/rbspy/extconf.rb

@@ -0,0 +1,11 @@
+require 'mkmf'
+require 'rake'
+
+create_makefile('rbspy')
+
+app = Rake.application
+app.init
+app.add_import 'Rakefile'
+app.load_rakefile
+
+app['default'].invoke