package profiler.proto
Get desktop application:
View/edit binary Protocol Buffers messages
rpc HeartBeat (, )
agent_service.proto:26A simple ping mechanism to notify perfd of the agent's existence, vice versa.
message
agent_service.proto:29(message has no fields)
service CpuService
cpu.proto:24rpc CheckAppProfilingState (, )
cpu.proto:70Checks whether an app is being profiled using StartProfilingApp and StopProfilingApp calls in this service at a given moment, assuming no other means have been used to start or stop profiling the app (such as 'am' command line tool or through DDMS).
message
cpu.proto:240int32 process_id = 1
optional session = 2
int64 timestamp = 3
The given moment that this request is querying about.
message
cpu.proto:247bool being_profiled = 1
True means the app in the request is being profiled by an earlier StartProfilingApp call that's successful, and a subsequent StopProfilingApp call hasn't happened.
optional start_request = 2
int64 start_timestamp = 3
The timestamp when the profiling started if the app is being profiled.
int64 check_timestamp = 4
The timestamp when the profiling state was checked.
rpc GetData (, )
cpu.proto:25message
cpu.proto:139Requests profiler data from the app with ID being |process_id|, in the time range from |start_timestamp| (exclusive) to |end_timestamp| (inclusive), or mathematically written as in interval (start_timestamp, end_timestamp].
int32 process_id = 1
Use |ANY_APP| if requesting the data of any apps.
optional session = 2
int64 start_timestamp = 3
Use -2^63 if no data is too old to return.
int64 end_timestamp = 4
Use 2^63 - 1 if no data is too recent to return.
message
cpu.proto:153repeated data = 1
rpc GetThreads (, )
cpu.proto:28message
cpu.proto:291Requests the state of all the threads in the given time range.
int32 process_id = 1
optional session = 2
int64 start_timestamp = 3
int64 end_timestamp = 4
message
cpu.proto:298repeated threads = 1
Threads with activities detected during the request range, ordered by thread id.
optional initial_snapshot = 2
The snapshot of threads that were alive at the beginning of the range.
rpc GetTrace (, )
cpu.proto:38message
cpu.proto:116int32 process_id = 1
optional session = 2
int32 trace_id = 3
Trace ID should be unique within an app.
message
cpu.proto:123GetTraceResponse.Status status = 1
bytes data = 2
CpuProfilerType profiler_type = 3
Type of the profiler used to obtain the trace.
rpc GetTraceInfo (, )
cpu.proto:31message
cpu.proto:82Requests all the traces that overlap with a time range.
int32 process_id = 1
optional session = 2
int64 from_timestamp = 3
inclusive
int64 to_timestamp = 4
inclusive
message
cpu.proto:89repeated trace_info = 1
rpc SaveTraceInfo (, )
cpu.proto:35This RPC is implemented by perfd-host only.
message
cpu.proto:93int32 process_id = 1
optional session = 2
optional trace_info = 3
message
cpu.proto:344(message has no fields)
rpc StartMonitoringApp (, )
cpu.proto:44Starts collecting execution metrics of a running app, such as usage info and thread states. Does nothing if the app is already being monitored. TODO(b/29258733): Support configuring sampling details.
message
cpu.proto:157int32 process_id = 1
optional session = 2
message
cpu.proto:162CpuStartResponse.Status status = 1
rpc StartProfilingApp (, )
cpu.proto:55Starts recording app stacktraces of a running app. Does nothing if the app is already being profiled with SimplePerf. Returns an error if the app is already being profiled with ART.
message
cpu.proto:208Returns the status and absolute path location (on device) where the trace file will be written.
CpuProfilingAppStartResponse.Status status = 1
string error_message = 2
rpc StopMonitoringApp (, )
cpu.proto:49Stops monitoring a running app. Does nothing if the app is not being monitored, or is not running.
message
cpu.proto:173int32 process_id = 1
optional session = 2
message
cpu.proto:178CpuStopResponse.Status status = 1
rpc StopProfilingApp (, )
cpu.proto:62Stops recording app stacktraces of a running app. Does nothing if the app is not being profiled, or is not running.
message
cpu.proto:220Request profiling of app (identified by its process id |process_id|) to stop.
int32 process_id = 1
optional session = 2
CpuProfilerType profiler_type = 3
message
cpu.proto:226CpuProfilingAppStopResponse.Status status = 1
string error_message = 2
int32 trace_id = 3
Trace ID should be unique within an app.
bytes trace = 4
TODO: remove this trace attribute after fully migrating to the new API.
service EventService
event.proto:24rpc GetActivityData (, )
event.proto:28Requests profiler data from the app with ID being |process_id|, in the time range from |start_timestamp| (exclusive) to |end_timestamp| (inclusive), or mathematically written as in interval (start_timestamp, end_timestamp].
message
event.proto:69repeated data = 1
rpc GetSystemData (, )
event.proto:31message
event.proto:73repeated data = 1
rpc StartMonitoringApp (, )
event.proto:34message
event.proto:41int32 process_id = 1
optional session = 2
message
event.proto:46EventStartResponse.Status status = 1
rpc StopMonitoringApp (, )
event.proto:37message
event.proto:55int32 process_id = 1
optional session = 2
message
event.proto:60EventStopResponse.Status status = 1
service GpuService
gpu.proto:10rpc GetData (, )
gpu.proto:11message
gpu.proto:16string app_package_name = 1
string activity_name = 2
optional session = 3
int64 start_timestamp = 4
Use -2^63 if no data is too old to return.
int64 end_timestamp = 5
message
gpu.proto:24repeated data = 1
rpc StartMonitoringApp (, )
gpu.proto:12message
gpu.proto:33int32 process_id = 1
optional session = 2
message
gpu.proto:38GpuStartResponse.Status status = 1
rpc StopMonitoringApp (, )
gpu.proto:13message
gpu.proto:49int32 process_id = 1
optional session = 2
message
gpu.proto:54GpuStopResponse.Status status = 1
service GraphicsService
graphics.proto:24rpc GetData (, )
graphics.proto:27Returns graphics data from the monitored Activity. This will return no data for Activities that do not use a SurfaceView.
message
graphics.proto:44Requests graphics data from the app's Activity, in the time range from |start_timestamp| (exclusive) to |end_timestamp| (inclusive), or mathematically written as in interval (start_timestamp, end_timestamp].
string app_package_name = 1
string activity_name = 2
optional session = 3
int64 start_timestamp = 4
Use -2^63 if no data is too old to return.
int64 end_timestamp = 5
Use 2^63 - 1 if no data is too recent to return.
message
graphics.proto:53Response contains data on the frames rendered within the requested time.
repeated data = 1
rpc StartMonitoringApp (, )
graphics.proto:32Starts collecting execution metrics of a running app's SurfaceView Activity, such as frame stats. Does nothing if the app is already being monitored.
message
graphics.proto:57string app_package_name = 1
string activity_name = 2
optional session = 3
message
graphics.proto:63GraphicsStartResponse.Status status = 1
rpc StopMonitoringApp (, )
graphics.proto:37Stops monitoring a running app. Does nothing if the app is not being monitored.
message
graphics.proto:72string app_package_name = 1
string activity_name = 2
optional session = 3
message
graphics.proto:78GraphicsStopResponse.Status status = 1
rpc SendActivity (, )
internal_event.proto:25Simple RPC service to send data to perfd. As events fire are triggered from the application. They will be sent to perfd and cached via this RPC.
rpc SendSystem (, )
internal_event.proto:27
message
internal_memory.proto:61int32 process_id = 1
optional alloc_stats_sample = 2
message
internal_memory.proto:66int32 process_id = 1
optional gc_stats_sample = 2
rpc RegisterMemoryAgent (, stream )
internal_memory.proto:25Register a memory agent in perfd and open a stream where perfd can send control requests to the agent.
message
internal_memory.proto:35int64 pid = 1
message
internal_memory.proto:39int64 pid = 1
oneof control
enable_request = 2
disable_request = 3
suspend_request = 4
resume_request = 5
message
internal_network.proto:35HTTP request registration data, used to communicate with perfd that a new request was just created. This also notifies the system that we are using a unique ID value to represent this request from now on in future GRPC messages associated with this connection.
int64 conn_id = 1
int32 process_id = 2
string url = 3
string trace = 4
int64 start_timestamp = 5
rpc SendChunk (, )
internal_network.proto:24message
internal_network.proto:45A small chunk of a body of data large enough that we want to stream it in pieces instead of all at once.
int64 conn_id = 1
bytes content = 2
ChunkRequest.Type type = 3
message
internal_network.proto:60An tracking message for an important moment in the lifetime of an HTTP request.
int64 conn_id = 1
int64 timestamp = 2
HttpEventRequest.Event event = 3
message
internal_network.proto:77Request data of HTTP connection.
int64 conn_id = 1
string fields = 2
Header fields associated with this request. See also: https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Request_fields.
string method = 3
message
internal_network.proto:86Response data of HTTP connection.
int64 conn_id = 1
string fields = 2
Header fields associated with this response. See also: https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Response_fields.
rpc TrackThread (, )
internal_network.proto:28message
internal_network.proto:93int64 conn_id = 1
optional thread = 2
service IoService
io.proto:24rpc GetData (, )
io.proto:37Get all sampled I/O data for an app. These include files opened, amount of bytes read/written.
message
io.proto:70int32 process_id = 1
optional session = 2
int64 start_timestamp = 3
exclusive
int64 end_timestamp = 4
inclusive
message
io.proto:77IoDataResponse.Status status = 1
repeated io_data = 2
rpc StartMonitoringApp (, )
io.proto:27Starts collecting I/O data of a running app. Does nothing if the app is already being monitored.
message
io.proto:41int32 process_id = 1
optional session = 2
message
io.proto:46IoStartResponse.Status status = 1
rpc StopMonitoringApp (, )
io.proto:32Stops monitoring a running app. Does nothing if the app is not being monitored, or is not running.
message
io.proto:56int32 process_id = 1
optional session = 2
message
io.proto:61IoStopResponse.Status status = 1
service MemoryService
memory.proto:24message
memory.proto:561int32 process_id = 1
optional session = 2
message
memory.proto:566(message has no fields)
rpc GetAllocationContexts (, )
memory.proto:85O+ studio-side only: Grabs the allocation classes and callstack info for GetAllocations results.
message
memory.proto:348int32 process_id = 1
optional session = 2
int64 start_time = 3
int64 end_time = 4
rpc GetAllocations (, )
memory.proto:80O+ studio-side only: Mirrors GetLegacyAllocationEvents but for O+ data. This returns a snapshot of all objects that have been allocated and free_data within the request's start and end times. Note that if an object is allocated and collected within the time range, it would not be included in the result.
message
memory.proto:453int32 process_id = 1
optional session = 2
int64 capture_time = 3
The start time (id) of the tracking session from which allocation data should be returned.
int64 start_time = 4
inclusive;
int64 end_time = 5
NOTE that compared to other proto request, end_time here is exclusive as ongoing live instances are set to have a free_timestamp of Long.MAX_VALUE. This allows us to naturally query for all current live instances by passing in MAX_VALUE as the end_time, without having to special case an invalid duration value.
exclusive;
rpc GetData (, )
memory.proto:33Get all memory data not related to live allocation for an app within a specified time request. These include the various memory levels, allocation count + gc events.
rpc GetHeapDump (, )
memory.proto:41rpc GetJvmtiData (, )
memory.proto:37Get live allocation memory data for an app within a specified time request. These includes alloc events, dealloc events and callstacks
Pre-O only: Returns class names and callstacks info associated with the ids provided in the request.
message
memory.proto:341int32 process_id = 1
optional session = 2
repeated int32 class_ids = 3
repeated int32 stack_ids = 4
Pre-O only: Used by Studio only for exporting legacy tracking data.
Pre-O only: Returns all allocation data associated with a tracking session.
message
memory.proto:311int32 process_id = 1
optional session = 2
int64 start_time = 3
exclusive
int64 end_time = 4
inclusive
message
memory.proto:318LegacyAllocationEventsResponse.Status status = 1
repeated events = 2
rpc GetStackFrameInfo (, )
memory.proto:90O+ studio-side only: Fetches the class + method names associated with a |method_id| within a tracking session.
message
memory.proto:417int32 process_id = 1
optional session = 2
int64 method_id = 3
message
memory.proto:423string class_name = 2
string method_name = 3
rpc ListHeapDumpInfos (, )
memory.proto:44List all heap dump records for an app within a specified time request.
message
memory.proto:250int32 process_id = 1
optional session = 2
int64 start_time = 3
exclusive
int64 end_time = 4
inclusive
message
memory.proto:257repeated infos = 1
Post-O only: Resume allocation tracking when switching back. This call will retrieve class data from beginning and enable allocation callbacks.
message
memory.proto:140int32 process_id = 1
optional session = 2
message
memory.proto:145ResumeTrackAllocationsResponse.Status status = 1
rpc StartMonitoringApp (, )
memory.proto:25message
memory.proto:97int32 process_id = 1
optional session = 2
message
memory.proto:102MemoryStartResponse.Status status = 1
rpc StopMonitoringApp (, )
memory.proto:27message
memory.proto:111int32 process_id = 1
optional session = 2
message
memory.proto:116MemoryStopResponse.Status status = 1
Post-O only: Suspend allocation tracking when switching to another session to optimize the performance. This call will disable allocation callbacks and clear the event queue.
message
memory.proto:125int32 process_id = 1
optional session = 2
message
memory.proto:130SuspendTrackAllocationsResponse.Status status = 1
rpc TrackAllocations (, )
memory.proto:52Enable or disable an allocation tracking session. Note that for pre-O, this call is handled on Studio side within the proxy layer, and allocation records are fetched upon the completion of a tracking session. For O+, this toggles live allocation tracking within the app, and allocation data is returned while the session is in progress.
message
memory.proto:293int32 process_id = 1
optional session = 2
int64 request_time = 3
bool enabled = 4
Requests whether an allocation tracking session is to be enabled/disabled. If a session is already in progress, re-enabling it does nothing, this is also true for disabling a session when no tracking is in progress.
bool legacy = 5
A flag to indicate whether the request is initiated via the legacy allocation tracking path. On pre-O setups, legacy tracking would simply mark the start and end times of a session. On O+ setups, perfd + the agent would perform allocation tracking.
message
memory.proto:280TrackAllocationsResponse.Status status = 1
optional info = 2
rpc TriggerHeapDump (, )
memory.proto:39message
memory.proto:212int32 process_id = 1
optional session = 2
int64 request_time = 3
message
memory.proto:218TriggerHeapDumpResponse.Status status = 1
optional info = 2
Returns the HeapDumpInfo immediately so the caller can optionally track its completion
service NetworkService
network.proto:24rpc GetData (, )
network.proto:28Requests profiler data from the app with ID being |process_id|, in the time range from |start_timestamp| (exclusive) to |end_timestamp| (inclusive), or mathematically written as in interval (start_timestamp, end_timestamp].
message
network.proto:95int32 process_id = 1
optional session = 2
int64 start_timestamp = 3
int64 end_timestamp = 4
NetworkDataRequest.Type type = 5
message
network.proto:121repeated data = 1
rpc GetHttpDetails (, )
network.proto:50Gets misc metadata about a http request, given its |conn_id| and a |HttpDetailsRequest::Type|. Use |GetHttpRange| to get this ids.
message
network.proto:200Message for querying metadata about an HTTP connection (by ID). Note that if the user queries details before they are ready, they will all be set to their default values (e.g. 0, empty string, etc.). TODO: Consider adding an error boolean if client queries at the wrong time. Is it necessary / helpful?
int64 conn_id = 1
optional session = 2
HttpDetailsRequest.Type type = 3
message
network.proto:237oneof details
request = 1
response = 2
request_body = 3
response_body = 4
accessing_threads = 5
rpc GetHttpRange (, )
network.proto:45Returns a list of HTTP requests active over some given time range. See the HttpRangeRequest message for more details. Note: HTTP requests may live across time ranges, so the same instances may be returned across multple calls to this rpc.
message
network.proto:160Request to fetch all http connections that were alive between some time range. Given a range [start, end] and requests a-f... start end a: [===========|===============|=========... b: [=======] | | c: [===|===] | d: | [=======] | e: | [===|===] f: | | [=======] Keep a, c, d, and e; exclude b and f The time range match is inclusive, so requests ending on time |start| and requests starting on time |end| will be included in the results.
int32 process_id = 1
optional session = 2
int64 start_timestamp = 3
int64 end_timestamp = 4
message
network.proto:191repeated data = 1
rpc StartMonitoringApp (, )
network.proto:33Starts collecting execution metrics of a running app, such as received and transmitted states. Does nothing if the app is already being monitored.
message
network.proto:125int32 process_id = 1
optional session = 2
message
network.proto:131TODO: Dig more about network collector start response.
(message has no fields)
rpc StopMonitoringApp (, )
network.proto:38Stops monitoring a running app. Does nothing if the app is not being monitored, or is not running.
message
network.proto:134int32 process_id = 1
optional session = 2
message
network.proto:140TODO: Dig more about network collector stop response.
(message has no fields)
rpc AttachAgent (, )
profiler_service.proto:55message
profiler_service.proto:59int32 process_id = 1
optional session = 2
string agent_lib_file_name = 3
TODO: This is temporary, remove when moving process discovery.
message
profiler_service.proto:66AgentAttachResponse.Status status = 1
Query for whether the agent is alive.
message
profiler_service.proto:127int32 process_id = 1
optional session = 2
message
profiler_service.proto:132AgentStatusResponse.Status status = 1
int64 last_timestamp = 2
The last time a heartbeat was received from the requested agent. If no heartbeat was ever detected, this returns INT64_MIN.
rpc GetBytes (, )
profiler_service.proto:48Query for cached byte data associated with some ID. Other services may return an ID which can be used to fetch data using this central cache.
message
profiler_service.proto:113string id = 1
ID for fetching contents from a cache. The value will always be safe to use as a filename, if you want to cache the contents locally to disk for example.
optional session = 2
message
profiler_service.proto:121bytes contents = 1
Byte contents from a cache, or "" if no data was found associated with the cache key used to fetch it, or if the data was removed after some timeout.
Gets current timestamp that used in the device's profiling data. A client may use this API to relate profiling data' timestamps to other clocks such as the desktop's calendar time. TODO(b/29223899): Add device's calendar time.
message
profiler_service.proto:75optional session = 1
message
profiler_service.proto:79int64 timestamp_ns = 1
What's used as timestamps in all profiler data (unless otherwise specified). (a.k.a: Timestamp from clock_gettime(CLOCK_MONOTONIC, ...), ns precision.)
int64 epoch_timestamp_us = 2
The number of microseconds since the Epoch. (a.k.a: Timestamp from gettimeofday, us precision.)
rpc GetDevices (, )
profiler_service.proto:38Gets the currently connected devices. TODO: expand with timing information for historical requests.
message
profiler_service.proto:98(message has no fields)
message
profiler_service.proto:101repeated device = 1
Gets the running processes of a given device TODO expand with timing information for historical requests.
message
profiler_service.proto:105optional session = 1
message
profiler_service.proto:109repeated process = 2
rpc GetVersion (, )
profiler_service.proto:33Gets version.
message
profiler_service.proto:90optional session = 1
message
profiler_service.proto:94string version = 1
message
event.proto:100Used as request type in: InternalEventService.SendActivity
Used as field type in:
string name = 1
Name of the activity
int64 hash = 2
Unique hash identifying this activity from similarly named ones.
int32 process_id = 3
Application Id this activity is associated with.
repeated state_changes = 4
State changes for activities and fragments.
optional fragment_data = 5
TODO: Expand this to a oneof if more components need to add specific information. Additional data needed by specific UI components
message
event.proto:115Used in:
int64 timestamp = 1
ActivityStateData.ActivityState state = 2
Used in:
UNSPECIFIED = 0
ADDED = 1
ATTACHED = 2
CREATED = 3
CREATEDVIEW = 4
ACTIVITYCREATED = 5
STARTED = 6
RESUMED = 7
PAUSED = 8
STOPPED = 9
SAVED = 10
DETACHED = 11
REMOVED = 12
DESTROYED = 13
DESTROYEDVIEW = 14
RESTARTED = 15
Used in:
UNSPECIFICED = 0
SUCCESS = 1
FAILURE_UNKNOWN = 2
message
agent_service.proto:40Proto used for configuring perfd + perfa. The message itself is created and pushed to device from Studio and can be access via profiler::Config::Instance().
bool use_jvmti = 1
equivalent to profiler.jvmti flag in Studio
optional mem_config = 2
SocketType socket_type = 3
Which socket type we are using when setting up our service if the device is O+ we use service_socket_name and ABSTRACT_SOCKET. If the device is pre O we use UNSPECIFIED_SOCKET and use the service_address.
string service_address = 4
address used for legacy devices (Nougat or older).
string service_socket_name = 5
address used for jvmti devices that use unix sockets.
message
agent_service.proto:41Used in:
bool use_live_alloc = 1
equivalent to profiler.livealloc flag in Studio.
int32 max_stack_depth = 2
the maximum depth of allocation stack traces to record.
Used in:
UNSPECIFIED = 0
ATTACHED = 1
DETACHED = 2
message
memory.proto:365Used in: ,
int32 class_id = 1
string class_name = 2
int32 class_loader_id = 3
message
memory.proto:355Used as response type in: MemoryService.GetAllocationContexts, MemoryService.GetLegacyAllocationContexts
int64 timestamp = 1
O+ only. Records the timestamp of the latest class/stack entry returned by the response.
repeated allocated_classes = 2
repeated allocation_stacks = 3
repeated allocation_threads = 4
O+ only. All seen thread Ids -> Strings mapping
message
memory.proto:489Proto format for handling O+ allocation data.
Used in:
int64 timestamp = 2
If it is an allocation event, this marks the exact time when the alloc happens. If it is a deallocation event, this should match the last gc end time.
oneof event
class_data = 3
Special case for java/lang/Class object allocations. Note that a Klass event is expected to precede any Allocation which references its class via the class_tag field.
alloc_data = 4
free_data = 5
message
memory.proto:490Used in:
int32 tag = 1
int32 class_tag = 2
int64 size = 3
int32 length = 4
Length for array objects. For non-arrays, set to -1.
int32 thread_id = 5
Profiler-generated Id representing a thread. Valid id starts at 1 as 0 is used as a default no-value.
int32 stack_id = 6
Profiler-Id representing the allocation stack. Valid id starts at 1 as 0 is used as a default no-value.
int32 heap_id = 7
Which heap an object was allocated from. The id's are manually mapped to their corresponding names in Studio (e.g. Zygote vs App).
repeated int64 method_ids = 8
Entire list of methods corresponding to the allocation stack. Note that this is only used for temporary storage in perfa. When the data is sent from perfa->perfd, the list is encoded as |stack_id| above, and the encoded data is stored/sent separately using EncodedAllocationStack. First entry is top of stack.
repeated int64 location_ids = 9
Similar to |method_ids| above, this is only for temporary storage. The actual converted line numbers are stored/sent to studio via EncodedAllocationStack.
string thread_name = 10
Temporary storage in perfa only. The thread info will be encoded into |thread_id| before transfer from perfa->perfd. The thread id -> name mapping is sent separately via ThreadInfo messages.
message
memory.proto:528Used in:
int32 tag = 1
int32 class_tag = 2
The following are host/client-side only (e.g. Studio-only).
int64 alloc_time = 3
int64 size = 4
int32 length = 5
Length for array objects. For non-arrays, set to -1.
int32 thread_id = 6
Thread + Stack Id of the allocation of the same object.
int32 stack_id = 7
int32 heap_id = 8
message
memory.proto:372Proto format for handling stack data for both pre-O and O+.
Used in:
int32 stack_id = 1
oneof frame
full_stack = 2
small_stack = 3
message
memory.proto:393studio-side only - a smaller proto format to store lazy- loaded stack frame objects. This is used specifically for showing live allocation tracking data (O+ JVMTI), where an app can run up to 2M+ unique frames. Given proto objects do not support null values, each string field in StackFrame holds default values that can add up to hundreds of MBs for these apps.
Used in:
int64 method_id = 1
int32 line_number = 2
message
memory.proto:406Wrapper proto for SmallFrame since oneof does not support repeated fields.
Used in:
repeated frames = 1
message
memory.proto:373Used in: ,
int64 method_id = 1
O+ only for uniquely idenfitying a method.
string class_name = 2
string method_name = 3
string file_name = 4
Pre-O only. File name info is unavailable in JVMTI. TODO: investigate/feature request.
int32 line_number = 5
message
memory.proto:400Wrapper proto for StackFrame since oneof does not support repeated fields.
Used in:
repeated frames = 1
message
memory.proto:266Proto for describing an allocation tracking record. Simliar to HeapDumpInfo, an AllocationsInfo is returned if either the start_time or end_time falls within the requested time window. It is the responsibility of the requester to dedupe a completed info if there was an unfinished info that was previously sent.
Used in: ,
AllocationsInfo.Status status = 1
int64 start_time = 2
int64 end_time = 3
bool legacy = 4
Used in:
UNSPECIFIED = 0
IN_PROGRESS = 1
COMPLETED = 2
FAILURE_UNKNOWN = 3
UNSPECIFIED = 0
Enum with default value required by proto
ANY = -1
Indicates that a feature is not tied to any single app
message
memory.proto:471Batched AllocationEvents to minimize number of grpc calls compared to transferring them individually.
Used as request type in: InternalMemoryService.RecordAllocationEvents
Used as response type in: MemoryService.GetAllocations
Used as field type in:
int32 process_id = 1
int64 timestamp = 2
From Perfa->Perfd and Perfd->Studio, this marks the time(ns) when the sample was first created in the agent. Within Studio, this indicates the latest timestamp amongst the events list.
repeated events = 3
repeated methods = 4
The following fields are used for transfering stack info from device to studio only. Within studio, stack info are retrieved via GetAllocationContexts.
repeated stacks = 5
repeated thread_infos = 6
Used in:
UNSPECIFIED = 0
REQUEST = 1
This is a chunk of a request (uploaded) body
RESPONSE = 2
This is a chunk of a response (downloaded) body
message
profiler.proto:30TODO: Add more essential fields.
Used as request type in: AgentService.HeartBeat
Used as field type in: , , , ,
int32 process_id = 1
optional session = 2
int64 end_timestamp = 3
message
network.proto:72Used in:
int32 connection_number = 1
message
network.proto:74Used in:
ConnectivityData.RadioState radio_state = 1
ConnectivityData.NetworkType default_network_type = 2
Used in:
INVALID = 0
MOBILE = 1
WIFI = 2
Used in:
UNSPECIFIED = 0
HIGH = 1
The radio is in a high-energy state, having recently sent out some network traffic
LOW = 3
The radio is in a low-energy state, having powered down after a period of inactivity.
Set to 3 for backwards-compatibility reasons
UNSPECIFIED = 0
Protobuf requires the first enum value to be zero.
ANY_APP = -1
A speical value used in |process_id| field to indicate the data of all apps are requested.
message
cpu.proto:260CPU data of a given app process.
Used in:
optional basic_info = 1
optional cpu_usage = 2
Used in: , , ,
UNSPECIFIED_PROFILER = 0
ART = 1
SIMPLE_PERF = 2
message
cpu.proto:190Request profiling of app (identified by its process id |process_id|) to start. INSTRUMENTED is support only when ART is the profiler.
Used as request type in: CpuService.StartProfilingApp
Used as field type in:
int32 process_id = 1
optional session = 2
CpuProfilingAppStartRequest.Mode mode = 3
CpuProfilerType profiler_type = 4
int32 buffer_size_in_mb = 5
When using ART, the size of the in-memory buffer that holds tracing data.
int32 sampling_interval_us = 6
When using sampling, the sampling interval in microseconds.
Used in:
UNSTATED = 0
SAMPLED = 1
INSTRUMENTED = 2
Used in:
UNSPECIFIED = 0
SUCCESS = 1
FAILURE = 2
Used in:
UNSPECIFIED = 0
SUCCESS = 1
FAILURE = 2
Used in:
UNSPECIFIED = 0
SUCCESS = 1
FAILURE_APP_NOT_RUNNING = 2
FAILURE_UNKNOWN = 3
FAILURE = 4
Used in:
UNSPECIFIED = 0
SUCCESS = 1
FAILURE_UNKNOWN = 2
message
cpu.proto:279CPU usage data of an app process and the entire system at a given point. CPU usage data is most valuable when app data is combined with system data, e.g., showing the CPU usage percentage number. One data consumer (e.g., an Android Studio instance) would request an app's data, and another consumer (e.g., another Android Studio instance) would request another app's. Both of them need system data. Therefore, we put system data together with every piece of app specific data. The absolute values of fields in this message are not very interesting. The difference of two instances is more useful. It can show the system- wide CPU utilization percentage and an app's CPU utilization percentage. The values of the fields may overflow their type, but the usefulness stays the same.
Used in:
int64 app_cpu_time_in_millisec = 1
Amount of time that this process has been using CPU, measured in milliseconds.
int64 system_cpu_time_in_millisec = 2
Amount of time that the entire system (including applications) has been using CPU, measured in milliseconds.
int64 elapsed_time_in_millisec = 3
Amount of time since the system start, measured in milliseconds.
message
profiler_service.proto:149Used in: ,
string manufacturer = 1
e.g. 'Google', 'Motorola'
string model = 2
e.g. 'Nexus 5', 'Pixel XL'
string serial = 3
unique ID for this device
string version = 4
e.g. '5.1.1', '8.0.0'
int32 api_level = 5
e.g. 19, 25
string codename = 10
Identifies preview versions by API letter (e.g. 'O'), or '' for release
int32 feature_level = 6
|feature_level| will either be the same as |api_level| or |api_level + 1| if the current device is a preview version. Code should check against |feature_level|, not |api_level|, to see if a feature is available in the framework or not. If |feature_level != api_level|, then |codename| will also be set.
string boot_id = 7
unique ID regenerated each boot time
bool is_emulator = 8
Device.State state = 9
Used in:
UNSPECIFIED = 0
ONLINE = 1
OFFLINE = 2
e.g. emulator that is turned off
DISCONNECTED = 3
e.g. unplugged
message
profiler_service.proto:144optional device = 1
repeated process = 2
message
memory.proto:232Used as request type in: MemoryService.GetHeapDump, MemoryService.GetLegacyAllocationDump
int32 process_id = 1
optional session = 2
int64 dump_time = 3
message
memory.proto:238Used as response type in: MemoryService.GetHeapDump, MemoryService.GetLegacyAllocationDump
DumpDataResponse.Status status = 1
bytes data = 2
Used in:
UNSPECIFIED = 0
SUCCESS = 1
NOT_READY = 2
NOT_FOUND = 3
FAILURE_UNKNOWN = 4
message
internal_event.proto:31Used as response type in: InternalEventService.SendActivity, InternalEventService.SendSystem
(message has no fields)
message
internal_memory.proto:71Used as response type in: InternalMemoryService.RecordAllocStats, InternalMemoryService.RecordAllocationEvents, InternalMemoryService.RecordGcStats
(message has no fields)
message
internal_network.proto:98Used as response type in: InternalNetworkService.RegisterHttpData, InternalNetworkService.SendChunk, InternalNetworkService.SendHttpEvent, InternalNetworkService.SendHttpRequest, InternalNetworkService.SendHttpResponse, InternalNetworkService.TrackThread
(message has no fields)
message
memory.proto:432Proto format for storing and transmitting O+ stack data efficiently. The |stack_id| field uniquely identifies a stack within an app, each |method_id| is referenced by AllocationStack.StackFrame which contains detailed info about the method.
Used in:
int64 timestamp = 1
The time when this stack was first seen. It should match the first AllocationEvent::Allocation that generated the stack.
int32 stack_id = 2
repeated int64 method_ids = 3
repeated int32 line_numbers = 4
message
event.proto:142Used as request type in: EventService.GetActivityData, EventService.GetSystemData
int32 process_id = 1
optional session = 2
int64 start_timestamp = 3
int64 end_timestamp = 4
EventDataRequest.EventType data_type = 5
Used in:
UNSPECIFIED = 0
ALL = 1
All types of data are requested.
SYSTEM_EVENTS = 2
All system level events, touch, rotate, button presses ect...
ACTIVITY_EVENTS = 3
All activity level events, created, activated, resumed, suspended ect...
FRAGMENT_EVENTS = 4
All fragment events
Used in:
UNSPECIFICED = 0
SUCCESS = 1
FAILURE_UNKNOWN = 2
Used in:
UNSPECIFICED = 0
SUCCESS = 1
FAILURE_UNKNOWN = 2
message
event.proto:138Used in:
int64 activity_context_hash = 1
message
graphics.proto:94Framestats of a SurfaceView frame.
Used in:
int64 app_draw_timestamp = 1
The app draw timestamp in nanoseconds (when the app started to draw)
int64 vsync_timestamp = 2
The vsync timestamp in nanoseconds immediately after SF submited the frame to the h/w
int64 set_timestamp = 3
The timestamp in nanoseconds immediately after SF submitted the frame to the h/w
Used in: ,
UNSPECIFIED = 0
RUNNING = 1
SLEEPING = 2
WAITING = 3
ZOMBIE = 4
STOPPED = 5
TRACING = 6
PAGING = 7
DEAD = 8
WAKEKILL = 9
WAKING = 10
PARKED = 11
message
cpu.proto:331TODO: unify with Thread
Used in:
int32 tid = 1
string name = 2
repeated activities = 3
message
cpu.proto:325Used in:
int64 timestamp = 1
State new_state = 2
message
cpu.proto:315Snapshot of the threads that were alive at a given moment.
Used in:
repeated threads = 1
int64 timestamp = 2
message
cpu.proto:316Used in:
int32 tid = 1
string name = 2
State state = 3
TODO: add more status as needed.
Used in:
UNSPECIFIED = 0
SUCCESS = 1
FAILURE = 2
message
gpu.proto:28Used in:
optional basic_info = 1
float utilization = 2
Used in:
UNSPECIFIED = 0
SUCCESS = 1
FAILURE_APP_NOT_RUNNING = 2
FAILURE_UNKNOWN = 3
FAILURE = 4
Used in:
UNSPECIFIED = 0
SUCCESS = 1
FAILURE_UNKNOWN = 2
message
graphics.proto:88Graphics data of a SurfaceView frame.
Used in:
optional basic_info = 1
optional frame_stats = 2
Used in:
UNSPECIFIED = 0
SUCCESS = 1
FAILURE = 2
Used in:
UNSPECIFIED = 0
SUCCESS = 1
FAILURE = 2
message
memory.proto:205Proto for describing a heap dump record. A HeapDumpInfo is returned if either the start_time or end_time falls within the requested time window. e.g. An info can be returned across multiple requests: 1. When a heap dump is first triggered with start_time specified. 2. When the heap dump completes/fails with end_time specified. It is the responsibility of the requester to dedupe a completed info if there was an unfinished info that was previously sent.
Used in: , ,
int64 start_time = 1
int64 end_time = 2
string file_name = 3
bool success = 4
message
network.proto:179An HTTP connection represents the full lifetime of a single HTTP request / response network communication.
Used in:
int64 conn_id = 1
A unique identifer used to fetch any further details about this request. This id is guaranteed unique across all actively running apps.
int64 start_timestamp = 2
Always set. Time this network request was first opened.
int64 downloading_timestamp = 3
If not 0, time when the first byte was received. Always > start.
int64 end_timestamp = 4
If not 0, time when request was closed. Always > start.
Used in:
UNSPECIFIED = 0
REQUEST = 1
Metadata about a sent request. This data can be queried as soon as you have a connection ID to fetch it.
RESPONSE = 2
Metadata about a received response. This data can be safely be queried for any connection that has its end_timestamp set to a non-zero value. (Otherwise, all the fields in the returned details will be empty) TODO: This detail type is not yet implemented.
REQUEST_BODY = 3
Fetch a path to the request body which can then be fetched over adb. TODO: This detail type is not yet implemented.
RESPONSE_BODY = 4
Fetch a handle to the response body which can be fetched over adb. This data can be safely queried for any connection that has its end_timestamp set to a non-zero value. TODO: Can this type be combined with RESPONSE? Will reponse details be available before this is ready, or only at the same time?
ACCESSING_THREADS = 5
Fetch accessed threads of a connection. This data can be queried as soon as you have a connection ID, however as a different thread may be added during the lifetime of the connection, it's advised to repeat the request when its end_timestamp is a non-zero value.
message
network.proto:272Used in:
repeated thread = 1
Threads that access a connection. The first thread is the thread that creates the connection.
message
network.proto:258Used in:
string payload_id = 1
An ID which will uniquely identify the contents of an http body. It can be used to fetch payload bytes via |ProfilerService.GetBytes|. This value will be a hash of the contents, and the same hash always indicates the same contents. This hash value calculation is independent of app, device, etc., and can always* be relied upon to indicate content equality. (*) with negligible probability of a collision Looks something like: "d652e629bcf87c998c614"
message
network.proto:238Used in:
string url = 1
string method = 2
The request's method, e.g. GET, PUT, POST, etc.
string fields = 3
Key/value pairs associated with the request
string trace = 4
Code stack trace for where this request was generated
message
network.proto:250Used in:
string code = 1
Response code, e.g. OK, 404, etc.
string fields = 2
Key/value pairs associated with the response
Used in:
UNSPECIFIED = 0
CREATED = 1
UPLOAD_STARTED = 2
UPLOAD_COMPLETED = 3
DOWNLOAD_STARTED = 4
DOWNLOAD_COMPLETED = 5
ABORTED = 6
message
io.proto:92Contains for each file operated on in this period, when it was opened, closed, written to or read from.
Used in:
string file_path = 1
repeated file_sessions = 2
message
io.proto:104A FileSession represents a session of operating on a file from when it was opened until it is closed. e.g. {open, read, read, write, read, close}
Used in:
int64 open_timestamp = 1
Timestamp of opening the file
int64 close_timestamp = 2
Timestamp of closing the file or FUTURE if it's not closed yet
repeated io_system_calls = 3
message
io.proto:106Corresponds to a single write/read system call
Used in:
Type type = 1
int64 start_timestamp = 2
Timestamp when the system call started
int64 end_timestamp = 3
Timestamp when the system call ended or FUTURE if it hasn't yet
int64 bytes_count = 4
Amount of bytes read or written
UNKNOWN = 0
has already happened at the serving time but the timestamp is not known to the I/O profiler
FUTURE = -1
hasn't happened yet at the serving time
message
io.proto:136Used in:
oneof data
file_data = 1
speed_data = 2
optional common_data = 3
message
io.proto:129Contains the current overall speed of writing/reading
Used in:
Type type = 1
int64 speed = 2
The speed of writing/reading in bytes/second
Used in:
UNSPECIFIED_STATUS = 0
SUCCESS = 1
FAILURE = 2
Used in: ,
UNSPECIFIED_TYPE = 0
READ = 1
WRITE = 2
Used in:
UNSPECIFIED = 0
SUCCESS = 1
FAILURE_APP_NOT_RUNNING = 2
FAILURE = 3
Used in:
UNSPECIFIED = 0
SUCCESS = 1
FAILURE = 2
message
network.proto:169Thread information obtained from Java, which is different from the thread data we would obtain from a JNI context. See also: https://docs.oracle.com/javase/7/docs/api/java/lang/Thread.html
Used in: ,
int64 id = 1
ID of the thread obtained from Java, which is different from the thread ID obtained in a JNI context.
string name = 2
Name of the thread. https://docs.oracle.com/javase/7/docs/api/java/lang/Thread.html#getName().
message
memory.proto:330Used in:
int64 capture_time = 1
capture_time associates with a particular tracking session. TODO: include endTime for de-allocation tracking
int64 timestamp = 2
int32 size = 3
int32 thread_id = 4
int32 class_id = 5
int32 stack_id = 6
Used in:
UNSPECIFIED = 0
SUCCESS = 1
NOT_READY = 2
NOT_FOUND = 3
FAILURE_UNKNOWN = 4
message
internal_memory.proto:44Used in:
int64 timestamp = 1
message
internal_memory.proto:40Used in:
int64 timestamp = 1
message
internal_memory.proto:50Used in:
(message has no fields)
message
internal_memory.proto:48Used in:
(message has no fields)
message
memory.proto:162Used as response type in: MemoryService.GetData, MemoryService.GetJvmtiData
int64 end_timestamp = 1
end timestamp after which values are yet to be queried for
repeated mem_samples = 2
repeated alloc_stats_samples = 3
repeated gc_stats_samples = 4
repeated heap_dump_infos = 5
repeated allocations_info = 6
repeated allocation_samples = 7
message
memory.proto:174Used in: ,
int64 timestamp = 1
int32 java_allocation_count = 2
int32 java_free_count = 3
message
memory.proto:180Used in: ,
int64 start_time = 1
int64 end_time = 2
TODO add deallocation stats
message
memory.proto:163Used in:
int64 timestamp = 1
int64 java_mem = 2
int64 native_mem = 3
int64 stack_mem = 4
int64 graphics_mem = 5
int64 code_mem = 6
int64 others_mem = 7
int64 total_mem = 8
message
memory.proto:155Used as request type in: MemoryService.GetData, MemoryService.GetJvmtiData
int32 process_id = 1
optional session = 2
int64 start_time = 3
exclusive
int64 end_time = 4
inclusive
Used in:
UNSPECIFICED = 0
SUCCESS = 1
FAILURE_UNKNOWN = 2
Used in:
UNSPECIFICED = 0
SUCCESS = 1
FAILURE_UNKNOWN = 2
UNSPECIFIED = 0
First enum value is required to be zero.
ANY_APP = -1
process_id field special value, it means these data is applicable to any app.
Used in:
ALL = 0
All types of network data are requested.
CONNECTIVITY = 1
Default network type (wifi or mobile) and radio power state. This data is device-wide and the same values will be returned across all valid |process_id| values.
SPEED = 2
Network transmitted and received speeds (in bytes / sec).
CONNECTIONS = 3
Number of open connections.
message
network.proto:55Used in:
optional basic_info = 1
oneof data
speed_data = 2
connection_data = 3
connectivity_data = 4
message
profiler_service.proto:172Used in: ,
string name = 1
int32 pid = 2
Process.State state = 3
int64 start_timestamp_ns = 4
string abi_cpu_arch = 5
Used in:
UNSPECIFIED = 0
ALIVE = 1
DEAD = 2
Used in:
UNSPECIFIED = 0
SUCCESS = 1
NOT_PROFILING = 2
FAILURE_UNKNOWN = 3
message
profiler.proto:36Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
string device_serial = 1
string boot_id = 2
Used in:
UNSPECIFIED_SOCKET = 0
ABSTRACT_SOCKET = 1
message
network.proto:67TODO: Break these up into their own messages (since tx and rx speeds can have unique timestamps), unless the error we get by combining them in the same message ends up being too subtle to matter
Used in:
int64 sent = 1
bytes / sec
int64 received = 2
bytes / sec
Used in:
UNSPECIFIED = 0
SUCCESS = 1
NOT_PROFILING = 2
FAILURE_UNKNOWN = 3
message
event.proto:79TODO: Add support for KeyEvents, and ButtonEvents. The current setup allows for only touch.
Used as request type in: InternalEventService.SendSystem
Used as field type in:
SystemData.SystemEventType type = 1
int32 action_id = 2
This field stores actions triggered by an event. Actions are defined in MotionEvent.java. https://developer.android.com/reference/android/view/MotionEvent.html
int64 start_timestamp = 3
int64 end_timestamp = 4
int32 process_id = 5
int64 event_id = 6
string event_data = 7
Each system event message is associated with one event type.
Used in:
UNSPECIFIED = 0
TOUCH = 1
KEY = 2
ROTATION = 3
message
cpu.proto:99Used in:
int32 tid = 1
string name = 2
message
memory.proto:445Proto format for storing and transmitting O+ thread data. JVMTI provides an API to get a thread's name but not id. To avoid sending too much duplicated string datas, we encode thread names to id manually and resolve them on Studio-side.
Used in: ,
int64 timestamp = 1
The time when this thread was first seen. It should match the first AllocationEvent::Allocation that generated the stack.
int32 thread_id = 2
string thread_name = 3
message
cpu.proto:107A TraceInfo contains the information regarding a trace and should be returned if its time overlaps with the one defined in a GetTraceInfoRequest.
Used in: ,
CpuProfilerType profiler_type = 1
int64 from_timestamp = 2
inclusive
int64 to_timestamp = 3
inclusive
int32 trace_id = 4
repeated threads = 5
These threads are those having data captured by the designated trace.
Used in:
UNSPECIFIED = 0
SUCCESS = 1
IN_PROGRESS = 2
NOT_ENABLED = 3
NOT_PROFILING = 4
FAILURE_UNKNOWN = 5
Used in:
UNSPECIFIED = 0
SUCCESS = 1
IN_PROGRESS = 2
NOT_PROFILING = 3
FAILURE_UNKNOWN = 4