package cloudprofiler

Import Path
	google.golang.org/genproto/googleapis/devtools/cloudprofiler/v2 (on go.dev)

Dependency Relation
	imports 13 packages, and imported by one package

Involved Source Files profiler.pb.go
Package-Level Type Names (total 10, in which 9 are exported)
/* sort exporteds by: | */
CreateOfflineProfileRequest describes a profile resource offline creation request. Profile field must be set. Parent project to create the profile in. Contents of the profile to create. Deprecated: Use CreateOfflineProfileRequest.ProtoReflect.Descriptor instead. (*T) GetParent() string (*T) GetProfile() *Profile (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func ProfilerServiceClient.CreateOfflineProfile(ctx context.Context, in *CreateOfflineProfileRequest, opts ...grpc.CallOption) (*Profile, error) func ProfilerServiceServer.CreateOfflineProfile(context.Context, *CreateOfflineProfileRequest) (*Profile, error) func (*UnimplementedProfilerServiceServer).CreateOfflineProfile(context.Context, *CreateOfflineProfileRequest) (*Profile, error)
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. Deployment details. Parent project to create the profile in. One or more profile types that the agent is capable of providing. Deprecated: Use CreateProfileRequest.ProtoReflect.Descriptor instead. (*T) GetDeployment() *Deployment (*T) GetParent() string (*T) GetProfileType() []ProfileType (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func ProfilerServiceClient.CreateProfile(ctx context.Context, in *CreateProfileRequest, opts ...grpc.CallOption) (*Profile, error) func ProfilerServiceServer.CreateProfile(context.Context, *CreateProfileRequest) (*Profile, error) func (*UnimplementedProfilerServiceServer).CreateProfile(context.Context, *CreateProfileRequest) (*Profile, error)
Deployment contains the deployment identification information. 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". Project ID is the ID of a cloud project. Validation regex: `^[a-z][-a-z0-9:.]{4,61}[a-z0-9]$`. 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])?$`. Deprecated: Use Deployment.ProtoReflect.Descriptor instead. (*T) GetLabels() map[string]string (*T) GetProjectId() string (*T) GetTarget() string (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func (*CreateProfileRequest).GetDeployment() *Deployment func (*Profile).GetDeployment() *Deployment
Profile resource. Deployment this profile corresponds to. 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). 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. Output only. Opaque, server-assigned, unique ID for this profile. Input only. Profile bytes, as a gzip compressed serialized proto, the format is https://github.com/google/pprof/blob/master/proto/profile.proto. 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. Deprecated: Use Profile.ProtoReflect.Descriptor instead. (*T) GetDeployment() *Deployment (*T) GetDuration() *durationpb.Duration (*T) GetLabels() map[string]string (*T) GetName() string (*T) GetProfileBytes() []byte (*T) GetProfileType() ProfileType (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func (*CreateOfflineProfileRequest).GetProfile() *Profile func ProfilerServiceClient.CreateOfflineProfile(ctx context.Context, in *CreateOfflineProfileRequest, opts ...grpc.CallOption) (*Profile, error) func ProfilerServiceClient.CreateProfile(ctx context.Context, in *CreateProfileRequest, opts ...grpc.CallOption) (*Profile, error) func ProfilerServiceClient.UpdateProfile(ctx context.Context, in *UpdateProfileRequest, opts ...grpc.CallOption) (*Profile, error) func ProfilerServiceServer.CreateOfflineProfile(context.Context, *CreateOfflineProfileRequest) (*Profile, error) func ProfilerServiceServer.CreateProfile(context.Context, *CreateProfileRequest) (*Profile, error) func ProfilerServiceServer.UpdateProfile(context.Context, *UpdateProfileRequest) (*Profile, error) func (*UnimplementedProfilerServiceServer).CreateOfflineProfile(context.Context, *CreateOfflineProfileRequest) (*Profile, error) func (*UnimplementedProfilerServiceServer).CreateProfile(context.Context, *CreateProfileRequest) (*Profile, error) func (*UnimplementedProfilerServiceServer).UpdateProfile(context.Context, *UpdateProfileRequest) (*Profile, error) func (*UpdateProfileRequest).GetProfile() *Profile
ProfilerServiceClient is the client API for ProfilerService service. For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream. 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. 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". 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. func NewProfilerServiceClient(cc grpc.ClientConnInterface) ProfilerServiceClient
ProfilerServiceServer is the server API for ProfilerService service. 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. 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". 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. *UnimplementedProfilerServiceServer func RegisterProfilerServiceServer(s *grpc.Server, srv ProfilerServiceServer)
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. ( T) Descriptor() protoreflect.EnumDescriptor ( T) Enum() *ProfileType Deprecated: Use ProfileType.Descriptor instead. ( T) Number() protoreflect.EnumNumber ( T) String() string ( T) Type() protoreflect.EnumType T : google.golang.org/protobuf/reflect/protoreflect.Enum T : expvar.Var T : fmt.Stringer func (*CreateProfileRequest).GetProfileType() []ProfileType func (*Profile).GetProfileType() ProfileType func ProfileType.Enum() *ProfileType const ProfileType_CONTENTION const ProfileType_CPU const ProfileType_HEAP const ProfileType_HEAP_ALLOC const ProfileType_PEAK_HEAP const ProfileType_PROFILE_TYPE_UNSPECIFIED const ProfileType_THREADS const ProfileType_WALL
UnimplementedProfilerServiceServer can be embedded to have forward compatible implementations. (*T) CreateOfflineProfile(context.Context, *CreateOfflineProfileRequest) (*Profile, error) (*T) CreateProfile(context.Context, *CreateProfileRequest) (*Profile, error) (*T) UpdateProfile(context.Context, *UpdateProfileRequest) (*Profile, error) *T : ProfilerServiceServer
UpdateProfileRequest contains the profile to update. Profile to update 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. Deprecated: Use UpdateProfileRequest.ProtoReflect.Descriptor instead. (*T) GetProfile() *Profile (*T) GetUpdateMask() *fieldmaskpb.FieldMask (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func ProfilerServiceClient.UpdateProfile(ctx context.Context, in *UpdateProfileRequest, opts ...grpc.CallOption) (*Profile, error) func ProfilerServiceServer.UpdateProfile(context.Context, *UpdateProfileRequest) (*Profile, error) func (*UnimplementedProfilerServiceServer).UpdateProfile(context.Context, *UpdateProfileRequest) (*Profile, error)
Package-Level Functions (total 8, in which 2 are exported)
Package-Level Constants (total 8, all are exported)
Synchronization contention profile.
Thread CPU time sampling.
In-use heap profile. Represents a snapshot of the allocations that are live at the time of the profiling.
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.
Peak heap profile.
Single-shot collection of all thread stacks.
Wallclock time sampling. More expensive as stops all threads.