Merge pull request #7 from omarabid/main

Pre-release

.github/workflows/publish.yml

@@ -0,0 +1,22 @@
+name: Publish to crates.io
+
+on:
+  workflow_dispatch:
+  release:
+    types: [published]
+
+jobs:
+  publish-pyroscope:
+    name: Publish pyroscope crate
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+      - name: publish pyroscope crate
+        continue-on-error: true
+        run: |
+          cargo login ${{ secrets.CARGO_TOKEN }}
+          cargo publish

.github/workflows/release.yml

@@ -0,0 +1,15 @@
+name: Pre-Release
+
+on: [push]
+
+jobs:
+  release:
+    name: Create draft release 
+    runs-on: ubuntu-latest
+    if: "startsWith(github.ref, 'refs/tags/')"
+    steps:
+      - uses: "marvinpinto/[email protected]"
+        with:
+          repo_token: "${{ secrets.GITHUB_TOKEN }}"
+          draft: true
+          prerelease: false

examples/async.rs

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

examples/backend.rs

@@ -23,9 +23,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

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

examples/error.rs

@@ -16,25 +16,22 @@ fn fibonacci(n: u64) -> u64 {
 }
 
 fn main() -> Result<()> {
-// Force rustc to display the log messages in the console.
+    // Force rustc to display the log messages in the console.
     std::env::set_var("RUST_LOG", "trace");
 
     // Initialize the logger.
     pretty_env_logger::init_timed();
 
-    // This example should fail and return an error.
-    println!("This example should fail and return an error.");
-    println!("Run this with: RUST_BACKTRACE=1 cargo run --example error");
-
     let mut agent = PyroscopeAgent::builder("http://invalid_url", "example.error")
-        .build()?;
+        .build()
+        .unwrap();
     // Start Agent
-    agent.start()?;
+    agent.start();
 
     let _result = fibonacci(47);
 
     // Stop Agent
-    agent.stop()?;
+    agent.stop();
 
     drop(agent);
 

examples/multi-thread.rs

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

examples/tags.rs

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

examples/with-logger.rs

@@ -30,12 +30,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/backends/mod.rs

@@ -8,7 +8,7 @@ use crate::Result;
 
 use std::fmt::Debug;
 
-/// Backend State 
+/// Backend State
 #[derive(Debug, Clone, Copy, PartialEq)]
 pub enum State {
     /// Backend is uninitialized.

src/backends/pprof.rs

@@ -95,9 +95,7 @@ impl Backend for Pprof<'_> {
 
 // Copyright: https://github.com/YangKeao
 fn fold<W>(report: &Report, with_thread_name: bool, mut writer: W) -> Result<()>
-where
-    W: std::io::Write,
-{
+where W: std::io::Write {
     for (key, value) in report.data.iter() {
         if with_thread_name {
             if !key.thread_name.is_empty() {

src/pyroscope.rs

@@ -138,9 +138,7 @@ impl PyroscopeAgentBuilder {
     /// .unwrap();
     /// ```
     pub fn backend<T: 'static>(self, backend: T) -> Self
-    where
-        T: Backend,
-    {
+    where T: Backend {
         Self {
             backend: Arc::new(Mutex::new(backend)),
             ..self
@@ -220,37 +218,47 @@ pub struct PyroscopeAgent {
     pub config: PyroscopeConfig,
 }
 
+/// Gracefully stop the profiler.
 impl Drop for PyroscopeAgent {
     /// Properly shutdown the agent.
     fn drop(&mut self) {
         log::debug!("PyroscopeAgent::drop()");
 
-        // Stop Timer
-        self.timer.drop_listeners().unwrap(); // Drop listeners
-        log::trace!("PyroscopeAgent - Dropped timer listeners");
-        self.timer.handle.take().unwrap().join().unwrap().unwrap(); // Wait for the Timer thread to finish
-        log::trace!("PyroscopeAgent - Dropped timer thread");
+        // Drop Timer listeners
+        match self.timer.drop_listeners() {
+            Ok(_) => log::trace!("PyroscopeAgent - Dropped timer listeners"),
+            Err(_) => log::error!("PyroscopeAgent - Error Dropping timer listeners"),
+        }
+
+        // Wait for the Timer thread to finish
+        match self.timer.handle.take().unwrap().join() {
+            Ok(_) => log::trace!("PyroscopeAgent - Dropped timer thread"),
+            Err(_) => log::error!("PyroscopeAgent - Error Dropping timer thread"),
+        }
 
         // Stop the SessionManager
-        self.session_manager.push(SessionSignal::Kill).unwrap();
-        log::trace!("PyroscopeAgent - Sent kill signal to SessionManager");
-        self.session_manager
-            .handle
-            .take()
-            .unwrap()
-            .join()
-            .unwrap()
-            .unwrap();
-        log::trace!("PyroscopeAgent - Dropped SessionManager thread");
+        match self.session_manager.push(SessionSignal::Kill) {
+            Ok(_) => log::trace!("PyroscopeAgent - Sent kill signal to SessionManager"),
+            Err(_) => log::error!("PyroscopeAgent - Error sending kill signal to SessionManager"),
+        }
+
+        // Stop SessionManager
+        match self.session_manager.handle.take().unwrap().join() {
+            Ok(_) => log::trace!("PyroscopeAgent - Dropped SessionManager thread"),
+            Err(_) => log::error!("PyroscopeAgent - Error Dropping SessionManager thread"),
+        }
 
         // Wait for main thread to finish
-        self.handle.take().unwrap().join().unwrap().unwrap();
-        log::trace!("PyroscopeAgent - Dropped main thread");
+        match self.handle.take().unwrap().join() {
+            Ok(_) => log::trace!("PyroscopeAgent - Dropped main thread"),
+            Err(_) => log::error!("PyroscopeAgent - Error Dropping main thread"),
+        }
     }
 }
 
 impl PyroscopeAgent {
     /// Short-hand for PyroscopeAgentBuilder::build(). This is a convenience method.
+    ///
     /// # Example
     /// ```ignore
     /// let agent = PyroscopeAgent::builder("http://localhost:8080", "my-app").build().unwrap();
@@ -260,13 +268,7 @@ impl PyroscopeAgent {
         PyroscopeAgentBuilder::new(url, application_name)
     }
 
-    /// 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().unwrap();
-    /// agent.start().unwrap();
-    /// ```
-    pub fn start(&mut self) -> Result<()> {
+    fn _start(&mut self) -> Result<()> {
         log::debug!("PyroscopeAgent - Starting");
 
         // Create a clone of Backend
@@ -276,16 +278,14 @@ impl PyroscopeAgent {
 
         // set running to true
         let pair = Arc::clone(&self.running);
-        let (lock, cvar) = &*pair;
+        let (lock, _cvar) = &*pair;
         let mut running = lock.lock()?;
         *running = true;
-        drop(lock);
-        drop(cvar);
         drop(running);
 
         let (tx, rx): (Sender<u64>, Receiver<u64>) = channel();
         self.timer.attach_listener(tx.clone())?;
-        self.tx = Some(tx.clone());
+        self.tx = Some(tx);
 
         let config = self.config.clone();
 
@@ -318,22 +318,26 @@ impl PyroscopeAgent {
                     return Ok(());
                 }
             }
-
-            return Ok(());
+            Ok(())
         }));
 
         Ok(())
     }
 
-    /// Stop the agent. The agent will stop profiling and send a last report to the server.
+    /// 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().unwrap();
     /// agent.start().unwrap();
-    /// // Expensive operation
-    /// agent.stop().unwrap();
     /// ```
-    pub fn stop(&mut self) -> Result<()> {
+    pub fn start(&mut self) {
+        match self._start() {
+            Ok(_) => log::trace!("PyroscopeAgent - Agent started"),
+            Err(_) => log::error!("PyroscopeAgent - Error starting agent"),
+        }
+    }
+
+    fn _stop(&mut self) -> Result<()> {
         log::debug!("PyroscopeAgent - Stopping");
         // get tx and send termination signal
         self.tx.take().unwrap().send(0)?;
@@ -351,6 +355,21 @@ 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().unwrap();
+    /// agent.start().unwrap();
+    /// // Expensive operation
+    /// agent.stop().unwrap();
+    /// ```   
+    pub fn stop(&mut self) {
+        match self._stop() {
+            Ok(_) => log::trace!("PyroscopeAgent - Agent stopped"),
+            Err(_) => log::error!("PyroscopeAgent - Error stopping agent"),
+        }
+    }
+
     /// Add tags. This will restart the agent.
     /// # Example
     /// ```ignore
@@ -369,7 +388,7 @@ impl PyroscopeAgent {
         }
 
         // Stop Agent
-        self.stop()?;
+        self.stop();
 
         // Convert &[(&str, &str)] to HashMap(String, String)
         let tags_hashmap: HashMap<String, String> = tags
@@ -382,7 +401,7 @@ impl PyroscopeAgent {
         self.config.tags.extend(tags_hashmap);
 
         // Restart Agent
-        self.start()?;
+        self.start();
 
         Ok(())
     }
@@ -407,7 +426,7 @@ impl PyroscopeAgent {
         }
 
         // Stop Agent
-        self.stop()?;
+        self.stop();
 
         // Iterate through every tag
         tags.iter().for_each(|key| {
@@ -416,7 +435,7 @@ impl PyroscopeAgent {
         });
 
         // Restart Agent
-        self.start()?;
+        self.start();
 
         Ok(())
     }