Error Reporting API . projects . events

close()

Close httplib2 connections.

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

Lists the specified events.

Args:
  projectName: string, Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectID}/locations/{location}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. (required)
  groupId: string, Required. The group for which events shall be returned. The `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice).
  pageSize: integer, Optional. The maximum number of results to return per response.
  pageToken: string, Optional. A `next_page_token` provided by a previous response.
  serviceFilter_resourceType: string, Optional. The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).
  serviceFilter_service: string, Optional. The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).
  serviceFilter_version: string, Optional. The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).
  timeRange_period: string, Restricts the query to the specified time range.
    Allowed values
      PERIOD_UNSPECIFIED - Do not use.
      PERIOD_1_HOUR - Retrieve data for the last hour. Recommended minimum timed count duration: 1 min.
      PERIOD_6_HOURS - Retrieve data for the last 6 hours. Recommended minimum timed count duration: 10 min.
      PERIOD_1_DAY - Retrieve data for the last day. Recommended minimum timed count duration: 1 hour.
      PERIOD_1_WEEK - Retrieve data for the last week. Recommended minimum timed count duration: 6 hours.
      PERIOD_30_DAYS - Retrieve data for the last 30 days. Recommended minimum timed count duration: 1 day.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains a set of requested error events.
  "errorEvents": [ # The error events which match the given request.
    { # An error event which is returned by the Error Reporting system.
      "context": { # A description of the context in which an 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. # Data about the context in which the error occurred.
        "httpRequest": { # HTTP request data that is related to a reported error. 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. # The HTTP request which was processed when the error was triggered.
          "method": "A String", # The type of HTTP request, such as `GET`, `POST`, etc.
          "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.
          "responseStatusCode": 42, # The HTTP response status code for the request.
          "url": "A String", # The URL of the request.
          "userAgent": "A String", # The user agent information that is provided with the request.
        },
        "reportLocation": { # Indicates a location in the source code of the service for which errors are 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. # 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.
          "filePath": "A String", # The source code filename, which can include a truncated relative path, or a full path from a production machine.
          "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.
          "lineNumber": 42, # 1-based. 0 indicates that the line number is unknown.
        },
        "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.
            "repository": "A String", # Optional. A URI string identifying the repository. Example: "https://github.com/GoogleCloudPlatform/kubernetes.git"
            "revisionId": "A String", # The canonical and persistent identifier of the deployed revision. Example (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b"
          },
        ],
        "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`.
      },
      "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.
      "serviceContext": { # Describes a running service that sends errors. Its version changes over time and multiple versions can run in parallel. # The `ServiceContext` for which this error was reported.
        "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.
        "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.
        "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.
      },
    },
  ],
  "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.
  "timeRangeBegin": "A String", # The timestamp specifies the start time to which the request was restricted.
}

list_next()

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.
        

report(projectName, body=None, x__xgafv=None)

Report an individual error event and record the event to a log. 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/{projectName}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a service built on Cloud Logging and can analyze log entries when all of the following are true: * Customer-managed encryption keys (CMEK) are disabled on the log bucket. * The log bucket satisfies one of the following: * The log bucket is stored in the same project where the logs originated. * The logs were routed to a project, and then that project stored those logs in a log bucket that it owns.

Args:
  projectName: string, Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectId}`, where `{projectId}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: // `projects/my-project-123`. (required)
  body: object, The request body.
    The object takes the form of:

{ # An error event which is reported to the Error Reporting system.
  "context": { # A description of the context in which an 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. # Optional. A description of the context in which the error occurred.
    "httpRequest": { # HTTP request data that is related to a reported error. 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. # The HTTP request which was processed when the error was triggered.
      "method": "A String", # The type of HTTP request, such as `GET`, `POST`, etc.
      "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.
      "responseStatusCode": 42, # The HTTP response status code for the request.
      "url": "A String", # The URL of the request.
      "userAgent": "A String", # The user agent information that is provided with the request.
    },
    "reportLocation": { # Indicates a location in the source code of the service for which errors are 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. # 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.
      "filePath": "A String", # The source code filename, which can include a truncated relative path, or a full path from a production machine.
      "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.
      "lineNumber": 42, # 1-based. 0 indicates that the line number is unknown.
    },
    "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.
        "repository": "A String", # Optional. A URI string identifying the repository. Example: "https://github.com/GoogleCloudPlatform/kubernetes.git"
        "revisionId": "A String", # The canonical and persistent identifier of the deployed revision. Example (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b"
      },
    ],
    "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`.
  },
  "eventTime": "A String", # Optional. Time when the event occurred. If not provided, the time when the event was received by the Error Reporting system is used. If provided, the time must not exceed the [logs retention period](https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, or be more than 24 hours in the future. If an invalid time is provided, then an error is returned.
  "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 be prefixed with `"PHP (Notice|Parse error|Fatal error|Warning): "` and contain the result of [`(string)$exception`](https://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`debug.Stack()`](https://pkg.go.dev/runtime/debug#Stack).
  "serviceContext": { # Describes a running service that sends errors. Its version changes over time and multiple versions can run in parallel. # Required. The service context in which this error has occurred.
    "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.
    "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.
    "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.
  },
}

  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.
}