chore: simplify crates (#244)

    merge ffi/ruby crate with the rbspy backend crate
    merge ffi/python crate with the pyspy backend crate
    remove backend-pyspy config - use pyspy::Config directly
    remove backend-rbspy config - use rbspy::Sampler directly
    remove publishing ruby python backends
    remove backend trait's get_config / set_config functions
    remove void backend

Author: korniltsev-grafanista

.github/workflows/publish.yml

@@ -40,36 +40,6 @@ jobs:
           set -ex
           cargo login ${{ secrets.CARGO_TOKEN }}
           cargo publish --manifest-path pyroscope_backends/pyroscope_pprofrs/Cargo.toml
-  publish-rbspy:
-    name: "Backend: rbspy"
-    runs-on: ubuntu-x64-small
-    if: "startsWith(github.event.release.tag_name, 'rbspy-')"
-    steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-        with:
-          persist-credentials: false
-      - uses: dtolnay/rust-toolchain@888c2e1ea69ab0d4330cbf0af1ecc7b68f368cc1
-        with:
-          toolchain: 1.85.0
-      - name: publish rbspy crate
-        run: |
-          cargo login ${{ secrets.CARGO_TOKEN }}
-          cargo publish --manifest-path pyroscope_backends/pyroscope_rbspy/Cargo.toml
-  publish-pyspy:
-    name: "Backend: pyspy" 
-    runs-on: ubuntu-x64-small
-    if: "startsWith(github.event.release.tag_name, 'pyspy-')"
-    steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-        with:
-          persist-credentials: false
-      - uses: dtolnay/rust-toolchain@888c2e1ea69ab0d4330cbf0af1ecc7b68f368cc1
-        with:
-          toolchain: 1.85.0
-      - name: publish pyspy crate
-        run: |
-          cargo login ${{ secrets.CARGO_TOKEN }}
-          cargo publish --manifest-path pyroscope_backends/pyroscope_pyspy/Cargo.toml
   publish-python:
     name: "Python" 
     runs-on: ubuntu-x64-small

.github/workflows/release.yml

@@ -31,30 +31,6 @@ jobs:
           title: "Backend: ${{ github.ref_name }}"
           draft: true
           prerelease: false
-  rbspy-release:
-    name: pyroscope-rbspy
-    runs-on: ubuntu-x64-small
-    if: "startsWith(github.ref, 'refs/tags/rbspy-')"
-    steps:
-      - uses: "marvinpinto/action-automatic-releases@919008cf3f741b179569b7a6fb4d8860689ab7f0" # v1.2.1 TODO(korniltsev): get rid of this, this one is unmaintained
-        with:
-          repo_token: "${{ secrets.GITHUB_TOKEN }}"
-          automatic_release_tag: "${{ github.ref_name }}"
-          title: "Backend: ${{ github.ref_name }}"
-          draft: true
-          prerelease: false
-  pyspy-release:
-    name: pyroscope-pyspy
-    runs-on: ubuntu-x64-small
-    if: "startsWith(github.ref, 'refs/tags/pyspy-')"
-    steps:
-      - uses: "marvinpinto/action-automatic-releases@919008cf3f741b179569b7a6fb4d8860689ab7f0" # v1.2.1 TODO(korniltsev): get rid of this, this one is unmaintained
-        with:
-          repo_token: "${{ secrets.GITHUB_TOKEN }}"
-          automatic_release_tag: "${{ github.ref_name }}"
-          title: "Backend: ${{ github.ref_name }}"
-          draft: true
-          prerelease: false
   python-release-linux:
     needs: [ 'python-release' ]
     name: Release python linux amd64

Cargo.lock

@@ -21,20 +21,12 @@ rust-version = "1.64"
 [workspace]
 members = [
     "pyroscope_backends/pyroscope_pprofrs",
-    "pyroscope_backends/pyroscope_pyspy",
     "pyroscope_ffi/ruby/ext/rbspy",
     "pyroscope_ffi/ruby/ext/thread_id",
     "pyroscope_ffi/python/lib",
     "pyroscope_ffi/ffikit",
 ]
 
-[[example]]
-name = "internal-backend-void"
-path = "examples/internal/backend-void.rs"
-
-[[example]]
-name = "internal-backend-void-run"
-path = "examples/internal/backend-void-run.rs"
 
 [[example]]
 name = "internal-backend-pprof"
@@ -44,13 +36,7 @@ path = "examples/internal/backend-pprof.rs"
 name = "internal-timer"
 path = "examples/internal/timer.rs"
 
-[[example]]
-name = "internal-pyspy-connect"
-path = "examples/internal/pyspy-connect.rs"
 
-[[example]]
-name = "internal-rbspy-connect"
-path = "examples/internal/rbspy-connect.rs"
 
 [dependencies]
 thiserror = "2.0.12"
@@ -70,8 +56,6 @@ pretty_env_logger = "0.5.0"
 assert_matches = "1"
 claims = "0.8.0"
 pyroscope_pprofrs = { path = "pyroscope_backends/pyroscope_pprofrs" }
-pyroscope_pyspy = { path = "pyroscope_backends/pyroscope_pyspy" }
-pyroscope_rbspy = { path = "pyroscope_backends/pyroscope_rbspy" }
 
 [features]
 default = ["rustls-tls"]

Cargo.toml

@@ -13,21 +13,13 @@ lib/test:
 pprofrs/test:
 	cargo  test --manifest-path pyroscope_backends/pyroscope_pprofrs/Cargo.toml
 
-.PHONY: pyspy/test
-pyspy/test:
-	cargo  test --manifest-path pyroscope_backends/pyroscope_pyspy/Cargo.toml
-
-.PHONY: rbspy/test
-rbspy/test:
-	cargo  test --manifest-path pyroscope_backends/pyroscope_rbspy/Cargo.toml
-
 
 .PHONY: ffikit/test
 ffikit/test:
 	cargo  test --manifest-path pyroscope_ffi/ffikit/Cargo.toml
 
 .PHONY: test
-test: pprofrs/test pyspy/test rbspy/test lib/test ffikit/test
+test: pprofrs/test  lib/test ffikit/test
 
 
 include ffi.mk

Makefile

@@ -76,8 +76,6 @@ The Pyroscope Agent and the [pprof-rs backend](pyroscope_backends/pyroscope_ppro
 The Pyroscope Agent doesn't do any profiling. The agent role is to orchestrate a profiling backend, and report the profiling data to the Pyroscope Server. The Agent can support external backends (in fact, all current backends are independent crates), and you can make your own. Backends can also be used separately. The currently available backends are:
 
 - [pprof-rs](pyroscope_backends/pyroscope_pprofrs): Rust profiler. A wrapper around [pprof-rs](https://github.com/tikv/pprof-rs).
-- [rbspy](pyroscope_backends/pyroscope_rbspy): Ruby Profiler. A wrapper around [rbspy](https://rbspy.github.io/).
-- [py-spy](pyroscope_backends/pyroscope_pyspy): Python Profiler. A wrapper around [py-spy](https://github.com/benfred/py-spy).
 
 ### Native Integration
 

README.md

@@ -3,6 +3,8 @@ extern crate pyroscope;
 use pyroscope::{PyroscopeAgent, Result};
 use pyroscope_pprofrs::{pprof_backend, PprofConfig};
 use std::hash::{Hash, Hasher};
+use pyroscope::backend::BackendConfig;
+use pyroscope::pyroscope::PyroscopeAgentBuilder;
 
 fn hash_rounds1(n: u64) -> u64 {
     let hash_str = "Some string to hash";
@@ -34,8 +36,8 @@ fn hash_rounds2(n: u64) -> u64 {
 
 #[tokio::main]
 async fn main() -> Result<()> {
-    let agent = PyroscopeAgent::builder("http://localhost:4040", "example.async")
-        .backend(pprof_backend(PprofConfig::new().sample_rate(100)))
+    let backend = pprof_backend(PprofConfig { sample_rate: 100 }, BackendConfig::default());
+    let agent = PyroscopeAgentBuilder::new("http://localhost:4040", "example.async", backend)
         .tags([("TagA", "ValueA"), ("TagB", "ValueB")].to_vec())
         .build()?;
 

examples/async.rs

@@ -3,6 +3,8 @@ extern crate pyroscope;
 use pyroscope::{PyroscopeAgent, Result};
 use pyroscope_pprofrs::{pprof_backend, PprofConfig};
 use std::hash::{Hash, Hasher};
+use pyroscope::backend::BackendConfig;
+use pyroscope::pyroscope::PyroscopeAgentBuilder;
 
 fn hash_rounds(n: u64) -> u64 {
     let hash_str = "Some string to hash";
@@ -22,13 +24,12 @@ fn main() -> Result<()> {
     // TODO: Change this token to your own.
     let token = String::from("<your-token>");
 
-    let agent = PyroscopeAgent::builder("http://localhost:4040", "example.basic")
-        .backend(pprof_backend(PprofConfig::new().sample_rate(100)))
+    let backend = pprof_backend(PprofConfig{sample_rate: 100}, BackendConfig::default());
+    let agent = PyroscopeAgentBuilder::new("http://localhost:4040", "example.basic", backend)
         .auth_token(token)
         .tags([("TagA", "ValueA"), ("TagB", "ValueB")].to_vec())
         .build()?;
 
-    // Show start time
     let start = std::time::SystemTime::now()
         .duration_since(std::time::UNIX_EPOCH)
         .unwrap()

examples/auth.rs

@@ -3,6 +3,8 @@ extern crate pyroscope;
 use pyroscope::{PyroscopeAgent, Result};
 use pyroscope_pprofrs::{pprof_backend, PprofConfig};
 use std::hash::{Hash, Hasher};
+use pyroscope::backend::BackendConfig;
+use pyroscope::pyroscope::PyroscopeAgentBuilder;
 
 fn hash_rounds(n: u64) -> u64 {
     let hash_str = "Some string to hash";
@@ -19,8 +21,8 @@ fn hash_rounds(n: u64) -> u64 {
 }
 
 fn main() -> Result<()> {
-    let agent = PyroscopeAgent::builder("http://localhost:4040", "example.basic")
-        .backend(pprof_backend(PprofConfig::new().sample_rate(100)))
+    let backend = pprof_backend(PprofConfig { sample_rate: 100 }, BackendConfig::default());
+    let agent = PyroscopeAgentBuilder::new("http://localhost:4040", "example.basic", backend)
         .tags([("TagA", "ValueA"), ("TagB", "ValueB")].to_vec())
         .build()?;
 

examples/basic.rs

@@ -1,6 +1,8 @@
 extern crate pyroscope;
 
 use pyroscope::{PyroscopeAgent, Result};
+use pyroscope::backend::BackendConfig;
+use pyroscope::pyroscope::PyroscopeAgentBuilder;
 use pyroscope_pprofrs::{pprof_backend, PprofConfig};
 
 fn fibonacci(n: u64) -> u64 {
@@ -16,9 +18,8 @@ fn main() -> Result<()> {
 
     // Initialize the logger.
     pretty_env_logger::init_timed();
-
-    let agent = PyroscopeAgent::builder("http://invalid_url", "example.error")
-        .backend(pprof_backend(PprofConfig::new().sample_rate(100)))
+    let backend = pprof_backend(PprofConfig{sample_rate: 100}, BackendConfig::default());
+    let agent = PyroscopeAgentBuilder::new("http://invalid_url", "example.error", backend)
         .build()
         .unwrap();
     // Start Agent