Stackdriver Error Reporting API . projects . events

Instance Methods

list(projectName=None, pageSize=None, x__xgafv=None, timeRange_period=None, pageToken=None, serviceFilter_version=None, serviceFilter_service=None, groupId=None)

Lists the specified events.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(projectName=None, pageSize=None, x__xgafv=None, timeRange_period=None, pageToken=None, serviceFilter_version=None, serviceFilter_service=None, groupId=None)
Lists the specified events.

Args:
  projectName: string, The resource name of the Google Cloud Platform project. Required.
Example: projects/my-project (required)
  pageSize: integer, 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
  timeRange_period: string, Restricts the query to the specified time range.
  pageToken: string, A `next_page_token` provided by a previous response.
  serviceFilter_version: string, The exact value to match against
[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).
  serviceFilter_service: string, The exact value to match against
[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).
  groupId: string, The group for which events shall be returned. Required.

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 service_context for which this error was reported.
            # Its version changes over time and multiple versions can run in parallel.
          "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.
          "service": "A String", # An identifier of the service, such as the name of the executable, job, or
              # Google App Engine module 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 module name for error reports extracted from Google
              # App Engine logs or `default` if the App Engine default module 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.
            # All fields are optional.
          "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.
              # All fields are optional.
            "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.
          },
          "reportLocation": { # Indicates a location in the source code of the service for which # 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. This value is in contrast to `Exception.cause_location`,
              # which describes the source line where the exception was thrown.
              # errors are reported.
              # 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. All fields are optional.
            "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`.
        },
      },
    ],
  }
list_next(previous_request, previous_response)
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.