1 <html><body> 2 <style> 3 4 body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13 } 14 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <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> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#list">list(projectName, alignmentTime=None, pageSize=None, x__xgafv=None, alignment=None, serviceFilter_resourceType=None, timedCountDuration=None, timeRange_period=None, pageToken=None, serviceFilter_version=None, serviceFilter_service=None, groupId=None, order=None)</a></code></p> 79 <p class="firstline">Lists the specified groups.</p> 80 <p class="toc_element"> 81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 82 <p class="firstline">Retrieves the next page of results.</p> 83 <h3>Method Details</h3> 84 <div class="method"> 85 <code class="details" id="list">list(projectName, alignmentTime=None, pageSize=None, x__xgafv=None, alignment=None, serviceFilter_resourceType=None, timedCountDuration=None, timeRange_period=None, pageToken=None, serviceFilter_version=None, serviceFilter_service=None, groupId=None, order=None)</code> 86 <pre>Lists the specified groups. 87 88 Args: 89 projectName: string, [Required] The resource name of the Google Cloud Platform project. Written 90 as <code>projects/</code> plus the 91 <a href="https://support.google.com/cloud/answer/6158840">Google Cloud 92 Platform project ID</a>. 93 94 Example: <code>projects/my-project-123</code>. (required) 95 alignmentTime: string, [Optional] Time where the timed counts shall be aligned if rounded 96 alignment is chosen. Default is 00:00 UTC. 97 pageSize: integer, [Optional] The maximum number of results to return per response. 98 Default is 20. 99 x__xgafv: string, V1 error format. 100 Allowed values 101 1 - v1 error format 102 2 - v2 error format 103 alignment: string, [Optional] The alignment of the timed counts to be returned. 104 Default is `ALIGNMENT_EQUAL_AT_END`. 105 serviceFilter_resourceType: string, [Optional] The exact value to match against 106 [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). 107 timedCountDuration: string, [Optional] The preferred duration for a single returned `TimedCount`. 108 If not set, no timed counts are returned. 109 timeRange_period: string, Restricts the query to the specified time range. 110 pageToken: string, [Optional] A `next_page_token` provided by a previous response. To view 111 additional results, pass this token along with the identical query 112 parameters as the first request. 113 serviceFilter_version: string, [Optional] The exact value to match against 114 [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). 115 serviceFilter_service: string, [Optional] The exact value to match against 116 [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). 117 groupId: string, [Optional] List all <code>ErrorGroupStats</code> with these IDs. (repeated) 118 order: string, [Optional] The sort order in which the results are returned. 119 Default is `COUNT_DESC`. 120 121 Returns: 122 An object of the form: 123 124 { # Contains a set of requested error group stats. 125 "nextPageToken": "A String", # If non-empty, more results are available. 126 # Pass this token, along with the same query parameters as the first 127 # request, to view the next page of results. 128 "errorGroupStats": [ # The error group stats which match the given request. 129 { # Data extracted for a specific group based on certain filter criteria, 130 # such as a given time period and/or service filter. 131 "count": "A String", # Approximate total number of events in the given group that match 132 # the filter criteria. 133 "firstSeenTime": "A String", # Approximate first occurrence that was ever seen for this group 134 # and which matches the given filter criteria, ignoring the 135 # time_range that was specified in the request. 136 "affectedUsersCount": "A String", # Approximate number of affected users in the given group that 137 # match the filter criteria. 138 # Users are distinguished by data in the `ErrorContext` of the 139 # individual error events, such as their login name or their remote 140 # IP address in case of HTTP requests. 141 # The number of affected users can be zero even if the number of 142 # errors is non-zero if no data was provided from which the 143 # affected user could be deduced. 144 # Users are counted based on data in the request 145 # context that was provided in the error report. If more users are 146 # implicitly affected, such as due to a crash of the whole service, 147 # this is not reflected here. 148 "affectedServices": [ # Service contexts with a non-zero error count for the given filter 149 # criteria. This list can be truncated if multiple services are affected. 150 # Refer to `num_affected_services` for the total count. 151 { # Describes a running service that sends errors. 152 # Its version changes over time and multiple versions can run in parallel. 153 "resourceType": "A String", # Type of the MonitoredResource. List of possible values: 154 # https://cloud.google.com/monitoring/api/resources 155 # 156 # Value is set automatically for incoming errors and must not be set when 157 # reporting errors. 158 "version": "A String", # Represents the source code version that the developer provided, 159 # which could represent a version label or a Git SHA-1 hash, for example. 160 # For App Engine standard environment, the version is set to the version of 161 # the app. 162 "service": "A String", # An identifier of the service, such as the name of the 163 # executable, job, or Google App Engine service name. This field is expected 164 # to have a low number of values that are relatively stable over time, as 165 # opposed to `version`, which can be changed whenever new code is deployed. 166 # 167 # Contains the service name for error reports extracted from Google 168 # App Engine logs or `default` if the App Engine default service is used. 169 }, 170 ], 171 "timedCounts": [ # Approximate number of occurrences over time. 172 # Timed counts returned by ListGroups are guaranteed to be: 173 # 174 # - Inside the requested time interval 175 # - Non-overlapping, and 176 # - Ordered by ascending time. 177 { # The number of errors in a given time period. 178 # All numbers are approximate since the error events are sampled 179 # before counting them. 180 "count": "A String", # Approximate number of occurrences in the given time period. 181 "endTime": "A String", # End of the time period to which `count` refers (excluded). 182 "startTime": "A String", # Start of the time period to which `count` refers (included). 183 }, 184 ], 185 "lastSeenTime": "A String", # Approximate last occurrence that was ever seen for this group and 186 # which matches the given filter criteria, ignoring the time_range 187 # that was specified in the request. 188 "representative": { # An error event which is returned by the Error Reporting system. # An arbitrary event that is chosen as representative for the whole group. 189 # The representative event is intended to be used as a quick preview for 190 # the whole group. Events in the group are usually sufficiently similar 191 # to each other such that showing an arbitrary representative provides 192 # insight into the characteristics of the group as a whole. 193 "serviceContext": { # Describes a running service that sends errors. # The `ServiceContext` for which this error was reported. 194 # Its version changes over time and multiple versions can run in parallel. 195 "resourceType": "A String", # Type of the MonitoredResource. List of possible values: 196 # https://cloud.google.com/monitoring/api/resources 197 # 198 # Value is set automatically for incoming errors and must not be set when 199 # reporting errors. 200 "version": "A String", # Represents the source code version that the developer provided, 201 # which could represent a version label or a Git SHA-1 hash, for example. 202 # For App Engine standard environment, the version is set to the version of 203 # the app. 204 "service": "A String", # An identifier of the service, such as the name of the 205 # executable, job, or Google App Engine service name. This field is expected 206 # to have a low number of values that are relatively stable over time, as 207 # opposed to `version`, which can be changed whenever new code is deployed. 208 # 209 # Contains the service name for error reports extracted from Google 210 # App Engine logs or `default` if the App Engine default service is used. 211 }, 212 "message": "A String", # The stack trace that was reported or logged by the service. 213 "eventTime": "A String", # Time when the event occurred as provided in the error report. 214 # If the report did not contain a timestamp, the time the error was received 215 # by the Error Reporting system is used. 216 "context": { # A description of the context in which an error occurred. # Data about the context in which the error occurred. 217 # This data should be provided by the application when reporting an error, 218 # unless the 219 # error report has been generated automatically from Google App Engine logs. 220 "httpRequest": { # HTTP request data that is related to a reported error. # The HTTP request which was processed when the error was 221 # triggered. 222 # This data should be provided by the application when reporting an error, 223 # unless the 224 # error report has been generated automatically from Google App Engine logs. 225 "responseStatusCode": 42, # The HTTP response status code for the request. 226 "url": "A String", # The URL of the request. 227 "referrer": "A String", # The referrer information that is provided with the request. 228 "remoteIp": "A String", # The IP address from which the request originated. 229 # This can be IPv4, IPv6, or a token which is derived from the 230 # IP address, depending on the data that has been provided 231 # in the error report. 232 "userAgent": "A String", # The user agent information that is provided with the request. 233 "method": "A String", # The type of HTTP request, such as `GET`, `POST`, etc. 234 }, 235 "sourceReferences": [ # Source code that was used to build the executable which has 236 # caused the given error message. 237 { # A reference to a particular snapshot of the source tree used to build and 238 # deploy an application. 239 "revisionId": "A String", # The canonical and persistent identifier of the deployed revision. 240 # Example (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b" 241 "repository": "A String", # Optional. A URI string identifying the repository. 242 # Example: "https://github.com/GoogleCloudPlatform/kubernetes.git" 243 }, 244 ], 245 "user": "A String", # The user who caused or was affected by the crash. 246 # This can be a user ID, an email address, or an arbitrary token that 247 # uniquely identifies the user. 248 # When sending an error report, leave this field empty if the user was not 249 # logged in. In this case the 250 # Error Reporting system will use other data, such as remote IP address, to 251 # distinguish affected users. See `affected_users_count` in 252 # `ErrorGroupStats`. 253 "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 254 # report the error, usually the place where it was logged. 255 # For a logged exception this would be the source line where the 256 # exception is logged, usually close to the place where it was 257 # caught. This value is in contrast to `Exception.cause_location`, 258 # which describes the source line where the exception was thrown. 259 # reported. `functionName` must be provided by the application when reporting 260 # an error, unless the error report contains a `message` with a supported 261 # exception stack trace. All fields are optional for the later case. 262 "lineNumber": 42, # 1-based. 0 indicates that the line number is unknown. 263 "functionName": "A String", # Human-readable name of a function or method. 264 # The value can include optional context like the class or package name. 265 # For example, `my.package.MyClass.method` in case of Java. 266 "filePath": "A String", # The source code filename, which can include a truncated relative 267 # path, or a full path from a production machine. 268 }, 269 }, 270 }, 271 "numAffectedServices": 42, # The total number of services with a non-zero error count for the given 272 # filter criteria. 273 "group": { # Description of a group of similar error events. # Group data that is independent of the filter criteria. 274 "trackingIssues": [ # Associated tracking issues. 275 { # Information related to tracking the progress on resolving the error. 276 "url": "A String", # A URL pointing to a related entry in an issue tracking system. 277 # Example: https://github.com/user/project/issues/4 278 }, 279 ], 280 "groupId": "A String", # Group IDs are unique for a given project. If the same kind of error 281 # occurs in different service contexts, it will receive the same group ID. 282 "name": "A String", # The group resource name. 283 # Example: <code>projects/my-project-123/groups/my-groupid</code> 284 }, 285 }, 286 ], 287 "timeRangeBegin": "A String", # The timestamp specifies the start time to which the request was restricted. 288 # The start time is set based on the requested time range. It may be adjusted 289 # to a later time if a project has exceeded the storage quota and older data 290 # has been deleted. 291 }</pre> 292 </div> 293 294 <div class="method"> 295 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 296 <pre>Retrieves the next page of results. 297 298 Args: 299 previous_request: The request for the previous page. (required) 300 previous_response: The response from the request for the previous page. (required) 301 302 Returns: 303 A request object that you can call 'execute()' on to request the next 304 page. Returns None if there are no more items in the collection. 305 </pre> 306 </div> 307 308 </body></html>
