Method: projects.events.report

Report an individual error event and record the event to a log.

This endpoint accepts either an OAuth token, or an API key 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 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.

HTTP request

POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName=projects/*}/events:report

The URL uses gRPC Transcoding syntax.

Path parameters

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

Example: // projects/my-project-123.

Request body

The request body contains an instance of ReportedErrorEvent.

Response body

If successful, the response body is empty.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/stackdriver-integration

For more information, see the Authentication Overview.

ReportedErrorEvent

An error event which is reported to the Error Reporting system.

JSON representation 
{
  "eventTime": string,
  "serviceContext": {
    object (ServiceContext)
  },
  "message": string,
  "context": {
    object (ErrorContext)
  }
}
Fields
eventTime

string (Timestamp format)

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 in the past, or be more than 24 hours in the future. If an invalid time is provided, then an error is returned.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
serviceContext

object (ServiceContext)

Required. The service context in which this error has occurred.
message

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:
context

object (ErrorContext)

Optional. A description of the context in which the error occurred.