Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Manages continuous profiling information.
Synopsis
- cloudProfilerService :: ServiceConfig
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- monitoringScope :: Proxy '["https://www.googleapis.com/auth/monitoring"]
- monitoringWriteScope :: Proxy '["https://www.googleapis.com/auth/monitoring.write"]
- type CloudProfilerAPI = ProjectsProFilesPatchResource :<|> (ProjectsProFilesCreateResource :<|> ProjectsProFilesCreateOfflineResource)
- module Network.Google.Resource.CloudProFiler.Projects.ProFiles.Create
- module Network.Google.Resource.CloudProFiler.Projects.ProFiles.CreateOffline
- module Network.Google.Resource.CloudProFiler.Projects.ProFiles.Patch
- data DeploymentLabels
- deploymentLabels :: HashMap Text Text -> DeploymentLabels
- dlAddtional :: Lens' DeploymentLabels (HashMap Text Text)
- data ProFileProFileType
- data ProFile
- proFile :: ProFile
- pfProFileBytes :: Lens' ProFile (Maybe ByteString)
- pfName :: Lens' ProFile (Maybe Text)
- pfLabels :: Lens' ProFile (Maybe ProFileLabels)
- pfProFileType :: Lens' ProFile (Maybe ProFileProFileType)
- pfDuration :: Lens' ProFile (Maybe Scientific)
- pfDeployment :: Lens' ProFile (Maybe Deployment)
- data CreateProFileRequest
- createProFileRequest :: CreateProFileRequest
- cpfrProFileType :: Lens' CreateProFileRequest [Text]
- cpfrDeployment :: Lens' CreateProFileRequest (Maybe Deployment)
- data ProFileLabels
- proFileLabels :: HashMap Text Text -> ProFileLabels
- pflAddtional :: Lens' ProFileLabels (HashMap Text Text)
- data Xgafv
- data Deployment
- deployment :: Deployment
- dLabels :: Lens' Deployment (Maybe DeploymentLabels)
- dProjectId :: Lens' Deployment (Maybe Text)
- dTarget :: Lens' Deployment (Maybe Text)
Service Configuration
cloudProfilerService :: ServiceConfig Source #
Default request referring to version v2
of the Stackdriver Profiler API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
monitoringScope :: Proxy '["https://www.googleapis.com/auth/monitoring"] Source #
View and write monitoring data for all of your Google and third-party Cloud and API projects
monitoringWriteScope :: Proxy '["https://www.googleapis.com/auth/monitoring.write"] Source #
Publish metric data to your Google Cloud projects
API Declaration
type CloudProfilerAPI = ProjectsProFilesPatchResource :<|> (ProjectsProFilesCreateResource :<|> ProjectsProFilesCreateOfflineResource) Source #
Represents the entirety of the methods and resources available for the Stackdriver Profiler API service.
Resources
cloudprofiler.projects.profiles.create
cloudprofiler.projects.profiles.createOffline
cloudprofiler.projects.profiles.patch
Types
DeploymentLabels
data DeploymentLabels Source #
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".
See: deploymentLabels
smart constructor.
Instances
Creates a value of DeploymentLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ProFileProFileType
data ProFileProFileType Source #
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.
ProFileTypeUnspecified |
|
CPU |
|
Wall |
|
Heap |
|
Threads |
|
Contention |
|
PeakHeap |
|
HeapAlloc |
|
Instances
ProFile
Profile resource.
See: proFile
smart constructor.
Instances
Creates a value of ProFile
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pfProFileBytes :: Lens' ProFile (Maybe ByteString) Source #
Input only. Profile bytes, as a gzip compressed serialized proto, the format is https://github.com/google/pprof/blob/master/proto/profile.proto.
pfName :: Lens' ProFile (Maybe Text) Source #
Output only. Opaque, server-assigned, unique ID for this profile.
pfLabels :: Lens' ProFile (Maybe ProFileLabels) Source #
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.
pfProFileType :: Lens' ProFile (Maybe ProFileProFileType) Source #
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.
pfDuration :: Lens' ProFile (Maybe Scientific) Source #
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).
pfDeployment :: Lens' ProFile (Maybe Deployment) Source #
Deployment this profile corresponds to.
CreateProFileRequest
data CreateProFileRequest Source #
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.
See: createProFileRequest
smart constructor.
Instances
createProFileRequest :: CreateProFileRequest Source #
Creates a value of CreateProFileRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cpfrProFileType :: Lens' CreateProFileRequest [Text] Source #
One or more profile types that the agent is capable of providing.
cpfrDeployment :: Lens' CreateProFileRequest (Maybe Deployment) Source #
Deployment details.
ProFileLabels
data ProFileLabels Source #
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.
See: proFileLabels
smart constructor.
Instances
Creates a value of ProFileLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Xgafv
V1 error format.
Instances
Deployment
data Deployment Source #
Deployment contains the deployment identification information.
See: deployment
smart constructor.
Instances
deployment :: Deployment Source #
Creates a value of Deployment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dLabels :: Lens' Deployment (Maybe DeploymentLabels) Source #
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".
dProjectId :: Lens' Deployment (Maybe Text) Source #
Project ID is the ID of a cloud project. Validation regex: `^a-z{4,61}[a-z0-9]$`.
dTarget :: Lens' Deployment (Maybe Text) Source #
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])?$`.