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
|
<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="clouderrorreporting_v1beta1.html">Stackdriver Error Reporting API</a> . <a href="clouderrorreporting_v1beta1.projects.html">projects</a> . <a href="clouderrorreporting_v1beta1.projects.events.html">events</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(projectName, pageSize=None, x__xgafv=None, serviceFilter_resourceType=None, timeRange_period=None, pageToken=None, serviceFilter_version=None, serviceFilter_service=None, groupId=None)</a></code></p>
<p class="firstline">Lists the specified events.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#report">report(projectName, body, x__xgafv=None)</a></code></p>
<p class="firstline">Report an individual error event.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(projectName, pageSize=None, x__xgafv=None, serviceFilter_resourceType=None, timeRange_period=None, pageToken=None, serviceFilter_version=None, serviceFilter_service=None, groupId=None)</code>
<pre>Lists the specified events.
Args:
projectName: string, [Required] The resource name of the Google Cloud Platform project. Written
as `projects/` plus the
[Google Cloud Platform project
ID](https://support.google.com/cloud/answer/6158840).
Example: `projects/my-project-123`. (required)
pageSize: integer, [Optional] The maximum number of results to return per response.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
serviceFilter_resourceType: string, [Optional] The exact value to match against
[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).
timeRange_period: string, Restricts the query to the specified time range.
pageToken: string, [Optional] A `next_page_token` provided by a previous response.
serviceFilter_version: string, [Optional] The exact value to match against
[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).
serviceFilter_service: string, [Optional] The exact value to match against
[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).
groupId: string, [Required] The group for which events shall be returned.
Returns:
An object of the form:
{ # Contains a set of requested error events.
"nextPageToken": "A String", # If non-empty, more results are available.
# Pass this token, along with the same query parameters as the first
# request, to view the next page of results.
"errorEvents": [ # The error events which match the given request.
{ # An error event which is returned by the Error Reporting system.
"serviceContext": { # Describes a running service that sends errors. # The `ServiceContext` for which this error was reported.
# Its version changes over time and multiple versions can run in parallel.
"resourceType": "A String", # Type of the MonitoredResource. List of possible values:
# https://cloud.google.com/monitoring/api/resources
#
# Value is set automatically for incoming errors and must not be set when
# reporting errors.
"version": "A String", # Represents the source code version that the developer provided,
# which could represent a version label or a Git SHA-1 hash, for example.
# For App Engine standard environment, the version is set to the version of
# the app.
"service": "A String", # An identifier of the service, such as the name of the
# executable, job, or Google App Engine service name. This field is expected
# to have a low number of values that are relatively stable over time, as
# opposed to `version`, which can be changed whenever new code is deployed.
#
# Contains the service name for error reports extracted from Google
# App Engine logs or `default` if the App Engine default service is used.
},
"eventTime": "A String", # Time when the event occurred as provided in the error report.
# If the report did not contain a timestamp, the time the error was received
# by the Error Reporting system is used.
"message": "A String", # The stack trace that was reported or logged by the service.
"context": { # A description of the context in which an error occurred. # Data about the context in which the error occurred.
# This data should be provided by the application when reporting an error,
# unless the
# error report has been generated automatically from Google App Engine logs.
"httpRequest": { # HTTP request data that is related to a reported error. # The HTTP request which was processed when the error was
# triggered.
# This data should be provided by the application when reporting an error,
# unless the
# error report has been generated automatically from Google App Engine logs.
"responseStatusCode": 42, # The HTTP response status code for the request.
"url": "A String", # The URL of the request.
"referrer": "A String", # The referrer information that is provided with the request.
"remoteIp": "A String", # The IP address from which the request originated.
# This can be IPv4, IPv6, or a token which is derived from the
# IP address, depending on the data that has been provided
# in the error report.
"userAgent": "A String", # The user agent information that is provided with the request.
"method": "A String", # The type of HTTP request, such as `GET`, `POST`, etc.
},
"sourceReferences": [ # Source code that was used to build the executable which has
# caused the given error message.
{ # A reference to a particular snapshot of the source tree used to build and
# deploy an application.
"revisionId": "A String", # The canonical and persistent identifier of the deployed revision.
# Example (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b"
"repository": "A String", # Optional. A URI string identifying the repository.
# Example: "https://github.com/GoogleCloudPlatform/kubernetes.git"
},
],
"reportLocation": { # Indicates a location in the source code of the service for which errors are # The location in the source code where the decision was made to
# report the error, usually the place where it was logged.
# For a logged exception this would be the source line where the
# exception is logged, usually close to the place where it was
# caught.
# reported. `functionName` must be provided by the application when reporting
# an error, unless the error report contains a `message` with a supported
# exception stack trace. All fields are optional for the later case.
"lineNumber": 42, # 1-based. 0 indicates that the line number is unknown.
"functionName": "A String", # Human-readable name of a function or method.
# The value can include optional context like the class or package name.
# For example, `my.package.MyClass.method` in case of Java.
"filePath": "A String", # The source code filename, which can include a truncated relative
# path, or a full path from a production machine.
},
"user": "A String", # The user who caused or was affected by the crash.
# This can be a user ID, an email address, or an arbitrary token that
# uniquely identifies the user.
# When sending an error report, leave this field empty if the user was not
# logged in. In this case the
# Error Reporting system will use other data, such as remote IP address, to
# distinguish affected users. See `affected_users_count` in
# `ErrorGroupStats`.
},
},
],
"timeRangeBegin": "A String", # The timestamp specifies the start time to which the request was restricted.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="report">report(projectName, body, x__xgafv=None)</code>
<pre>Report an individual error event.
This endpoint accepts **either** an OAuth token,
**or** an [API key](https://support.google.com/cloud/answer/6158862)
for authentication. To use an API key, append it to the URL as the value of
a `key` parameter. For example:
`POST
https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456`
Args:
projectName: string, [Required] The resource name of the Google Cloud Platform project. Written
as `projects/` plus the
[Google Cloud Platform project
ID](https://support.google.com/cloud/answer/6158840). Example:
`projects/my-project-123`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # An error event which is reported to the Error Reporting system.
"serviceContext": { # Describes a running service that sends errors. # [Required] The service context in which this error has occurred.
# Its version changes over time and multiple versions can run in parallel.
"resourceType": "A String", # Type of the MonitoredResource. List of possible values:
# https://cloud.google.com/monitoring/api/resources
#
# Value is set automatically for incoming errors and must not be set when
# reporting errors.
"version": "A String", # Represents the source code version that the developer provided,
# which could represent a version label or a Git SHA-1 hash, for example.
# For App Engine standard environment, the version is set to the version of
# the app.
"service": "A String", # An identifier of the service, such as the name of the
# executable, job, or Google App Engine service name. This field is expected
# to have a low number of values that are relatively stable over time, as
# opposed to `version`, which can be changed whenever new code is deployed.
#
# Contains the service name for error reports extracted from Google
# App Engine logs or `default` if the App Engine default service is used.
},
"message": "A String", # [Required] The error message.
# If no `context.reportLocation` is provided, the message must contain a
# header (typically consisting of the exception type name and an error
# message) and an exception stack trace in one of the supported programming
# languages and formats.
# Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go.
# Supported stack trace formats are:
#
# * **Java**: Must be the return value of
# [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29).
# * **Python**: Must be the return value of
# [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc).
# * **JavaScript**: Must be the value of
# [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned
# by V8.
# * **Ruby**: Must contain frames returned by
# [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace).
# * **C#**: Must be the return value of
# [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx).
# * **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)`
# and contain the result of
# [`(string)$exception`](http://php.net/manual/en/exception.tostring.php).
# * **Go**: Must be the return value of
# [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).
"eventTime": "A String", # [Optional] Time when the event occurred.
# If not provided, the time when the event was received by the
# Error Reporting system will be used.
"context": { # A description of the context in which an error occurred. # [Optional] A description of the context in which the error occurred.
# This data should be provided by the application when reporting an error,
# unless the
# error report has been generated automatically from Google App Engine logs.
"httpRequest": { # HTTP request data that is related to a reported error. # The HTTP request which was processed when the error was
# triggered.
# This data should be provided by the application when reporting an error,
# unless the
# error report has been generated automatically from Google App Engine logs.
"responseStatusCode": 42, # The HTTP response status code for the request.
"url": "A String", # The URL of the request.
"referrer": "A String", # The referrer information that is provided with the request.
"remoteIp": "A String", # The IP address from which the request originated.
# This can be IPv4, IPv6, or a token which is derived from the
# IP address, depending on the data that has been provided
# in the error report.
"userAgent": "A String", # The user agent information that is provided with the request.
"method": "A String", # The type of HTTP request, such as `GET`, `POST`, etc.
},
"sourceReferences": [ # Source code that was used to build the executable which has
# caused the given error message.
{ # A reference to a particular snapshot of the source tree used to build and
# deploy an application.
"revisionId": "A String", # The canonical and persistent identifier of the deployed revision.
# Example (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b"
"repository": "A String", # Optional. A URI string identifying the repository.
# Example: "https://github.com/GoogleCloudPlatform/kubernetes.git"
},
],
"reportLocation": { # Indicates a location in the source code of the service for which errors are # The location in the source code where the decision was made to
# report the error, usually the place where it was logged.
# For a logged exception this would be the source line where the
# exception is logged, usually close to the place where it was
# caught.
# reported. `functionName` must be provided by the application when reporting
# an error, unless the error report contains a `message` with a supported
# exception stack trace. All fields are optional for the later case.
"lineNumber": 42, # 1-based. 0 indicates that the line number is unknown.
"functionName": "A String", # Human-readable name of a function or method.
# The value can include optional context like the class or package name.
# For example, `my.package.MyClass.method` in case of Java.
"filePath": "A String", # The source code filename, which can include a truncated relative
# path, or a full path from a production machine.
},
"user": "A String", # The user who caused or was affected by the crash.
# This can be a user ID, an email address, or an arbitrary token that
# uniquely identifies the user.
# When sending an error report, leave this field empty if the user was not
# logged in. In this case the
# Error Reporting system will use other data, such as remote IP address, to
# distinguish affected users. See `affected_users_count` in
# `ErrorGroupStats`.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for reporting an individual error event.
# Data may be added to this message in the future.
}</pre>
</div>
</body></html>
|
