1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="cloudprofiler_v2.html">Stackdriver Profiler API</a> . <a href="cloudprofiler_v2.projects.html">projects</a> . <a href="cloudprofiler_v2.projects.profiles.html">profiles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
<p class="firstline">CreateProfile creates a new profile resource in the online mode.</p>
<p class="toc_element">
<code><a href="#createOffline">createOffline(parent, body, x__xgafv=None)</a></code></p>
<p class="firstline">CreateOfflineProfile creates a new profile resource in the offline mode.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">UpdateProfile updates the profile bytes and labels on the profile resource</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent, body, x__xgafv=None)</code>
<pre>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".
Args:
parent: string, Parent project to create the profile in. (required)
body: object, The request body. (required)
The object takes the form of:
{ # 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.
"profileType": [ # One or more profile types that the agent is capable of providing.
"A String",
],
"deployment": { # Deployment contains the deployment identification information. # Deployment details.
"projectId": "A String", # Project ID is the ID of a cloud project.
# Validation regex: `^a-z{4,61}[a-z0-9]$`.
"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".
"a_key": "A String",
},
"target": "A String", # 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])?$`.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Profile resource.
"name": "A String", # Output only. Opaque, server-assigned, unique ID for this profile.
"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.
"a_key": "A String",
},
"profileBytes": "A String", # Input only. Profile bytes, as a gzip compressed serialized proto, the
# format is https://github.com/google/pprof/blob/master/proto/profile.proto.
"profileType": "A String", # 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 contains the deployment identification information. # Deployment this profile corresponds to.
"projectId": "A String", # Project ID is the ID of a cloud project.
# Validation regex: `^a-z{4,61}[a-z0-9]$`.
"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".
"a_key": "A String",
},
"target": "A String", # 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])?$`.
},
"duration": "A String", # 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).
}</pre>
</div>
<div class="method">
<code class="details" id="createOffline">createOffline(parent, body, x__xgafv=None)</code>
<pre>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.
Args:
parent: string, Parent project to create the profile in. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Profile resource.
"name": "A String", # Output only. Opaque, server-assigned, unique ID for this profile.
"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.
"a_key": "A String",
},
"profileBytes": "A String", # Input only. Profile bytes, as a gzip compressed serialized proto, the
# format is https://github.com/google/pprof/blob/master/proto/profile.proto.
"profileType": "A String", # 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 contains the deployment identification information. # Deployment this profile corresponds to.
"projectId": "A String", # Project ID is the ID of a cloud project.
# Validation regex: `^a-z{4,61}[a-z0-9]$`.
"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".
"a_key": "A String",
},
"target": "A String", # 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])?$`.
},
"duration": "A String", # 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).
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Profile resource.
"name": "A String", # Output only. Opaque, server-assigned, unique ID for this profile.
"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.
"a_key": "A String",
},
"profileBytes": "A String", # Input only. Profile bytes, as a gzip compressed serialized proto, the
# format is https://github.com/google/pprof/blob/master/proto/profile.proto.
"profileType": "A String", # 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 contains the deployment identification information. # Deployment this profile corresponds to.
"projectId": "A String", # Project ID is the ID of a cloud project.
# Validation regex: `^a-z{4,61}[a-z0-9]$`.
"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".
"a_key": "A String",
},
"target": "A String", # 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])?$`.
},
"duration": "A String", # 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).
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
<pre>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.
Args:
name: string, Output only. Opaque, server-assigned, unique ID for this profile. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Profile resource.
"name": "A String", # Output only. Opaque, server-assigned, unique ID for this profile.
"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.
"a_key": "A String",
},
"profileBytes": "A String", # Input only. Profile bytes, as a gzip compressed serialized proto, the
# format is https://github.com/google/pprof/blob/master/proto/profile.proto.
"profileType": "A String", # 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 contains the deployment identification information. # Deployment this profile corresponds to.
"projectId": "A String", # Project ID is the ID of a cloud project.
# Validation regex: `^a-z{4,61}[a-z0-9]$`.
"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".
"a_key": "A String",
},
"target": "A String", # 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])?$`.
},
"duration": "A String", # 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).
}
updateMask: string, 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Profile resource.
"name": "A String", # Output only. Opaque, server-assigned, unique ID for this profile.
"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.
"a_key": "A String",
},
"profileBytes": "A String", # Input only. Profile bytes, as a gzip compressed serialized proto, the
# format is https://github.com/google/pprof/blob/master/proto/profile.proto.
"profileType": "A String", # 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 contains the deployment identification information. # Deployment this profile corresponds to.
"projectId": "A String", # Project ID is the ID of a cloud project.
# Validation regex: `^a-z{4,61}[a-z0-9]$`.
"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".
"a_key": "A String",
},
"target": "A String", # 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])?$`.
},
"duration": "A String", # 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).
}</pre>
</div>
</body></html>
|
