package perftools.profiles

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Profile

• uint64 id = 1

  Unique nonzero id for the function.

• int64 name = 2

  Name of the function, in human-readable form if available.

  Index into string table

• int64 system_name = 3

  Name of the function, as identified by the system. For instance, it can be a C++ mangled name.

  Index into string table

• int64 filename = 4

  Source file containing the function.

  Index into string table

• int64 start_line = 5

  Line number in source file.

Used in: Sample

• int64 key = 1

  Index into string table

• int64 str = 2

  At most one of the following must be present

  Index into string table

• int64 num = 3

• int64 num_unit = 4

  Should only be present when num is present. Specifies the units of num. Use arbitrary string (for example, "requests") as a custom count unit. If no unit is specified, consumer may apply heuristic to deduce the unit. Consumers may also interpret units like "bytes" and "kilobytes" as memory units and units like "seconds" and "nanoseconds" as time units, and apply appropriate unit conversions to these.

  Index into string table

Used in: Location

• uint64 function_id = 1

  The id of the corresponding profile.Function for this line.

• int64 line = 2

  Line number in source code.

Describes function and line table debug information.

Used in: Profile

• uint64 id = 1

  Unique nonzero id for the location. A profile could use instruction addresses or any integer sequence as ids.

• uint64 mapping_id = 2

  The id of the corresponding profile.Mapping for this location. It can be unset if the mapping is unknown or not applicable for this profile type.

• uint64 address = 3

  The instruction address for this location, if available. It should be within [Mapping.memory_start...Mapping.memory_limit] for the corresponding mapping. A non-leaf address may be in the middle of a call instruction. It is up to display tools to find the beginning of the instruction if necessary.

• repeated Line line = 4

  Multiple line indicates this location has inlined functions, where the last entry represents the caller into which the preceding entries were inlined. E.g., if memcpy() is inlined into printf: line[0].function_name == "memcpy" line[1].function_name == "printf"

• bool is_folded = 5

  Provides an indication that multiple symbols map to this location's address, for example due to identical code folding by the linker. In that case the line information above represents one of the multiple symbols. This field must be recomputed when the symbolization state of the profile changes.

Used in: Profile

• uint64 id = 1

  Unique nonzero id for the mapping.

• uint64 memory_start = 2

  Address at which the binary (or DLL) is loaded into memory.

• uint64 memory_limit = 3

  The limit of the address range occupied by this mapping.

• uint64 file_offset = 4

  Offset in the binary that corresponds to the first mapped address.

• int64 filename = 5

  The object this entry is loaded from. This can be a filename on disk for the main binary and shared libraries, or virtual abstractions like "[vdso]".

  Index into string table

• int64 build_id = 6

  A string that uniquely identifies a particular program version with high probability. E.g., for binaries generated by GNU tools, it could be the contents of the .note.gnu.build-id field.

  Index into string table

• bool has_functions = 7

  The following fields indicate the resolution of symbolic info.

• bool has_filenames = 8

• bool has_line_numbers = 9

• bool has_inline_frames = 10

• repeated ValueType sample_type = 1

  A description of the samples associated with each Sample.value. For a cpu profile this might be: [["cpu","nanoseconds"]] or [["wall","seconds"]] or [["syscall","count"]] For a heap profile, this might be: [["allocations","count"], ["space","bytes"]], If one of the values represents the number of events represented by the sample, by convention it should be at index 0 and use sample_type.unit == "count".

• repeated Sample sample = 2

  The set of samples recorded in this profile.

• repeated Mapping mapping = 3

  Mapping from address ranges to the image/binary/library mapped into that address range. mapping[0] will be the main binary.

• repeated Location location = 4

  Locations referenced by samples.

• repeated Function function = 5

  Functions referenced by locations.

• repeated string string_table = 6

  A common table for strings referenced by various messages. string_table[0] must always be "".

• int64 drop_frames = 7

  frames with Function.function_name fully matching the following regexp will be dropped from the samples, along with their successors.

  Index into string table.

• int64 keep_frames = 8

  frames with Function.function_name fully matching the following regexp will be kept, even if it matches drop_frames.

  Index into string table.

• int64 time_nanos = 9

  Time of collection (UTC) represented as nanoseconds past the epoch.

• int64 duration_nanos = 10

  Duration of the profile, if a duration makes sense.

• optional ValueType period_type = 11

  The kind of events between sampled occurrences. e.g [ "cpu","cycles" ] or [ "heap","bytes" ]

• int64 period = 12

  The number of events between sampled occurrences.

• repeated int64 comment = 13

  Free-form text associated with the profile. The text is displayed as is to the user by the tools that read profiles (e.g. by pprof). This field should not be used to store any machine-readable information, it is only for human-friendly content. The profile must stay functional if this field is cleaned.

  Indices into string table.

• int64 default_sample_type = 14

  Index into the string table of the type of the preferred sample value. If unset, clients should default to the last sample value.

Each Sample records values encountered in some program context. The program context is typically a stack trace, perhaps augmented with auxiliary information like the thread-id, some indicator of a higher level request being handled etc.

Used in: Profile

• repeated uint64 location_id = 1

  The ids recorded here correspond to a Profile.location.id. The leaf is at location_id[0].

• repeated int64 value = 2

  The type and unit of each value is defined by the corresponding entry in Profile.sample_type. All samples must have the same number of values, the same as the length of Profile.sample_type. When aggregating multiple samples into a single sample, the result has a list of values that is the element-wise sum of the lists of the originals.

• repeated Label label = 3

  label includes additional context for this sample. It can include things like a thread id, allocation size, etc. NOTE: While possible, having multiple values for the same label key is strongly discouraged and should never be used. Most tools (e.g. pprof) do not have good (or any) support for multi-value labels. And an even more discouraged case is having a string label and a numeric label of the same name on a sample. Again, possible to express, but should not be used.

ValueType describes the semantics and measurement units of a value.

Used in: Profile

• int64 type = 1

  Index into string table.

• int64 unit = 2

  Index into string table.