imp(pprof): add sample_rate helper function to config builder

Author: omarabid

examples/async.rs

@@ -35,7 +35,7 @@ fn hash_rounds2(n: u64) -> u64 {
 #[tokio::main]
 async fn main() -> Result<()> {
     let mut agent = PyroscopeAgent::builder("http://localhost:4040", "example.async")
-        .backend(Pprof::new(PprofConfig::new(100)))
+        .backend(Pprof::new(PprofConfig::new().sample_rate(100)))
         .tags([("TagA", "ValueA"), ("TagB", "ValueB")].to_vec())
         .build()?;
 

examples/backend.rs

@@ -20,7 +20,7 @@ fn hash_rounds(n: u64) -> u64 {
 
 fn main() -> Result<()> {
     let mut agent = PyroscopeAgent::builder("http://localhost:4040", "example.backend")
-        .backend(Pprof::new(PprofConfig::new(113)))
+        .backend(Pprof::new(PprofConfig::new().sample_rate(113)))
         .tags([("TagA", "ValueA"), ("TagB", "ValueB")].to_vec())
         .build()?;
 

examples/basic.rs

@@ -20,7 +20,7 @@ fn hash_rounds(n: u64) -> u64 {
 
 fn main() -> Result<()> {
     let mut agent = PyroscopeAgent::builder("http://localhost:4040", "example.basic")
-        .backend(Pprof::new(PprofConfig::new(100)))
+        .backend(Pprof::new(PprofConfig::new().sample_rate(100)))
         .tags([("TagA", "ValueA"), ("TagB", "ValueB")].to_vec())
         .build()?;
 

examples/error.rs

@@ -18,7 +18,7 @@ fn main() -> Result<()> {
     pretty_env_logger::init_timed();
 
     let mut agent = PyroscopeAgent::builder("http://invalid_url", "example.error")
-        .backend(Pprof::new(PprofConfig::new(100)))
+        .backend(Pprof::new(PprofConfig::new().sample_rate(100)))
         .build()
         .unwrap();
     // Start Agent

examples/internal/backend-pprof.rs

@@ -13,7 +13,7 @@ fn fibonacci(n: u64) -> u64 {
 
 fn main() -> Result<()> {
     // Create Pprof configuration
-    let backend_config = PprofConfig::new(113);
+    let backend_config = PprofConfig::new().sample_rate(100);
 
     // Create backend
     let mut backend = Pprof::new(backend_config);

examples/multi-thread.rs

@@ -38,7 +38,7 @@ fn hash_rounds2(n: u64) -> u64 {
 
 fn main() -> Result<()> {
     let mut agent = PyroscopeAgent::builder("http://localhost:4040", "example.multithread")
-        .backend(Pprof::new(PprofConfig::new(100)))
+        .backend(Pprof::new(PprofConfig::new().sample_rate(100)))
         .build()?;
 
     // Start Agent

examples/tags.rs

@@ -20,7 +20,7 @@ fn hash_rounds(n: u64) -> u64 {
 
 fn main() -> Result<()> {
     let mut agent = PyroscopeAgent::builder("http://localhost:4040", "example.tags")
-        .backend(Pprof::new(PprofConfig::new(100)))
+        .backend(Pprof::new(PprofConfig::new().sample_rate(100)))
         .tags([("Hostname", "pyroscope")].to_vec())
         .build()?;
 

examples/with-logger.rs

@@ -31,7 +31,7 @@ fn main() -> Result<()> {
 
     // Create a new agent.
     let mut agent = PyroscopeAgent::builder("http://localhost:4040", "example.logger")
-        .backend(Pprof::new(PprofConfig::new(100)))
+        .backend(Pprof::new(PprofConfig::new().sample_rate(100)))
         .build()?;
 
     // Start Agent

pyroscope_backends/pyroscope_pprofrs/src/lib.rs

@@ -18,8 +18,15 @@ impl Default for PprofConfig {
 }
 
 impl PprofConfig {
-    pub fn new(sample_rate: u32) -> Self {
-        PprofConfig { sample_rate }
+    pub fn new() -> Self {
+        PprofConfig::default()
+    }
+
+    pub fn sample_rate(self, sample_rate: u32) -> Self {
+        PprofConfig {
+            sample_rate,
+            ..self
+        }
     }
 }
 

src/lib.rs

@@ -2,11 +2,20 @@
 //!
 //! # Quick Start
 //!
+//! ## Add Pyroscope and pprof-rs backend to Cargo.toml
+//!
+//! ```toml
+//! [dependencies]
+//! pyroscope = "0.4"
+//! pyroscope-pprofrs = "0.1"
+//! ```
+//!
 //! ## Configure a Pyroscope Agent
 //!
 //! ```ignore
 //! let mut agent =
 //!     PyroscopeAgent::builder("http://localhost:4040", "myapp")
+//!     .backend(Pprof::new(PprofConfig::new().sample_rate(100)))
 //!     .build()?;
 //! ```
 //!