Package google.devtools.cloudprofiler.v2

Index

ExportService

Service allows existing Cloud Profiler customers to export their profile data out of Google Cloud.

ListProfiles

rpc ListProfiles(ListProfilesRequest) returns (ListProfilesResponse)

Lists profiles which have been collected so far and for which the caller has permission to view.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.write
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ProfilerService

Manage the collection of continuous profiling data provided by profiling agents running in the cloud or by an offline provider of profiling data.

The APIs listed in this service are intended for use within our profiler agents only.

CreateOfflineProfile

rpc CreateOfflineProfile(CreateOfflineProfileRequest) returns (Profile)

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.

Direct use of this API is discouraged, please use a supported profiler agent instead for profile collection.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.write
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
CreateProfile

rpc CreateProfile(CreateProfileRequest) returns (Profile)

CreateProfile creates a new profile resource in the online mode.

Direct use of this API is discouraged, please use a supported profiler agent instead for profile collection.

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".

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.write
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
UpdateProfile

rpc UpdateProfile(UpdateProfileRequest) returns (Profile)

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.

Direct use of this API is discouraged, please use a supported profiler agent instead for profile collection.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.write
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CreateOfflineProfileRequest

CreateOfflineProfileRequest describes a profile resource offline creation request.

Fields
parent

string

Parent project to create the profile in.

Authorization requires the following IAM permission on the specified resource parent:

  • cloudprofiler.profiles.create
profile

Profile

Contents of the profile to create.

CreateProfileRequest

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.

Fields
parent

string

Parent project to create the profile in.

Authorization requires the following IAM permission on the specified resource parent:

  • cloudprofiler.profiles.create
deployment

Deployment

Deployment details.

Authorization requires the following IAM permission on the specified resource deployment:

  • cloudprofiler.profiles.create
profile_type[]

ProfileType

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

Deployment

Deployment contains the deployment identification information.

Fields
project_id

string

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

string

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

map<string, string>

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".

ListProfilesRequest

ListProfilesRequest contains request parameters for listing profiles for deployments in projects which the user has permissions to view.

Fields
parent

string

Required. The parent, which owns this collection of profiles. Format: projects/{user_project_id}

Authorization requires the following IAM permission on the specified resource parent:

  • cloudprofiler.profiles.list
page_size

int32

Optional. The maximum number of items to return. Default page_size is 1000. Max limit is 1000.
page_token

string

Optional. The token to continue pagination and get profiles from a particular page. When paginating, all other parameters provided to ListProfiles must match the call that provided the page token.

ListProfilesResponse

ListProfileResponse contains the list of collected profiles for deployments in projects which the user has permissions to view.

Fields
profiles[]

Profile

List of profiles fetched.
next_page_token

string

Token to receive the next page of results. This field maybe empty if there are no more profiles to fetch.
skipped_profiles

int32

Number of profiles that were skipped in the current page since they were not able to be fetched successfully. This should typically be zero. A non-zero value may indicate a transient failure, in which case if the number is too high for your use case, the call may be retried.

Profile

Profile resource.

Fields
name

string

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

ProfileType

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.
deployment

Deployment

Deployment this profile corresponds to.
duration

Duration

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).
profile_bytes

bytes

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

map<string, string>

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.
start_time

Timestamp

Output only. Start time for the profile. This output is only present in response from the ListProfiles method.

ProfileType

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.

Enums
PROFILE_TYPE_UNSPECIFIED Unspecified profile type.
CPU Thread CPU time sampling.
WALL Wallclock time sampling. More expensive as stops all threads.
HEAP In-use heap profile. Represents a snapshot of the allocations that are live at the time of the profiling.
THREADS Single-shot collection of all thread stacks.
CONTENTION Synchronization contention profile.
PEAK_HEAP Peak heap profile.
HEAP_ALLOC 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.

UpdateProfileRequest

UpdateProfileRequest contains the profile to update.

Fields
profile

Profile

Profile to update.

Authorization requires the following IAM permission on the specified resource profile:

  • cloudprofiler.profiles.update
update_mask

FieldMask

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.