Documentation
¶
Index ¶
- Variables
- type CreateProfileRequest
- func (*CreateProfileRequest) Descriptor() ([]byte, []int)
- func (m *CreateProfileRequest) GetDeployment() *Deployment
- func (m *CreateProfileRequest) GetProfile() *Profile
- func (m *CreateProfileRequest) GetProfileType() []ProfileType
- func (*CreateProfileRequest) ProtoMessage()
- func (m *CreateProfileRequest) Reset()
- func (m *CreateProfileRequest) String() string
- type Deployment
- type Profile
- func (*Profile) Descriptor() ([]byte, []int)
- func (m *Profile) GetDeployment() *Deployment
- func (m *Profile) GetDuration() *google_protobuf1.Duration
- func (m *Profile) GetLabels() map[string]string
- func (m *Profile) GetName() string
- func (m *Profile) GetProfileBytes() []byte
- func (m *Profile) GetProfileType() ProfileType
- func (*Profile) ProtoMessage()
- func (m *Profile) Reset()
- func (m *Profile) String() string
- type ProfileType
- type UpdateProfileRequest
Constants ¶
This section is empty.
Variables ¶
Functions ¶
This section is empty.
Types ¶
type CreateProfileRequest ¶
type CreateProfileRequest struct { // Deployment details. Deployment *Deployment `protobuf:"bytes,1,opt,name=deployment" json:"deployment,omitempty"` // Online mode: One or more profile types that the agent is capable of // providing. ProfileType []ProfileType `` /* 145-byte string literal not displayed */ // Offline mode: Contents of the profile to create. Profile *Profile `protobuf:"bytes,3,opt,name=profile" json:"profile,omitempty"` }
CreateProfileRequest describes a profile resource creation request. Deployment field must be populated for both online and offline modes. For the online mode, profile field is not set and 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. For offline mode, profile field must be set, profile_type must be empty, and deployment field must be identical to the deployment in the profile.
func (*CreateProfileRequest) Descriptor ¶
func (*CreateProfileRequest) Descriptor() ([]byte, []int)
func (*CreateProfileRequest) GetDeployment ¶
func (m *CreateProfileRequest) GetDeployment() *Deployment
func (*CreateProfileRequest) GetProfile ¶
func (m *CreateProfileRequest) GetProfile() *Profile
func (*CreateProfileRequest) GetProfileType ¶
func (m *CreateProfileRequest) GetProfileType() []ProfileType
func (*CreateProfileRequest) ProtoMessage ¶
func (*CreateProfileRequest) ProtoMessage()
func (*CreateProfileRequest) Reset ¶
func (m *CreateProfileRequest) Reset()
func (*CreateProfileRequest) String ¶
func (m *CreateProfileRequest) String() string
type Deployment ¶
type Deployment struct { // Project ID is the ID of a cloud project. // Validation regex: `^[a-z][-a-z0-9:.]{4,61}[a-z0-9]$`. ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"` // 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])?$`. Target string `protobuf:"bytes,2,opt,name=target,proto3" json:"target,omitempty"` // 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". Labels map[string]string `` /* 146-byte string literal not displayed */ }
Deployment contains the deployment identification information.
func (*Deployment) Descriptor ¶
func (*Deployment) Descriptor() ([]byte, []int)
func (*Deployment) GetLabels ¶
func (m *Deployment) GetLabels() map[string]string
func (*Deployment) GetProjectId ¶
func (m *Deployment) GetProjectId() string
func (*Deployment) GetTarget ¶
func (m *Deployment) GetTarget() string
func (*Deployment) ProtoMessage ¶
func (*Deployment) ProtoMessage()
func (*Deployment) Reset ¶
func (m *Deployment) Reset()
func (*Deployment) String ¶
func (m *Deployment) String() string
type Profile ¶
type Profile struct { // Opaque, server-assigned, unique ID for this profile. // Output only. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Type of profile. // Input (for the offline mode) or output (for the online mode). ProfileType ProfileType `` /* 145-byte string literal not displayed */ // Deployment this profile corresponds to. Deployment *Deployment `protobuf:"bytes,3,opt,name=deployment" json:"deployment,omitempty"` // 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). Duration *google_protobuf1.Duration `protobuf:"bytes,4,opt,name=duration" json:"duration,omitempty"` // Profile bytes, as a gzip compressed serialized proto, the format is // https://github.com/google/pprof/blob/master/proto/profile.proto. ProfileBytes []byte `protobuf:"bytes,5,opt,name=profile_bytes,json=profileBytes,proto3" json:"profile_bytes,omitempty"` // 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. // Input only, will not be populated on responses. Labels map[string]string `` /* 146-byte string literal not displayed */ }
Profile resource.
func (*Profile) GetDeployment ¶
func (m *Profile) GetDeployment() *Deployment
func (*Profile) GetDuration ¶
func (m *Profile) GetDuration() *google_protobuf1.Duration
func (*Profile) GetProfileType ¶
func (m *Profile) GetProfileType() ProfileType
type ProfileType ¶
type ProfileType int32
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.
const ( // Unspecified profile type. ProfileType_PROFILE_TYPE_UNSPECIFIED ProfileType = 0 // Thread CPU time sampling. ProfileType_CPU ProfileType = 1 // Wallclock time sampling. More expensive as stops all threads. ProfileType_WALL ProfileType = 2 // Heap allocation sampling. ProfileType_HEAP ProfileType = 3 // Single-shot collection of all thread stacks. ProfileType_THREADS ProfileType = 4 // Synchronization contention profile. ProfileType_CONTENTION ProfileType = 5 )
func (ProfileType) EnumDescriptor ¶
func (ProfileType) EnumDescriptor() ([]byte, []int)
func (ProfileType) String ¶
func (x ProfileType) String() string
type UpdateProfileRequest ¶
type UpdateProfileRequest struct { // Profile to update Profile *Profile `protobuf:"bytes,1,opt,name=profile" json:"profile,omitempty"` }
UpdateProfileRequest contains the profile to update.
func (*UpdateProfileRequest) Descriptor ¶
func (*UpdateProfileRequest) Descriptor() ([]byte, []int)
func (*UpdateProfileRequest) GetProfile ¶
func (m *UpdateProfileRequest) GetProfile() *Profile
func (*UpdateProfileRequest) ProtoMessage ¶
func (*UpdateProfileRequest) ProtoMessage()
func (*UpdateProfileRequest) Reset ¶
func (m *UpdateProfileRequest) Reset()
func (*UpdateProfileRequest) String ¶
func (m *UpdateProfileRequest) String() string