chore(cargo): various minor changes

omarabid · omarabid · commit cf79afc54015 · 2022-03-22T12:10:07.000+01:00
diff --git a/Cargo.toml b/Cargo.toml
@@ -25,10 +25,6 @@ exclude = [
     "pyroscope_cli",
 ]
 
-#[[bin]]
-#name = "pyroscope-cli"
-#path = "pyroscope_cli/src/main.rs"
-
 [[example]]
 name = "internal-backend-void"
 path = "examples/internal/backend-void.rs"
diff --git a/pyroscope_backends/pyroscope_pprofrs/Cargo.toml b/pyroscope_backends/pyroscope_pprofrs/Cargo.toml
@@ -1,11 +1,52 @@
 [package]
 name = "pyroscope_pprofrs"
-version = "0.1.0"
+description = """
+pprof-rs backend for Pyroscope Profiler.
+"""
+keywords = ["pyroscope", "profiler", "pprof-rs"]
+authors = ["Abid Omar <contact@omarabid.com>"]
+version = "0.1.0-beta"
 edition = "2021"
+license = "Apache-2.0"
+homepage = "https://pyroscope.io"
+documentation  = "https://docs.rs/pyroscope"
+repository = "https://github.com/pyroscope-io/pyroscope-rs"
+readme = "README.md"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
 pprof = "0.7"
-pyroscope = { path = "../../" }
+pyroscope = {version = "0.4.0", path = "../../" }
 thiserror ="1.0"
