package google.devtools.cloudprofiler.v2

Get desktop application:
View/edit binary Protocol Buffers messages

Manage the collection of continuous profiling data provided by profiling agents running in the cloud or by an offline provider of profiling data. General guidelines: * Profiles for a single deployment must be created in ascending time order. * Profiles can be created in either online or offline mode, see below.

• rpc CreateProfile (CreateProfileRequest, Profile)

  profiler.proto:46

  CreateProfile creates a new profile resource in the online mode. The server ensures that the new profiles are created at a constant rate per deployment, so the creation request may hang for some time until the next profile session is available. The request may fail with ABORTED error if the creation is not available within ~1m, the response will indicate the duration of the backoff the client should take before attempting creating a profile again. The backoff duration is returned in google.rpc.RetryInfo extension on the response status. To a gRPC client, the extension will be return as a binary-serialized proto in the trailing metadata item named "google.rpc.retryinfo-bin".

  message CreateProfileRequest

  profiler.proto:79

  CreateProfileRequest describes a profile resource online creation request. The deployment field must be populated. The profile_type specifies the list of profile types supported by the agent. The creation call will hang until a profile of one of these types needs to be collected.

  • string parent = 4

    Parent project to create the profile in.

  • optional Deployment deployment = 1

    Deployment details.

  • repeated ProfileType profile_type = 2

    One or more profile types that the agent is capable of providing.

• rpc CreateOfflineProfile (CreateOfflineProfileRequest, Profile)

  profiler.proto:56

  CreateOfflineProfile creates a new profile resource in the offline mode. The client provides the profile to create along with the profile bytes, the server records it.

  message CreateOfflineProfileRequest

  profiler.proto:92

  CreateOfflineProfileRequest describes a profile resource offline creation request. Profile field must be set.

  • string parent = 1

    Parent project to create the profile in.

  • optional Profile profile = 2

    Contents of the profile to create.

• rpc UpdateProfile (UpdateProfileRequest, Profile)

  profiler.proto:67

  UpdateProfile updates the profile bytes and labels on the profile resource created in the online mode. Updating the bytes for profiles created in the offline mode is currently not supported: the profile content must be provided at the time of the profile creation.

  message UpdateProfileRequest

  profiler.proto:101

  UpdateProfileRequest contains the profile to update.

  • optional Profile profile = 1

    Profile to update

  • optional protobuf.FieldMask update_mask = 2

    Field mask used to specify the fields to be overwritten. Currently only profile_bytes and labels fields are supported by UpdateProfile, so only those fields can be specified in the mask. When no mask is provided, all fields are overwritten.

Deployment contains the deployment identification information.

Used in: CreateProfileRequest, Profile

• string project_id = 1

  Project ID is the ID of a cloud project. Validation regex: `^[a-z][-a-z0-9:.]{4,61}[a-z0-9]$`.

• string target = 2

  Target is the service name used to group related deployments: * Service name for GAE Flex / Standard. * Cluster and container name for GKE. * User-specified string for direct GCE profiling (e.g. Java). * Job name for Dataflow. Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.

• map<string, string> labels = 3

  Labels identify the deployment within the user universe and same target. Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`. Value for an individual label must be <= 512 bytes, the total size of all label names and values must be <= 1024 bytes. Label named "language" can be used to record the programming language of the profiled deployment. The standard choices for the value include "java", "go", "python", "ruby", "nodejs", "php", "dotnet". For deployments running on Google Cloud Platform, "zone" or "region" label should be present describing the deployment location. An example of a zone is "us-central1-a", an example of a region is "us-central1" or "us-central".

Profile resource.

Used as response type in: ProfilerService.CreateOfflineProfile, ProfilerService.CreateProfile, ProfilerService.UpdateProfile

Used as field type in: CreateOfflineProfileRequest, UpdateProfileRequest

• string name = 1

  Output only. Opaque, server-assigned, unique ID for this profile.

• ProfileType profile_type = 2

  Type of profile. For offline mode, this must be specified when creating the profile. For online mode it is assigned and returned by the server.

• optional Deployment deployment = 3

  Deployment this profile corresponds to.

• optional protobuf.Duration duration = 4

  Duration of the profiling session. Input (for the offline mode) or output (for the online mode). The field represents requested profiling duration. It may slightly differ from the effective profiling duration, which is recorded in the profile data, in case the profiling can't be stopped immediately (e.g. in case stopping the profiling is handled asynchronously).

• bytes profile_bytes = 5

  Input only. Profile bytes, as a gzip compressed serialized proto, the format is https://github.com/google/pprof/blob/master/proto/profile.proto.

• map<string, string> labels = 6

  Input only. Labels associated to this specific profile. These labels will get merged with the deployment labels for the final data set. See documentation on deployment labels for validation rules and limits.

ProfileType is type of profiling data. NOTE: the enumeration member names are used (in lowercase) as unique string identifiers of profile types, so they must not be renamed.

Used in: CreateProfileRequest, Profile

• PROFILE_TYPE_UNSPECIFIED = 0

  Unspecified profile type.

• CPU = 1

  Thread CPU time sampling.

• WALL = 2

  Wallclock time sampling. More expensive as stops all threads.

• HEAP = 3

  In-use heap profile. Represents a snapshot of the allocations that are live at the time of the profiling.

• THREADS = 4

  Single-shot collection of all thread stacks.

• CONTENTION = 5

  Synchronization contention profile.

• PEAK_HEAP = 6

  Peak heap profile.

• HEAP_ALLOC = 7

  Heap allocation profile. It represents the aggregation of all allocations made over the duration of the profile. All allocations are included, including those that might have been freed by the end of the profiling interval. The profile is in particular useful for garbage collecting languages to understand which parts of the code create most of the garbage collection pressure to see if those can be optimized.