Documentation
¶
Overview ¶
Package cloudprofiler provides access to the Cloud Profiler API.
For product documentation, see: https://cloud.google.com/profiler/
Library status ¶
These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.
When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.
Creating a client ¶
Usage example:
import "google.golang.org/api/cloudprofiler/v2" ... ctx := context.Background() cloudprofilerService, err := cloudprofiler.NewService(ctx)
In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options ¶
By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.golang.org/api/option.WithScopes:
cloudprofilerService, err := cloudprofiler.NewService(ctx, option.WithScopes(cloudprofiler.MonitoringWriteScope))
To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:
cloudprofilerService, err := cloudprofiler.NewService(ctx, option.WithAPIKey("AIza..."))
To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:
config := &oauth2.Config{...} // ... token, err := config.Exchange(ctx, ...) cloudprofilerService, err := cloudprofiler.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See google.golang.org/api/option.ClientOption for details on options.
Index ¶
- Constants
- type CreateProfileRequest
- type Deployment
- type Profile
- type ProjectsProfilesCreateCall
- func (c *ProjectsProfilesCreateCall) Context(ctx context.Context) *ProjectsProfilesCreateCall
- func (c *ProjectsProfilesCreateCall) Do(opts ...googleapi.CallOption) (*Profile, error)
- func (c *ProjectsProfilesCreateCall) Fields(s ...googleapi.Field) *ProjectsProfilesCreateCall
- func (c *ProjectsProfilesCreateCall) Header() http.Header
- type ProjectsProfilesCreateOfflineCall
- func (c *ProjectsProfilesCreateOfflineCall) Context(ctx context.Context) *ProjectsProfilesCreateOfflineCall
- func (c *ProjectsProfilesCreateOfflineCall) Do(opts ...googleapi.CallOption) (*Profile, error)
- func (c *ProjectsProfilesCreateOfflineCall) Fields(s ...googleapi.Field) *ProjectsProfilesCreateOfflineCall
- func (c *ProjectsProfilesCreateOfflineCall) Header() http.Header
- type ProjectsProfilesPatchCall
- func (c *ProjectsProfilesPatchCall) Context(ctx context.Context) *ProjectsProfilesPatchCall
- func (c *ProjectsProfilesPatchCall) Do(opts ...googleapi.CallOption) (*Profile, error)
- func (c *ProjectsProfilesPatchCall) Fields(s ...googleapi.Field) *ProjectsProfilesPatchCall
- func (c *ProjectsProfilesPatchCall) Header() http.Header
- func (c *ProjectsProfilesPatchCall) UpdateMask(updateMask string) *ProjectsProfilesPatchCall
- type ProjectsProfilesService
- func (r *ProjectsProfilesService) Create(parent string, createprofilerequest *CreateProfileRequest) *ProjectsProfilesCreateCall
- func (r *ProjectsProfilesService) CreateOffline(parent string, profile *Profile) *ProjectsProfilesCreateOfflineCall
- func (r *ProjectsProfilesService) Patch(name string, profile *Profile) *ProjectsProfilesPatchCall
- type ProjectsService
- type Service
Constants ¶
const ( // See, edit, configure, and delete your Google Cloud data and see the // email address for your Google Account. CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" // View and write monitoring data for all of your Google and third-party // Cloud and API projects MonitoringScope = "https://www.googleapis.com/auth/monitoring" // Publish metric data to your Google Cloud projects MonitoringWriteScope = "https://www.googleapis.com/auth/monitoring.write" )
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateProfileRequest ¶
type CreateProfileRequest struct { // Deployment: Deployment details. Deployment *Deployment `json:"deployment,omitempty"` // ProfileType: One or more profile types that the agent is capable of // providing. // // Possible values: // "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. ProfileType []string `json:"profileType,omitempty"` // ForceSendFields is a list of field names (e.g. "Deployment") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Deployment") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
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.
func (*CreateProfileRequest) MarshalJSON ¶
func (s *CreateProfileRequest) MarshalJSON() ([]byte, error)
type Deployment ¶
type Deployment struct { // Labels: 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 `json:"labels,omitempty"` // ProjectId: Project ID is the ID of a cloud project. Validation regex: // `^a-z{4,61}[a-z0-9]$`. ProjectId string `json:"projectId,omitempty"` // Target: 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])?$`. Target string `json:"target,omitempty"` // ForceSendFields is a list of field names (e.g. "Labels") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Labels") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Deployment: Deployment contains the deployment identification information.
func (*Deployment) MarshalJSON ¶
func (s *Deployment) MarshalJSON() ([]byte, error)
type Profile ¶
type Profile struct { // Deployment: Deployment this profile corresponds to. Deployment *Deployment `json:"deployment,omitempty"` // 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). Duration string `json:"duration,omitempty"` // Labels: 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. Labels map[string]string `json:"labels,omitempty"` // Name: Output only. Opaque, server-assigned, unique ID for this // profile. Name string `json:"name,omitempty"` // ProfileBytes: Input only. Profile bytes, as a gzip compressed // serialized proto, the format is // https://github.com/google/pprof/blob/master/proto/profile.proto. ProfileBytes string `json:"profileBytes,omitempty"` // 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. // // Possible values: // "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. ProfileType string `json:"profileType,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Deployment") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Deployment") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Profile: Profile resource.
func (*Profile) MarshalJSON ¶
type ProjectsProfilesCreateCall ¶
type ProjectsProfilesCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsProfilesCreateCall) Context ¶
func (c *ProjectsProfilesCreateCall) Context(ctx context.Context) *ProjectsProfilesCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsProfilesCreateCall) Do ¶
func (c *ProjectsProfilesCreateCall) Do(opts ...googleapi.CallOption) (*Profile, error)
Do executes the "cloudprofiler.projects.profiles.create" call. Exactly one of *Profile or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Profile.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsProfilesCreateCall) Fields ¶
func (c *ProjectsProfilesCreateCall) Fields(s ...googleapi.Field) *ProjectsProfilesCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsProfilesCreateCall) Header ¶
func (c *ProjectsProfilesCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsProfilesCreateOfflineCall ¶
type ProjectsProfilesCreateOfflineCall struct {
// contains filtered or unexported fields
}
func (*ProjectsProfilesCreateOfflineCall) Context ¶
func (c *ProjectsProfilesCreateOfflineCall) Context(ctx context.Context) *ProjectsProfilesCreateOfflineCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsProfilesCreateOfflineCall) Do ¶
func (c *ProjectsProfilesCreateOfflineCall) Do(opts ...googleapi.CallOption) (*Profile, error)
Do executes the "cloudprofiler.projects.profiles.createOffline" call. Exactly one of *Profile or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Profile.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsProfilesCreateOfflineCall) Fields ¶
func (c *ProjectsProfilesCreateOfflineCall) Fields(s ...googleapi.Field) *ProjectsProfilesCreateOfflineCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsProfilesCreateOfflineCall) Header ¶
func (c *ProjectsProfilesCreateOfflineCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsProfilesPatchCall ¶
type ProjectsProfilesPatchCall struct {
// contains filtered or unexported fields
}
func (*ProjectsProfilesPatchCall) Context ¶
func (c *ProjectsProfilesPatchCall) Context(ctx context.Context) *ProjectsProfilesPatchCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsProfilesPatchCall) Do ¶
func (c *ProjectsProfilesPatchCall) Do(opts ...googleapi.CallOption) (*Profile, error)
Do executes the "cloudprofiler.projects.profiles.patch" call. Exactly one of *Profile or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Profile.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsProfilesPatchCall) Fields ¶
func (c *ProjectsProfilesPatchCall) Fields(s ...googleapi.Field) *ProjectsProfilesPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsProfilesPatchCall) Header ¶
func (c *ProjectsProfilesPatchCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsProfilesPatchCall) UpdateMask ¶
func (c *ProjectsProfilesPatchCall) UpdateMask(updateMask string) *ProjectsProfilesPatchCall
UpdateMask sets the optional parameter "updateMask": 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.
type ProjectsProfilesService ¶
type ProjectsProfilesService struct {
// contains filtered or unexported fields
}
func NewProjectsProfilesService ¶
func NewProjectsProfilesService(s *Service) *ProjectsProfilesService
func (*ProjectsProfilesService) Create ¶
func (r *ProjectsProfilesService) Create(parent string, createprofilerequest *CreateProfileRequest) *ProjectsProfilesCreateCall
Create: 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".
- parent: Parent project to create the profile in.
func (*ProjectsProfilesService) CreateOffline ¶
func (r *ProjectsProfilesService) CreateOffline(parent string, profile *Profile) *ProjectsProfilesCreateOfflineCall
CreateOffline: 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.
- parent: Parent project to create the profile in.
func (*ProjectsProfilesService) Patch ¶
func (r *ProjectsProfilesService) Patch(name string, profile *Profile) *ProjectsProfilesPatchCall
Patch: 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.
- name: Output only. Opaque, server-assigned, unique ID for this profile.
type ProjectsService ¶
type ProjectsService struct { Profiles *ProjectsProfilesService // contains filtered or unexported fields }
func NewProjectsService ¶
func NewProjectsService(s *Service) *ProjectsService
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Projects *ProjectsService // contains filtered or unexported fields }
func New
deprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService ¶ added in v0.3.0
NewService creates a new Service.