+
+[profile.dev]
+opt-level=0
+debug = true
+rpath = false
+lto = false
+debug-assertions = true
+codegen-units = 4
+
+[profile.release]
+opt-level=3
+debug = false
+rpath = false
+lto = true
+debug-assertions = false
+codegen-units = 1
+
+[profile.test]
+opt-level = 1
+debug = true
+rpath = false
+lto = false
+debug-assertions = true
+codegen-units = 4
+
+[profile.bench]
+opt-level = 3
+debug = false
+rpath = false
+lto = true
+debug-assertions = false
+codegen-units = 1
diff --git a/pyroscope_backends/pyroscope_pprofrs/README.md b/pyroscope_backends/pyroscope_pprofrs/README.md
@@ -0,0 +1,3 @@
+# pprof-rs
+
+Backend implementation for [pprof-rs](https://github.com/tikv/pprof-rs).
diff --git a/pyroscope_backends/pyroscope_pyspy/Cargo.toml b/pyroscope_backends/pyroscope_pyspy/Cargo.toml
@@ -1,11 +1,51 @@
 [package]
 name = "pyroscope_pyspy"
-version = "0.1.0"
+description = """
+pyspy backend for Pyroscope Profiler.
+"""
+keywords = ["pyroscope", "profiler", "pyspy"]
+authors = ["Abid Omar <contact@omarabid.com>"]
+version = "0.1.0-beta"
 edition = "2021"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+license = "Apache-2.0"
+homepage = "https://pyroscope.io"
+documentation  = "https://docs.rs/pyroscope"
+repository = "https://github.com/pyroscope-io/pyroscope-rs"
+readme = "README.md"
 
 [dependencies]
 py-spy = "0.3.11"
-pyroscope = { path = "../../" }
+pyroscope = { version = "0.4.0", path = "../../" }
 thiserror ="1.0"
+
+[profile.dev]
+opt-level=0
+debug = true
+rpath = false
+lto = false
+debug-assertions = true
+codegen-units = 4
+
+[profile.release]
+opt-level=3
+debug = false
+rpath = false
+lto = true
+debug-assertions = false
+codegen-units = 1
+
+[profile.test]
+opt-level = 1
+debug = true
+rpath = false
+lto = false
+debug-assertions = true
+codegen-units = 4
+
+[profile.bench]
+opt-level = 3
+debug = false
+rpath = false
+lto = true
+debug-assertions = false
+codegen-units = 1
diff --git a/pyroscope_backends/pyroscope_pyspy/README.md b/pyroscope_backends/pyroscope_pyspy/README.md
@@ -0,0 +1,3 @@
+#pyspy
+
+Backend implementation for [pyspy](https://github.com/benfred/py-spy)
diff --git a/pyroscope_backends/pyroscope_rbspy/Cargo.toml b/pyroscope_backends/pyroscope_rbspy/Cargo.toml
@@ -1,13 +1,53 @@
 [package]
 name = "pyroscope_rbspy"
-version = "0.1.0"
+description = """
+rbspy backend for Pyroscope Profiler.
+"""
+keywords = ["pyroscope", "profiler", "rbspy"]
+authors = ["Abid Omar <contact@omarabid.com>"]
+version = "0.1.0-beta"
 edition = "2021"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+license = "Apache-2.0"
+homepage = "https://pyroscope.io"
+documentation  = "https://docs.rs/pyroscope"
+repository = "https://github.com/pyroscope-io/pyroscope-rs"
+readme = "README.md"
 
 [dependencies]
 rbspy = "0.11.1"
 pyroscope = { path = "../../" }
 thiserror ="1.0"
 log = "0.4"
 anyhow = "*"
+
+[profile.dev]
+opt-level=0
+debug = true
+rpath = false
+lto = false
+debug-assertions = true
+codegen-units = 4
+
+[profile.release]
+opt-level=3
+debug = false
+rpath = false
+lto = true
+debug-assertions = false
+codegen-units = 1
+
+[profile.test]
+opt-level = 1
+debug = true
+rpath = false
+lto = false
+debug-assertions = true
+codegen-units = 4
+
+[profile.bench]
+opt-level = 3
+debug = false
+rpath = false
+lto = true
+debug-assertions = false
+codegen-units = 1
diff --git a/pyroscope_backends/pyroscope_rbspy/README.md b/pyroscope_backends/pyroscope_rbspy/README.md
@@ -0,0 +1,3 @@
+#rbspy
+
+Backend implementation for [rbspy](https://github.com/rbspy/rbspy)
diff --git a/pyroscope_cli/Cargo.toml b/pyroscope_cli/Cargo.toml
@@ -5,7 +5,7 @@ Pyroscope Profiler CLI
 """
 keywords = ["pyroscope", "profiler", "cli"]
 authors = ["Abid Omar <contact@omarabid.com>"]
-version = "0.4.0"
+version = "0.0.1-beta"
 edition = "2021"
 license = "Apache-2.0"
 homepage = "https://pyroscope.io"
diff --git a/src/backend.rs b/src/backend.rs
@@ -160,6 +160,7 @@ impl std::fmt::Display for Report {
 }
 
 /// StackTrace
+/// A representation of a stack trace.
 #[derive(Debug, Default, PartialEq, Eq, Hash, Clone)]
 pub struct StackTrace {
     /// Process ID
@@ -188,6 +189,7 @@ impl StackTrace {
 }
 
 /// StackFrame
+/// A representation of a stack frame.
 #[derive(Debug, Default, PartialEq, Eq, Hash, Clone)]
 pub struct StackFrame {
     /// Module name
diff --git a/src/lib.rs b/src/lib.rs
@@ -2,7 +2,7 @@
 //!
 //! # Quick Start
 //!
-//! ## Configure Pyroscope Agent
+//! ## Configure a Pyroscope Agent
 //!
 //! ```ignore
 //! let mut agent =
diff --git a/src/pyroscope.rs b/src/pyroscope.rs
@@ -146,15 +146,12 @@ impl PyroscopeAgentBuilder {
         }
     }
 
-    /// # use pyroscope::PyroscopeError;
-    /// # fn main() -> Result<(), PyroscopeError> {
     /// Set tags. Default is empty.
     /// # Example
     /// ```ignore
     /// let builder = PyroscopeAgentBuilder::new("http://localhost:8080", "my-app")
     /// .tags(vec![("env", "dev")])
-    /// .build()
-    /// ?;
+    /// .build()?;
     /// ```
     pub fn tags(self, tags: Vec<(&str, &str)>) -> Self {
         Self {
@@ -249,7 +246,6 @@ impl Drop for PyroscopeAgent {
         }
 
         // Wait for main thread to finish
-
         if let Some(handle) = self.handle.take() {
             match handle.join() {
                 Ok(_) => log::trace!(target: LOG_TAG, "Dropped main thread"),
diff --git a/tests/session.rs b/tests/session.rs
@@ -2,7 +2,7 @@ use pyroscope::{
     pyroscope::PyroscopeConfig,
     session::{Session, SessionManager, SessionSignal},
 };
-use std::{collections::HashMap, time::Duration};
+use std::collections::HashMap;
 
 #[test]
 fn test_session_manager_new() {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# pprof-rs`
	`2`	`+`
	`3`	`+Backend implementation for [pprof-rs](https://github.com/tikv/pprof-rs).`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+#pyspy`
	`2`	`+`
	`3`	`+Backend implementation for [pyspy](https://github.com/benfred/py-spy)`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+#rbspy`
	`2`	`+`
	`3`	`+Backend implementation for [rbspy](https://github.com/rbspy/rbspy)`
Original file line number	Diff line number	Diff line change
`@@ -160,6 +160,7 @@ impl std::fmt::Display for Report {`
`160`	`160`	`}`
`161`	`161`
`162`	`162`	`/// StackTrace`
	`163`	`+/// A representation of a stack trace.`
`163`	`164`	`#[derive(Debug, Default, PartialEq, Eq, Hash, Clone)]`
`164`	`165`	`pub struct StackTrace {`
`165`	`166`	`/// Process ID`
`@@ -188,6 +189,7 @@ impl StackTrace {`
`188`	`189`	`}`
`189`	`190`
`190`	`191`	`/// StackFrame`
	`192`	`+/// A representation of a stack frame.`
`191`	`193`	`#[derive(Debug, Default, PartialEq, Eq, Hash, Clone)]`
`192`	`194`	`pub struct StackFrame {`
`193`	`195`	`/// Module name`