Struct ProcessSmapsConfig 

pub struct ProcessSmapsConfig {
    pub smaps_config: Option<SmapsConfig>,
    pub scope: Option<Scope>,
    pub read_period_ms: Option<u32>,
    pub max_processes_per_period: Option<u32>,
}

Config for the “linux.smaps” data source, describes one-shot or periodic /proc/pid/smaps collection.

A valid config must specify at least one |target_cmdline| or |target_uid|. Example:

data_sources { config { name: “linux.smaps” process_smaps_config { scope { target_cmdline: “top” target_cmdline: “tmux” } } } }

Fields

smaps_config: Option<SmapsConfig>

Which fields to record per process. If unset, defaults to {size, rss, anon, swap}, aggregated by path name.

scope: Option<Scope>

read_period_ms: Option<u32>

How often to recapture the smaps, including re-evaluating which processes match the |scope|. May be overridden by the implementation (at the time of writing, [1s, 24hr] range). If zero or unset, each process is captured only once at start.

max_processes_per_period: Option<u32>

Caps the number of processes handled per |read_period_ms|, or overall if the config is one-shot (period = 0). The immediate use case is to limit work if too many processes match the |scope|. Additionally, this option can be used for sampling, since the implementation inspects processes in a shuffled order (not in numeric pid order), and successive periods cover separate subsets of pids. So a config with scope=*, period=10s, and max_processes=5 would progressively scan all processes on the machine by parsing 5 processes at a time with 10s breaks in between. If zero or unset, there is no limit.

Implementations

impl ProcessSmapsConfig

pub fn read_period_ms(&self) -> u32

Returns the value of read_period_ms, or the default value if read_period_ms is unset.

pub fn max_processes_per_period(&self) -> u32

Returns the value of max_processes_per_period, or the default value if max_processes_per_period is unset.

Trait Implementations

impl Clone for ProcessSmapsConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProcessSmapsConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ProcessSmapsConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for ProcessSmapsConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ProcessSmapsConfig

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ProcessSmapsConfig