Struct MemoryProfiler

pub struct MemoryProfiler { /* private fields */ }

Available on Linux and crate feature memory-profiling and (crate features logging or metrics or telemetry or tracing) only.

A safe interface for jemalloc’s memory profiling functionality.

Implementations

impl MemoryProfiler

pub fn get_or_init_with( settings: &MemoryProfilerSettings, ) -> BootstrapResult<Option<Self>>

Creates a new profiler with the given settings or returns a previously initialized profiler ignoring the settings.

Enabling profiling

Note that profiling needs to be explicitly enabled by setting _RJEM_MALLOC_CONF=prof:true environment variable for the binary and with MemoryProfilerSettings::enabled being set to true. Otherwise, this method will return None.

If syscall sandboxing is being used (see crate::security for more details), telemetry must be initialized prior to syscall sandboxing.

pub async fn heap_profile(&self) -> Result<String>

Returns a heap profile.

Examples

use rustfoundry::telemetry::MemoryProfiler;
use rustfoundry::telemetry::settings::MemoryProfilerSettings;

#[tokio::main]
async fn main() {
    let settings = MemoryProfilerSettings {
        enabled: true,
        ..Default::default()
    };

    let profiler = MemoryProfiler::get_or_init_with(&settings)
        .unwrap()
        .expect("profiling should be enabled via `_RJEM_MALLOC_CONF=prof:true` env var");

    let profile = profiler.heap_profile().await.unwrap();

    assert!(profile.contains("MAPPED_LIBRARIES"));
}

pub fn heap_stats(&self) -> Result<String>

Returns heap statistics.

Examples

use rustfoundry::telemetry::MemoryProfiler;
use rustfoundry::telemetry::settings::MemoryProfilerSettings;

let settings = MemoryProfilerSettings {
    enabled: true,
    ..Default::default()
};

let profiler = MemoryProfiler::get_or_init_with(&settings)
    .unwrap()
    .expect("profiling should be enabled via `_RJEM_MALLOC_CONF=prof:true` env var");

let stats = profiler.heap_stats().unwrap();

assert!(stats.contains("Allocated"));

Trait Implementations

impl Clone for MemoryProfiler

fn clone(&self) -> MemoryProfiler

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for MemoryProfiler