Skip to content

introduce LOG_TAGs, avoid repetitive prefixes #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 28, 2022
Merged

introduce LOG_TAGs, avoid repetitive prefixes #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e9b3f7c
reafactor: introduce LOG_TAG
drahnr Feb 9, 2022
90b09ed
split log tags
drahnr Feb 23, 2022
19af650
undo re-introduced `unwrap()`s
drahnr Feb 28, 2022
24287a2
cleanup rebase fallout
drahnr Feb 28, 2022
c0a64b7
remove another stray license comment
drahnr Feb 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 37 additions & 35 deletions src/pyroscope.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ use crate::{
timer::Timer,
};

const LOG_TAG: &str = "Pyroscope::Agent";

/// Pyroscope Agent Configuration. This is the configuration that is passed to the agent.
/// # Example
/// ```
Expand Down Expand Up @@ -58,7 +60,7 @@ impl PyroscopeConfig {
/// ```ignore
/// let mut config = PyroscopeConfig::new("http://localhost:8080", "my-app");
/// config.set_sample_rate(10)
/// .unwrap();
/// ?;
/// ```
pub fn sample_rate(self, sample_rate: i32) -> Self {
Self {
Expand All @@ -72,8 +74,7 @@ impl PyroscopeConfig {
/// ```ignore
/// use pyroscope::pyroscope::PyroscopeConfig;
/// let config = PyroscopeConfig::new("http://localhost:8080", "my-app")
/// .tags(vec![("env", "dev")])
/// .unwrap();
/// .tags(vec![("env", "dev")])?;
/// ```
pub fn tags(self, tags: &[(&str, &str)]) -> Self {
// Convert &[(&str, &str)] to HashMap(String, String)
Expand All @@ -100,7 +101,7 @@ impl PyroscopeConfig {
/// ```ignore
/// use pyroscope::pyroscope::PyroscopeAgentBuilder;
/// let builder = PyroscopeAgentBuilder::new("http://localhost:8080", "my-app");
/// let agent = builder.build().unwrap();
/// let agent = builder.build()?;
/// ```
pub struct PyroscopeAgentBuilder {
/// Profiler backend
Expand Down Expand Up @@ -130,7 +131,7 @@ impl PyroscopeAgentBuilder {
/// let builder = PyroscopeAgentBuilder::new("http://localhost:8080", "my-app")
/// .backend(Pprof::default())
/// .build()
/// .unwrap();
/// ?;
/// ```
pub fn backend<T>(self, backend: T) -> Self
where T: 'static + Backend {
Expand All @@ -146,7 +147,7 @@ impl PyroscopeAgentBuilder {
/// let builder = PyroscopeAgentBuilder::new("http://localhost:8080", "my-app")
/// .sample_rate(99)
/// .build()
/// .unwrap();
/// ?;
/// ```
pub fn sample_rate(self, sample_rate: i32) -> Self {
Self {
Expand All @@ -161,7 +162,7 @@ impl PyroscopeAgentBuilder {
/// let builder = PyroscopeAgentBuilder::new("http://localhost:8080", "my-app")
/// .tags(vec![("env", "dev")])
/// .build()
/// .unwrap();
/// ?;
/// ```
pub fn tags(self, tags: &[(&str, &str)]) -> Self {
Self {
Expand All @@ -175,15 +176,15 @@ impl PyroscopeAgentBuilder {
// Initiliaze the backend
let backend = Arc::clone(&self.backend);
backend.lock()?.initialize(self.config.sample_rate)?;
log::trace!("PyroscopeAgent - Backend initialized");
log::trace!(target: LOG_TAG, "Backend initialized");

// Start Timer
let timer = Timer::default().initialize()?;
log::trace!("PyroscopeAgent - Timer initialized");
log::trace!(target: LOG_TAG, "Timer initialized");

// Start the SessionManager
let session_manager = SessionManager::new()?;
log::trace!("PyroscopeAgent - SessionManager initialized");
log::trace!(target: LOG_TAG, "SessionManager initialized");

// Return PyroscopeAgent
Ok(PyroscopeAgent {
Expand Down Expand Up @@ -217,44 +218,45 @@ pub struct PyroscopeAgent {
impl Drop for PyroscopeAgent {
/// Properly shutdown the agent.
fn drop(&mut self) {
log::debug!("PyroscopeAgent - Dropping Agent");
log::debug!(target: LOG_TAG, "PyroscopeAgent::drop()");

// Drop Timer listeners
match self.timer.drop_listeners() {
Ok(_) => log::trace!("PyroscopeAgent - Dropped timer listeners"),
Err(_) => log::error!("PyroscopeAgent - Error Dropping timer listeners"),
Ok(_) => log::trace!(target: LOG_TAG, "Dropped timer listeners"),
Err(_) => log::error!(target: LOG_TAG, "Error Dropping timer listeners"),
}

// Wait for the Timer thread to finish
if let Some(handle) = self.timer.handle.take() {
match handle.join() {
Ok(_) => log::trace!("PyroscopeAgent - Dropped timer thread"),
Err(_) => log::error!("PyroscopeAgent - Error Dropping timer thread"),
Ok(_) => log::trace!(target: LOG_TAG, "Dropped timer thread"),
Err(_) => log::error!(target: LOG_TAG, "Error Dropping timer thread"),
}
}

// Stop the SessionManager
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"),
Ok(_) => log::trace!(target: LOG_TAG, "Sent 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() {
match handle.join() {
Ok(_) => log::trace!("PyroscopeAgent - Dropped SessionManager thread"),
Err(_) => log::error!("PyroscopeAgent - Error Dropping SessionManager thread"),
Ok(_) => log::trace!(target: LOG_TAG, "Dropped SessionManager thread"),
Err(_) => log::error!(target: LOG_TAG, "Error Dropping SessionManager thread"),
}
}

// Wait for main thread to finish

if let Some(handle) = self.handle.take() {
match handle.join() {
Ok(_) => log::trace!("PyroscopeAgent - Dropped main thread"),
Err(_) => log::error!("PyroscopeAgent - Error Dropping main thread"),
Ok(_) => log::trace!(target: LOG_TAG, "Dropped main thread"),
Err(_) => log::error!(target: LOG_TAG, "Error Dropping main thread"),
}
}

log::debug!("PyroscopeAgent - Agent Dropped");
log::debug!(target: LOG_TAG, "Agent Dropped");
}
}

Expand All @@ -263,15 +265,15 @@ impl PyroscopeAgent {
///
/// # Example
/// ```ignore
/// let agent = PyroscopeAgent::builder("http://localhost:8080", "my-app").build().unwrap();
/// let agent = PyroscopeAgent::builder("http://localhost:8080", "my-app").build()?;
/// ```
pub fn builder<S: AsRef<str>>(url: S, application_name: S) -> PyroscopeAgentBuilder {
// Build PyroscopeAgent
PyroscopeAgentBuilder::new(url, application_name)
}

fn _start(&mut self) -> Result<()> {
log::debug!("PyroscopeAgent - Starting");
log::debug!(target: LOG_TAG, "Starting");

// Create a clone of Backend
let backend = Arc::clone(&self.backend);
Expand All @@ -294,10 +296,10 @@ impl PyroscopeAgent {
let stx = self.session_manager.tx.clone();

self.handle = Some(std::thread::spawn(move || {
log::trace!("PyroscopeAgent - Main Thread started");
log::trace!(target: LOG_TAG, "Main Thread started");

while let Ok(until) = rx.recv() {
log::trace!("PyroscopeAgent - Sending session {}", until);
log::trace!(target: LOG_TAG, "Sending session {}", until);

// Generate report from backend
let report = backend.lock()?.report()?;
Expand All @@ -310,7 +312,7 @@ impl PyroscopeAgent {
)?))?;

if until == 0 {
log::trace!("PyroscopeAgent - Session Killed");
log::trace!(target: LOG_TAG, "Session Killed");

let (lock, cvar) = &*pair;
let mut running = lock.lock()?;
Expand All @@ -329,18 +331,18 @@ impl PyroscopeAgent {
/// 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();
/// let agent = PyroscopeAgent::builder("http://localhost:8080", "my-app").build()?;
/// agent.start();
/// ```
pub fn start(&mut self) {
match self._start() {
Ok(_) => log::trace!("PyroscopeAgent - Agent started"),
Err(_) => log::error!("PyroscopeAgent - Error starting agent"),
Ok(_) => log::trace!(target: LOG_TAG, "Agent started"),
Err(_) => log::error!(target: LOG_TAG, "Error starting agent"),
}
}

fn _stop(&mut self) -> Result<()> {
log::debug!("PyroscopeAgent - Stopping");
log::debug!(target: LOG_TAG, "Stopping");
// get tx and send termination signal
if let Some(sender) = self.tx.take() {
sender.send(0)?;
Expand Down Expand Up @@ -371,8 +373,8 @@ impl PyroscopeAgent {
/// ```
pub fn stop(&mut self) {
match self._stop() {
Ok(_) => log::trace!("PyroscopeAgent - Agent stopped"),
Err(_) => log::error!("PyroscopeAgent - Error stopping agent"),
Ok(_) => log::trace!(target: LOG_TAG, "Agent stopped"),
Err(_) => log::error!(target: LOG_TAG, "Error stopping agent"),
}
}

Expand All @@ -387,7 +389,7 @@ impl PyroscopeAgent {
/// agent.stop()?;
/// ```
pub fn add_tags(&mut self, tags: &[(&str, &str)]) -> Result<()> {
log::debug!("PyroscopeAgent - Adding tags");
log::debug!(target: LOG_TAG, "Adding tags");
// Check that tags are not empty
if tags.is_empty() {
return Ok(());
Expand Down Expand Up @@ -430,7 +432,7 @@ impl PyroscopeAgent {
/// # }
/// ```
pub fn remove_tags(&mut self, tags: &[&str]) -> Result<()> {
log::debug!("PyroscopeAgent - Removing tags");
log::debug!(target: LOG_TAG, "Removing tags");

// Check that tags are not empty
if tags.is_empty() {
Expand Down
15 changes: 8 additions & 7 deletions src/session.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ use crate::utils::get_time_range;
use crate::utils::merge_tags_with_app_name;
use crate::Result;

const LOG_TAG: &str = "Pyroscope::Session";

/// Session Signal
///
/// This enum is used to send data to the session thread. It can also kill the session thread.
Expand All @@ -32,15 +34,14 @@ pub struct SessionManager {
impl SessionManager {
/// Create a new SessionManager
pub fn new() -> Result<Self> {
log::info!("SessionManager - Creating SessionManager");
log::info!(target: LOG_TAG, "Creating SessionManager");

// Create a channel for sending and receiving sessions
let (tx, rx): (SyncSender<SessionSignal>, Receiver<SessionSignal>) = sync_channel(10);

// Create a thread for the SessionManager
let handle = Some(thread::spawn(move || {
log::trace!("SessionManager - SessionManager thread started");
// This thread should only return if a kill signal is received.
log::trace!(target: LOG_TAG, "Started");
while let Ok(signal) = rx.recv() {
match signal {
SessionSignal::Session(session) => {
Expand All @@ -54,7 +55,7 @@ impl SessionManager {
}
SessionSignal::Kill => {
// Kill the session manager
log::trace!("SessionManager - Kill signal received");
log::trace!(target: LOG_TAG, "Kill signal received");
return Ok(());
}
}
Expand All @@ -70,7 +71,7 @@ impl SessionManager {
// Push the session into the SessionManager
self.tx.send(session)?;

log::trace!("SessionManager - SessionSignal pushed");
log::trace!(target: LOG_TAG, "SessionSignal pushed");

Ok(())
}
Expand All @@ -97,7 +98,7 @@ impl Session {
/// let session = Session::new(until, config, report)?;
/// ```
pub fn new(until: u64, config: PyroscopeConfig, report: Vec<u8>) -> Result<Self> {
log::info!("Session - Creating Session");
log::info!(target: LOG_TAG, "Creating Session");

// get_time_range should be used with "from". We balance this by reducing
// 10s from the returned range.
Expand All @@ -121,7 +122,7 @@ impl Session {
/// session.send()?;
/// ```
pub fn send(self) -> Result<()> {
log::info!("Session - Sending Session {} - {}", self.from, self.until);
log::info!(target: LOG_TAG, "Sending Session: {} - {}", self.from, self.until);

// Check if the report is empty
if self.report.is_empty() {
Expand Down