Struct perfetto_consumer_proto::perfetto::protos::trace_config::AndroidReportConfig

pub struct AndroidReportConfig {
    pub reporter_service_package: Option<String>,
    pub reporter_service_class: Option<String>,
    pub skip_report: Option<bool>,
    pub use_pipe_in_framework_for_testing: Option<bool>,
}

Android-only. Not for general use. If set, reports the trace to the Android framework. This field is read by perfetto_cmd, rather than the tracing service. This field must be set when passing the –upload flag to perfetto_cmd.

In this message, either:

• |reporter_service_package| and |reporter_service_class| must be set.
• |skip_reporting| must be explicitly set to true.

Fields

reporter_service_package: Option<String>

reporter_service_class: Option<String>

skip_report: Option<bool>

If true, then skips reporting the trace to Android framework.

This flag is useful in testing (e.g. Perfetto-statsd integration tests) or when we explicitly don’t want to report traces to the framework even when they usually would (e.g. configs deployed using statsd but only used for inclusion in bugreports using |bugreport_score|).

The motivation for having this flag, instead of just not setting |framework_report_config|, is prevent accidents where |framework_report_config| is omitted by mistake.

use_pipe_in_framework_for_testing: Option<bool>

If true, will direct the Android framework to read the data in trace file and pass it to the reporter class over a pipe instead of passing the file descriptor directly.

This flag is needed because the Android test framework does not currently support priv-app helper apps (in terms of SELinux) and we really don’t want to add an allow rule for untrusted_app to receive trace fds.

Because of this, we instead will direct the framework to create a new pipe and pass this to the reporter process instead. As the pipe is created by the framework, we won’t have any problems with SELinux (system_server is already allowed to pass pipe fds, even to untrusted apps).

As the name suggests this option MUST only be used for testing. Note that the framework will reject (and drop) files which are too large both for simplicity and to be minimize the amount of data we pass to a non-priv app (note that the framework will still check manifest permissions even though SELinux permissions are worked around).

Implementations

impl AndroidReportConfig

pub fn reporter_service_package(&self) -> &str

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

pub fn reporter_service_class(&self) -> &str

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

pub fn skip_report(&self) -> bool

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

pub fn use_pipe_in_framework_for_testing(&self) -> bool

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

Trait Implementations

impl Clone for AndroidReportConfig

fn clone(&self) -> AndroidReportConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AndroidReportConfig

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

Formats the value using the given formatter.

impl Default for AndroidReportConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for AndroidReportConfig

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 AndroidReportConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for AndroidReportConfig