307 lines
16 KiB
HTML
307 lines
16 KiB
HTML
<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.groupStats.html">groupStats</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="#list">list(projectName, alignmentTime=None, pageSize=None, x__xgafv=None, alignment=None, serviceFilter_resourceType=None, timedCountDuration=None, timeRange_period=None, serviceFilter_version=None, pageToken=None, serviceFilter_service=None, groupId=None, order=None)</a></code></p>
|
|
<p class="firstline">Lists the specified groups.</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>
|
|
<h3>Method Details</h3>
|
|
<div class="method">
|
|
<code class="details" id="list">list(projectName, alignmentTime=None, pageSize=None, x__xgafv=None, alignment=None, serviceFilter_resourceType=None, timedCountDuration=None, timeRange_period=None, serviceFilter_version=None, pageToken=None, serviceFilter_service=None, groupId=None, order=None)</code>
|
|
<pre>Lists the specified groups.
|
|
|
|
Args:
|
|
projectName: string, [Required] The resource name of the Google Cloud Platform project. Written
|
|
as <code>projects/</code> plus the
|
|
<a href="https://support.google.com/cloud/answer/6158840">Google Cloud
|
|
Platform project ID</a>.
|
|
|
|
Example: <code>projects/my-project-123</code>. (required)
|
|
alignmentTime: string, [Optional] Time where the timed counts shall be aligned if rounded
|
|
alignment is chosen. Default is 00:00 UTC.
|
|
pageSize: integer, [Optional] The maximum number of results to return per response.
|
|
Default is 20.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
alignment: string, [Optional] The alignment of the timed counts to be returned.
|
|
Default is `ALIGNMENT_EQUAL_AT_END`.
|
|
serviceFilter_resourceType: string, [Optional] The exact value to match against
|
|
[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).
|
|
timedCountDuration: string, [Optional] The preferred duration for a single returned `TimedCount`.
|
|
If not set, no timed counts are returned.
|
|
timeRange_period: string, Restricts the query to the specified time range.
|
|
serviceFilter_version: string, [Optional] The exact value to match against
|
|
[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).
|
|
pageToken: string, [Optional] A `next_page_token` provided by a previous response. To view
|
|
additional results, pass this token along with the identical query
|
|
parameters as the first request.
|
|
serviceFilter_service: string, [Optional] The exact value to match against
|
|
[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).
|
|
groupId: string, [Optional] List all <code>ErrorGroupStats</code> with these IDs. (repeated)
|
|
order: string, [Optional] The sort order in which the results are returned.
|
|
Default is `COUNT_DESC`.
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Contains a set of requested error group stats.
|
|
"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.
|
|
"errorGroupStats": [ # The error group stats which match the given request.
|
|
{ # Data extracted for a specific group based on certain filter criteria,
|
|
# such as a given time period and/or service filter.
|
|
"count": "A String", # Approximate total number of events in the given group that match
|
|
# the filter criteria.
|
|
"firstSeenTime": "A String", # Approximate first occurrence that was ever seen for this group
|
|
# and which matches the given filter criteria, ignoring the
|
|
# time_range that was specified in the request.
|
|
"affectedUsersCount": "A String", # Approximate number of affected users in the given group that
|
|
# match the filter criteria.
|
|
# Users are distinguished by data in the `ErrorContext` of the
|
|
# individual error events, such as their login name or their remote
|
|
# IP address in case of HTTP requests.
|
|
# The number of affected users can be zero even if the number of
|
|
# errors is non-zero if no data was provided from which the
|
|
# affected user could be deduced.
|
|
# Users are counted based on data in the request
|
|
# context that was provided in the error report. If more users are
|
|
# implicitly affected, such as due to a crash of the whole service,
|
|
# this is not reflected here.
|
|
"group": { # Description of a group of similar error events. # Group data that is independent of the filter criteria.
|
|
"trackingIssues": [ # Associated tracking issues.
|
|
{ # Information related to tracking the progress on resolving the error.
|
|
"url": "A String", # A URL pointing to a related entry in an issue tracking system.
|
|
# Example: https://github.com/user/project/issues/4
|
|
},
|
|
],
|
|
"groupId": "A String", # Group IDs are unique for a given project. If the same kind of error
|
|
# occurs in different service contexts, it will receive the same group ID.
|
|
"name": "A String", # The group resource name.
|
|
# Example: <code>projects/my-project-123/groups/my-groupid</code>
|
|
},
|
|
"timedCounts": [ # Approximate number of occurrences over time.
|
|
# Timed counts returned by ListGroups are guaranteed to be:
|
|
#
|
|
# - Inside the requested time interval
|
|
# - Non-overlapping, and
|
|
# - Ordered by ascending time.
|
|
{ # The number of errors in a given time period.
|
|
# All numbers are approximate since the error events are sampled
|
|
# before counting them.
|
|
"count": "A String", # Approximate number of occurrences in the given time period.
|
|
"endTime": "A String", # End of the time period to which `count` refers (excluded).
|
|
"startTime": "A String", # Start of the time period to which `count` refers (included).
|
|
},
|
|
],
|
|
"lastSeenTime": "A String", # Approximate last occurrence that was ever seen for this group and
|
|
# which matches the given filter criteria, ignoring the time_range
|
|
# that was specified in the request.
|
|
"representative": { # An error event which is returned by the Error Reporting system. # An arbitrary event that is chosen as representative for the whole group.
|
|
# The representative event is intended to be used as a quick preview for
|
|
# the whole group. Events in the group are usually sufficiently similar
|
|
# to each other such that showing an arbitrary representative provides
|
|
# insight into the characteristics of the group as a whole.
|
|
"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`.
|
|
},
|
|
},
|
|
"numAffectedServices": 42, # The total number of services with a non-zero error count for the given
|
|
# filter criteria.
|
|
"affectedServices": [ # Service contexts with a non-zero error count for the given filter
|
|
# criteria. This list can be truncated if multiple services are affected.
|
|
# Refer to `num_affected_services` for the total count.
|
|
{ # Describes a running service that sends errors.
|
|
# 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.
|
|
},
|
|
],
|
|
},
|
|
],
|
|
"timeRangeBegin": "A String", # The timestamp specifies the start time to which the request was restricted.
|
|
# The start time is set based on the requested time range. It may be adjusted
|
|
# to a later time if a project has exceeded the storage quota and older data
|
|
# has been deleted.
|
|
}</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>
|
|
|
|
</body></html> |