pyroscope 0.0.1-alpha

Pyroscope Profiler
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

// Copyright 2021 Developers of Pyroscope.

// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0>. This file may not be copied, modified, or distributed
// except according to those terms.


//! Rust integration for [Pyroscope](https://pyroscope.io).
//!
//! # Quick Start
//!
//! ## Configure Pyroscope Agent
//!
//! ```ignore
//! let mut agent =
//!     PyroscopeAgent::builder("http://localhost:4040", "fibonacci")
//!        .frequency(100)
//!     .tags(
//!      [
//!       ("TagA".to_owned(), "ValueA".to_owned()),
//!    ("TagB".to_owned(), "ValueB".to_owned()),
//!      ]
//!          .iter()
//!        .cloned()
//!      .collect(),
//!         )
//!     .build()
//!    ?;
//! ```
//!
//! ## Start/Stop profiling
//! 
//! To start profiling code and sending data.
//!
//! ```ignore
//!  agent.start()?;
//! ```
//!
//! To stop profiling code. You can restart the profiling at a later point.
//!
//! ```ignore
//!  agent.stop().await?;
//! ```

// Re-exports structs
pub use crate::pyroscope::PyroscopeAgent;
pub use error::{Result, PyroscopeError};

// Public modules
pub mod pyroscope;
pub mod error;

// Private modules
mod utils;