refactor(clippy): fix clippy warnings

Author: omarabid

examples/internal/pyspy-connect.rs

@@ -24,7 +24,7 @@ fn main() -> Result<()> {
         .include_idle(false)
         .native(false);
 
-    let mut agent = PyroscopeAgent::builder("http://localhost:4040", "pyspy.basic")
+    let agent = PyroscopeAgent::builder("http://localhost:4040", "pyspy.basic")
         .tags([("Host", "Python")].to_vec())
         .backend(pyspy_backend(config))
         .build()?;
@@ -37,30 +37,29 @@ fn main() -> Result<()> {
     println!("Start Time: {}", start);
 
     // Start Agent
-    agent.start()?;
+    let agent_running = agent.start()?;
 
     // Profile for around 1 minute
-    std::thread::sleep(std::time::Duration::from_secs(20));
+    std::thread::sleep(std::time::Duration::from_secs(60));
 
-    println!("Stopping agent");
-    // Stop Agent
-    agent.stop()?;
-
-    println!("Done");
-
-    agent.start()?;
-    std::thread::sleep(std::time::Duration::from_secs(40));
+    // Show stop time
+    let stop = std::time::SystemTime::now()
+        .duration_since(std::time::UNIX_EPOCH)
+        .unwrap()
+        .as_secs();
+    println!("Stop Time: {}", stop);
 
-    agent.stop()?;
+    // Stop Agent
+    let agent_ready = agent_running.stop()?;
 
-    drop(agent);
+    // Shutdown the Agent
+    agent_ready.shutdown();
 
     // Show program exit time
     let exit = std::time::SystemTime::now()
         .duration_since(std::time::UNIX_EPOCH)
         .unwrap()
         .as_secs();
-
     println!("Exit Time: {}", exit);
 
     Ok(())

examples/internal/rbspy-connect.rs

@@ -21,7 +21,7 @@ fn main() -> Result<()> {
         .lock_process(true)
         .with_subprocesses(true);
 
-    let mut agent = PyroscopeAgent::builder("http://localhost:4040", "rbspy.basic")
+    let agent = PyroscopeAgent::builder("http://localhost:4040", "rbspy.basic")
         .tags([("Host", "Ruby")].to_vec())
         .backend(rbspy_backend(config))
         .build()?;
@@ -34,21 +34,29 @@ fn main() -> Result<()> {
     println!("Start Time: {}", start);
 
     // Start Agent
-    agent.start()?;
+    let agent_running = agent.start()?;
 
     // Profile for around 1 minute
-    std::thread::sleep(std::time::Duration::from_secs(120));
+    std::thread::sleep(std::time::Duration::from_secs(60));
 
-    agent.stop()?;
+    // Show stop time
+    let stop = std::time::SystemTime::now()
+        .duration_since(std::time::UNIX_EPOCH)
+        .unwrap()
+        .as_secs();
+    println!("Stop Time: {}", stop);
 
-    drop(agent);
+    // Stop Agent
+    let agent_ready = agent_running.stop()?;
+
+    // Shutdown the Agent
+    agent_ready.shutdown();
 
     // Show program exit time
     let exit = std::time::SystemTime::now()
         .duration_since(std::time::UNIX_EPOCH)
         .unwrap()
         .as_secs();
-
     println!("Exit Time: {}", exit);
 
     Ok(())

examples/tags.rs

@@ -1,6 +1,6 @@
 extern crate pyroscope;
 
-use pyroscope::{backend::Tag, PyroscopeAgent, Result};
+use pyroscope::{PyroscopeAgent, Result};
 use pyroscope_pprofrs::{pprof_backend, PprofConfig};
 use std::hash::{Hash, Hasher};
 

src/lib.rs

@@ -6,7 +6,7 @@
 //!
 //! ```toml
 //! [dependencies]
-//! pyroscope = "0.4"
+//! pyroscope = "0.5"
 //! pyroscope-pprofrs = "0.1"
 //! ```
 //!

src/pyroscope.rs

@@ -191,7 +191,11 @@ impl PyroscopeAgentBuilder {
             session_manager,
             tx: None,
             handle: None,
-            running: Arc::new((Mutex::new(false), Condvar::new())),
+            running: Arc::new((
+                #[allow(clippy::mutex_atomic)]
+                Mutex::new(false),
+                Condvar::new(),
+            )),
             _state: PhantomData,
         })
     }
@@ -208,16 +212,21 @@ impl PyroscopeAgentState for PyroscopeAgentRunning {}
 /// PyroscopeAgent is the main object of the library. It is used to start and stop the profiler, schedule the timer, and send the profiler data to the server.
 #[derive(Debug)]
 pub struct PyroscopeAgent<S: PyroscopeAgentState> {
+    /// Instance of the Timer
     timer: Timer,
+    /// Instance of the SessionManager
     session_manager: SessionManager,
+    /// Channel sender for the timer thread
     tx: Option<Sender<TimerSignal>>,
+    /// Handle to the thread that runs the Pyroscope Agent
     handle: Option<JoinHandle<Result<()>>>,
+    /// A structure to signal thread termination
     running: Arc<(Mutex<bool>, Condvar)>,
-
     /// Profiler backend
     pub backend: BackendImpl<BackendReady>,
     /// Configuration Object
     pub config: PyroscopeConfig,
+    /// PyroscopeAgent State
     _state: PhantomData<S>,
 }
 
@@ -280,7 +289,7 @@ impl<S: PyroscopeAgentState> PyroscopeAgent<S> {
             }
         }
 
-        log::debug!(target: LOG_TAG, "Agent Dropped");
+        log::debug!(target: LOG_TAG, "Agent Shutdown");
     }
 }
 
