git-cliff 2.12.0

A highly customizable changelog generator ⛰️
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

use git_cliff_core::error::Result;

/// Creates a profiler guard and returns it.
pub(crate) fn start_profiling() -> Option<pprof::ProfilerGuard<'static>> {
    match pprof::ProfilerGuardBuilder::default()
        .frequency(1000)
        .blocklist(&["libc", "libgcc", "pthread", "vdso"])
        .build()
    {
        Ok(guard) => Some(guard),
        Err(e) => {
            log::error!("Failed to build profiler guard: {e}");
            None
        }
    }
}

/// Reports the profiling results.
pub(crate) fn finish_profiling(profiler_guard: Option<pprof::ProfilerGuard>) -> Result<()> {
    match profiler_guard
        .expect("failed to retrieve profiler guard")
        .report()
        .build()
    {
        Ok(report) => {
            #[cfg(feature = "profiler-flamegraph")]
            {
                use std::fs::File;
                let random = rand::random::<u64>();
                let file = File::create(format!(
                    "{}.{random}.flamegraph.svg",
                    env!("CARGO_PKG_NAME"),
                ))?;
                if let Err(e) = report.flamegraph(file) {
                    log::error!("Failed to create flamegraph file: {e}");
                }
            }

            #[cfg(not(feature = "profiler-flamegraph"))]
            {
                log::info!("Report profiling: {:?}", &report);
            }
        }
        Err(e) => {
            log::error!("Failed to build profiler report: {e}");
        }
    }

    Ok(())
}