Struct ProcessHeapSamples

pub struct ProcessHeapSamples {

    pub pid: Option<u64>,
    pub from_startup: Option<bool>,
    pub rejected_concurrent: Option<bool>,
    pub disconnected: Option<bool>,
    pub buffer_overran: Option<bool>,
    pub client_error: Option<i32>,
    pub buffer_corrupted: Option<bool>,
    pub hit_guardrail: Option<bool>,
    pub heap_name: Option<String>,
    pub sampling_interval_bytes: Option<u64>,
    pub orig_sampling_interval_bytes: Option<u64>,
    pub timestamp: Option<u64>,
    pub stats: Option<ProcessStats>,
    pub samples: Vec<HeapSample>,
}

Fields

pid: Option<u64>

from_startup: Option<bool>

This process was profiled from startup. If false, this process was already running when profiling started.

rejected_concurrent: Option<bool>

This process was not profiled because a concurrent session was active. If this is true, samples will be empty.

disconnected: Option<bool>

This process disconnected while it was profiled. If false, the process outlived the profiling session.

buffer_overran: Option<bool>

If disconnected, this disconnect was caused by the client overrunning the buffer. Equivalent to client_error == CLIENT_ERROR_HIT_TIMEOUT on new S builds.

client_error: Option<i32>

buffer_corrupted: Option<bool>

If disconnected, this disconnected was caused by the shared memory buffer being corrupted. THIS IS ALWAYS A BUG IN HEAPPROFD OR CLIENT MEMORY CORRUPTION.

hit_guardrail: Option<bool>

If disconnected, this disconnect was caused by heapprofd exceeding guardrails during this profiling session.

heap_name: Option<String>

sampling_interval_bytes: Option<u64>

orig_sampling_interval_bytes: Option<u64>

timestamp: Option<u64>

Timestamp of the state of the target process that this dump represents. This can be different to the timestamp of the TracePackets for various reasons:

• If disconnected is set above, this is the timestamp of last state heapprofd had of the process before it disconnected.
• Otherwise, if the rate of events produced by the process is high, heapprofd might be behind.

TODO(fmayer): This is MONOTONIC_COARSE. Refactor ClockSnapshot::Clock to have a type enum that we can reuse here.

stats: Option<ProcessStats>

Metadata about heapprofd.

samples: Vec<HeapSample>

Implementations

impl ProcessHeapSamples

pub fn pid(&self) -> u64

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

pub fn from_startup(&self) -> bool

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

pub fn rejected_concurrent(&self) -> bool

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

pub fn disconnected(&self) -> bool

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

pub fn buffer_overran(&self) -> bool

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

pub fn buffer_corrupted(&self) -> bool

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

pub fn timestamp(&self) -> u64

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

pub fn hit_guardrail(&self) -> bool

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

pub fn heap_name(&self) -> &str

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

pub fn sampling_interval_bytes(&self) -> u64

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

pub fn orig_sampling_interval_bytes(&self) -> u64

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

pub fn client_error(&self) -> ClientError

Returns the enum value of client_error, or the default if the field is unset or set to an invalid enum value.

pub fn set_client_error(&mut self, value: ClientError)

Sets client_error to the provided enum value.

Trait Implementations

impl Clone for ProcessHeapSamples

fn clone(&self) -> ProcessHeapSamples

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProcessHeapSamples

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

Formats the value using the given formatter.

impl Default for ProcessHeapSamples

fn default() -> Self

Returns the “default value” for a type.

impl Message for ProcessHeapSamples

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for ProcessHeapSamples

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ProcessHeapSamples