refactor(agent): remove intermediary start/stop functions

Author: omarabid

examples/async.rs

@@ -23,7 +23,7 @@ async fn main() -> Result<()> {
         .build()?;
 
     // Start Agent
-    agent.start();
+    agent.start()?;
 
     tokio::task::spawn(async {
         let n = fibonacci1(45);
@@ -40,7 +40,7 @@ async fn main() -> Result<()> {
     .unwrap();
 
     // Stop Agent
-    agent.stop();
+    agent.stop()?;
 
     Ok(())
 }

examples/backend.rs

@@ -17,9 +17,9 @@ fn main() -> Result<()> {
         .tags(&[("TagA", "ValueA"), ("TagB", "ValueB")])
         .build()?;
 
-    agent.start();
+    agent.start()?;
     let _result = fibonacci(45);
-    agent.stop();
+    agent.stop()?;
 
     Ok(())
 }

examples/basic.rs

@@ -22,7 +22,7 @@ fn main() -> Result<()> {
     println!("Start Time: {}", start);
 
     // Start Agent
-    agent.start();
+    agent.start()?;
 
     let _result = fibonacci(47);
 
@@ -34,7 +34,7 @@ fn main() -> Result<()> {
     println!("Stop Time: {}", stop);
 
     // Stop Agent
-    agent.stop();
+    agent.stop()?;
 
     drop(agent);
 

examples/error.rs

@@ -20,12 +20,12 @@ fn main() -> Result<()> {
         .build()
         .unwrap();
     // Start Agent
-    agent.start();
+    agent.start()?;
 
     let _result = fibonacci(47);
 
     // Stop Agent
-    agent.stop();
+    agent.stop()?;
 
     drop(agent);
 

examples/multi-thread.rs

@@ -24,7 +24,7 @@ fn main() -> Result<()> {
         .build()?;
 
     // Start Agent
-    agent.start();
+    agent.start()?;
 
     let handle_1 = thread::spawn(|| {
         fibonacci1(45);
@@ -39,7 +39,7 @@ fn main() -> Result<()> {
     handle_2.join().unwrap();
 
     // Stop Agent
-    agent.stop();
+    agent.stop()?;
 
     Ok(())
 }

examples/tags.rs

@@ -16,7 +16,7 @@ fn main() -> Result<()> {
         .build()?;
 
     // Start Agent
-    agent.start();
+    agent.start()?;
 
     // Make some calculation
     let _result = fibonacci(47);
@@ -28,7 +28,7 @@ fn main() -> Result<()> {
     let _result = fibonacci(47);
 
     // Stop Agent
-    agent.stop();
+    agent.stop()?;
 
     Ok(())
 }

examples/with-logger.rs

@@ -1,6 +1,6 @@
 extern crate pyroscope;
 
-use log::{debug, error, info, trace, warn};
+use log::info;
 
 use pyroscope::{PyroscopeAgent, Result};
 
@@ -24,12 +24,12 @@ fn main() -> Result<()> {
     let mut agent = PyroscopeAgent::builder("http://localhost:4040", "example.logger").build()?;
 
     // Start Agent
-    agent.start();
+    agent.start()?;
 
     let _result = fibonacci(47);
 
     // Stop Agent
-    agent.stop();
+    agent.stop()?;
 
     Ok(())
 }

src/pyroscope.rs

@@ -134,7 +134,9 @@ impl PyroscopeAgentBuilder {
     /// ?;
     /// ```
     pub fn backend<T>(self, backend: T) -> Self
-        where T: 'static + Backend {
+    where
+        T: 'static + Backend,
+    {
         Self {
             backend: Arc::new(Mutex::new(backend)),
             ..self
@@ -237,7 +239,10 @@ impl Drop for PyroscopeAgent {
         // Stop the SessionManager
         match self.session_manager.push(SessionSignal::Kill) {
             Ok(_) => log::trace!(target: LOG_TAG, "Sent kill signal to SessionManager"),
-            Err(_) => log::error!(target: LOG_TAG, "Error sending kill signal to SessionManager"),
+            Err(_) => log::error!(
+                target: LOG_TAG,
+                "Error sending kill signal to SessionManager"
+            ),
         }
 
         if let Some(handle) = self.session_manager.handle.take() {
@@ -256,7 +261,7 @@ impl Drop for PyroscopeAgent {
             }
         }
 
-        log::debug!(target:  LOG_TAG, "Agent Dropped");
+        log::debug!(target: LOG_TAG, "Agent Dropped");
     }
 }
 
@@ -272,7 +277,13 @@ impl PyroscopeAgent {
         PyroscopeAgentBuilder::new(url, application_name)
     }
 
-    fn _start(&mut self) -> Result<()> {
+    /// Start profiling and sending data. The agent will keep running until stopped. The agent will send data to the server every 10s secondy.
+    /// # Example
+    /// ```ignore
+    /// let agent = PyroscopeAgent::builder("http://localhost:8080", "my-app").build()?;
+    /// agent.start()?;
+    /// ```
+    pub fn start(&mut self) -> Result<()> {
         log::debug!(target: LOG_TAG, "Starting");
 
         // Create a clone of Backend
@@ -328,20 +339,15 @@ impl PyroscopeAgent {
         Ok(())
     }
 
-    /// Start profiling and sending data. The agent will keep running until stopped. The agent will send data to the server every 10s secondy.
+    /// Stop the agent. The agent will stop profiling and send a last report to the server.
     /// # Example
     /// ```ignore
     /// let agent = PyroscopeAgent::builder("http://localhost:8080", "my-app").build()?;
-    /// agent.start();
+    /// agent.start()?;
+    /// // Expensive operation
+    /// agent.stop();
     /// ```
-    pub fn start(&mut self) {
-        match self._start() {
-            Ok(_) => log::trace!(target: LOG_TAG, "Agent started"),
-            Err(_) => log::error!(target: LOG_TAG, "Error starting agent"),
-        }
-    }
-
-    fn _stop(&mut self) -> Result<()> {
+    pub fn stop(&mut self) -> Result<()> {
         log::debug!(target: LOG_TAG, "Stopping");
         // get tx and send termination signal
         if let Some(sender) = self.tx.take() {
@@ -363,21 +369,6 @@ impl PyroscopeAgent {
         Ok(())
     }
 
-    /// Stop the agent. The agent will stop profiling and send a last report to the server.
-    /// # Example
-    /// ```ignore
-    /// let agent = PyroscopeAgent::builder("http://localhost:8080", "my-app").build()?;
-    /// agent.start()?;
-    /// // Expensive operation
-    /// agent.stop();
-    /// ```
-    pub fn stop(&mut self) {
-        match self._stop() {
-            Ok(_) => log::trace!(target: LOG_TAG, "Agent stopped"),
-            Err(_) => log::error!(target: LOG_TAG, "Error stopping agent"),
-        }
-    }
-
     /// Add tags. This will restart the agent.
     /// # Example
     /// ```ignore
@@ -396,7 +387,7 @@ impl PyroscopeAgent {
         }
 
         // Stop Agent
-        self.stop();
+        self.stop()?;
 
         // Convert &[(&str, &str)] to HashMap(String, String)
         let tags_hashmap: HashMap<String, String> = tags
@@ -409,7 +400,7 @@ impl PyroscopeAgent {
         self.config.tags.extend(tags_hashmap);
 
         // Restart Agent
-        self.start();
+        self.start()?;
 
         Ok(())
     }
@@ -440,7 +431,7 @@ impl PyroscopeAgent {
         }
 
         // Stop Agent
-        self.stop();
+        self.stop()?;
 
         // Iterate through every tag
         tags.iter().for_each(|key| {
@@ -449,7 +440,7 @@ impl PyroscopeAgent {
         });
 
         // Restart Agent
-        self.start();
+        self.start()?;
 
         Ok(())
     }