Struct TrackEventConfig

pub struct TrackEventConfig {
    pub disabled_categories: Vec<String>,
    pub enabled_categories: Vec<String>,
    pub disabled_tags: Vec<String>,
    pub enabled_tags: Vec<String>,
    pub disable_incremental_timestamps: Option<bool>,
    pub timestamp_unit_multiplier: Option<u64>,
    pub filter_debug_annotations: Option<bool>,
    pub enable_thread_time_sampling: Option<bool>,
    pub filter_dynamic_event_names: Option<bool>,
}

The following fields define the set of enabled trace categories. Each list item is a glob.

To determine if category is enabled, it is checked against the filters in the following order:

1. Exact matches in enabled categories.
2. Exact matches in enabled tags.
3. Exact matches in disabled categories.
4. Exact matches in disabled tags.
5. Pattern matches in enabled categories.
6. Pattern matches in enabled tags.
7. Pattern matches in disabled categories.
8. Pattern matches in disabled tags.

If none of the steps produced a match:

• In the C++ SDK (perfetto::Category), categories are enabled by default.
• In the C SDK (PerfettoTeCategory), categories are disabled by default.

Examples:

• To enable all non-slow/debug categories:

  enabled_categories: “*”

• To enable specific categories:

  disabled_categories: “*” enabled_categories: “my_category” enabled_categories: “my_category2”

• To enable only categories with a specific tag:

  disabled_tags: “*” enabled_tags: “my_tag”

Fields

disabled_categories: Vec<String>

Default: []

enabled_categories: Vec<String>

Default: []

disabled_tags: Vec<String>

Default: [“slow”, “debug”]

enabled_tags: Vec<String>

Default: []

disable_incremental_timestamps: Option<bool>

Default: false (i.e. enabled by default)

timestamp_unit_multiplier: Option<u64>

Allows to specify a custom unit different than the default (ns). Also affects thread timestamps if enable_thread_time_sampling = true. A multiplier of 1000 means that a timestamp = 3 should be interpreted as 3000 ns = 3 us. Default: 1 (if unset, it should be read as 1).

filter_debug_annotations: Option<bool>

Default: false (i.e. debug_annotations is NOT filtered out by default) When true, any debug annotations provided as arguments to the TRACE_EVENT macros are not written into the trace. Typed arguments will still be emitted even if set to true.

enable_thread_time_sampling: Option<bool>

Default : false (i.e. disabled) When true, the SDK samples and emits the current thread time counter value for each event on the current thread’s track. This value represents the total CPU time consumed by that thread since its creation. Note that if a thread is not scheduled by OS for some duration, that time won’t be included in thread_time. Learn more : “CLOCK_THREAD_CPUTIME_ID” flag at https://linux.die.net/man/3/clock_gettime

filter_dynamic_event_names: Option<bool>

Default: false (i.e. dynamic event names are NOT filtered out by default) When true, event_names wrapped in perfetto::DynamicString will be filtered out.

Implementations

impl TrackEventConfig

pub fn disable_incremental_timestamps(&self) -> bool

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

pub fn timestamp_unit_multiplier(&self) -> u64

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

pub fn filter_debug_annotations(&self) -> bool

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

pub fn enable_thread_time_sampling(&self) -> bool

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

pub fn filter_dynamic_event_names(&self) -> bool

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

Trait Implementations

impl Clone for TrackEventConfig

fn clone(&self) -> TrackEventConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TrackEventConfig

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

Formats the value using the given formatter.

impl Default for TrackEventConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for TrackEventConfig

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 TrackEventConfig

fn eq(&self, other: &TrackEventConfig) -> 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 TrackEventConfig