@@ -387,7 +396,8 @@ impl PyroscopeAgent<PyroscopeAgentRunning> {
         // get tx and send termination signal
         if let Some(sender) = self.tx.take() {
             // Send last session
-            let _ = sender.send(TimerSignal::NextSnapshot(get_time_range(0)?.until));
+            sender.send(TimerSignal::NextSnapshot(get_time_range(0)?.until))?;
+            // Terminate PyroscopeAgent internal thread
             sender.send(TimerSignal::Terminate)?;
         } else {
             log::error!("PyroscopeAgent - Missing sender")
@@ -398,20 +408,6 @@ impl PyroscopeAgent<PyroscopeAgentRunning> {
         let (lock, cvar) = &*pair;
         let _guard = cvar.wait_while(lock.lock()?, |running| *running)?;
 
-        // Create a clone of Backend
-        //let backend = Arc::clone(&self.backend);
-
-        //let agent_running = PyroscopeAgent {
-        //timer: self.timer,
-        //session_manager: self.session_manager,
-        //tx: self.tx,
-        //handle: self.handle,
-        //running: self.running,
-        //backend: self.backend,
-        //config: self.config,
-        //_state: PhantomData,
-        //};
-
         Ok(self.transition())
     }
 
@@ -444,29 +440,28 @@ impl PyroscopeAgent<PyroscopeAgentRunning> {
         )
     }
 
-    // TODO: change &mut self to &self
-    pub fn add_global_tag(&mut self, tag: Tag) -> Result<()> {
+    pub fn add_global_tag(&self, tag: Tag) -> Result<()> {
         let rule = Rule::GlobalTag(tag);
         self.backend.add_rule(rule)?;
 
         Ok(())
     }
 
-    pub fn remove_global_tag(&mut self, tag: Tag) -> Result<()> {
+    pub fn remove_global_tag(&self, tag: Tag) -> Result<()> {
         let rule = Rule::GlobalTag(tag);
         self.backend.remove_rule(rule)?;
 
         Ok(())
     }
 
-    pub fn add_thread_tag(&mut self, thread_id: u64, tag: Tag) -> Result<()> {
+    pub fn add_thread_tag(&self, thread_id: u64, tag: Tag) -> Result<()> {
         let rule = Rule::ThreadTag(thread_id, tag);
         self.backend.add_rule(rule)?;
 
         Ok(())
     }
 
-    pub fn remove_thread_tag(&mut self, thread_id: u64, tag: Tag) -> Result<()> {
+    pub fn remove_thread_tag(&self, thread_id: u64, tag: Tag) -> Result<()> {
         let rule = Rule::ThreadTag(thread_id, tag);
         self.backend.remove_rule(rule)?;
 

src/utils.rs

@@ -1,8 +1,6 @@
 use crate::backend::Tag;
 use crate::{error::Result, PyroscopeError};
 
-use std::collections::HashMap;
-
 /// Format application_name with tags.
 pub fn merge_tags_with_app_name(application_name: String, tags: Vec<Tag>) -> Result<String> {
     // tags empty, return application_name