pyroscope 0.1.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 743ff4c97e82300fb18a63cb6ebe626f241ce77a1bf0fd034198db698b5c5aca
-  data.tar.gz: 76d3705d25132cb5779b9e430eb2972894597d4bd4732a30c28a8995ec18fcaa
+  metadata.gz: d24a58cc1e931711355e430131e01565c4c15c149ac96d0323826ad03101f22c
+  data.tar.gz: 6f86a62f50e924859e404894bb47850a550b99fab146074f8c6cb4ddd6cf3089
 SHA512:
-  metadata.gz: 4bc08bbdc5fa0081806d4e2030eef6a6032c1e5fb68d53784fc5e0565f7ed4d57a85171d87ff91213d3fc0209967d47279593ac2025739a611588771d36e8c0d
-  data.tar.gz: 5d27f0e63129001f60bb11fab6f19e837b82a350bc746b6ac7a1bd0e072c1ea7546b3d0b9ea32ff4d864c8feb1b71c718f2a67e9d606d98b2b518c689b9e49fc
+  metadata.gz: 8d65c0d1ef7eeb636caa2b945fb485144f81f934630bf3736ffccb65b966d9b3c66dea974d275f078c6d94613b52f0893f55ec145e066acd430cf55f1c8bfc9f
+  data.tar.gz: 22e8e5a0b3a2a43bf11775539dabefa3e5d1d7d4bc6d7a3e40a4c3a80f117693b1a0b139f4e6d86c3db25da63b827b3f616531e385feabdd797cf4a5b3601c36

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   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.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,3 +1,57 @@
-# pyroscope-ruby
+Pyroscope Ruby Integration --Beta--
+=====================================
 
-This is a repo for pyroscope ruby integration. See [examples/ruby](https://github.com/pyroscope-io/pyroscope/tree/main/examples/ruby) in the main repo for examples.
+**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
+```

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,29 @@
+[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" }
+ffikit = { path = "../../../ffikit" }
+pretty_env_logger = "0.4.0"
+
+[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