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.
The HTTP request which was processed when the error was
triggered.
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.
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`.
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use ErrorContext.ProtoReflect.Descriptor instead.
(*T) GetHttpRequest() *HttpRequestContext(*T) GetReportLocation() *SourceLocation(*T) GetUser() string(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func (*ErrorEvent).GetContext() *ErrorContext
func (*ReportedErrorEvent).GetContext() *ErrorContext
ErrorGroupServiceClient is the client API for ErrorGroupService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
Get the specified group.
Replace the data for the specified group.
Fails if the group does not exist.
*errorGroupServiceClient
func NewErrorGroupServiceClient(cc grpc.ClientConnInterface) ErrorGroupServiceClient
Data extracted for a specific group based on certain filter criteria,
such as a given time period and/or service filter.
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.
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.
Approximate total number of events in the given group that match
the filter criteria.
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.
Group data that is independent of the filter criteria.
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.
The total number of services with a non-zero error count for the given
filter criteria.
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.
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.
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use ErrorGroupStats.ProtoReflect.Descriptor instead.
(*T) GetAffectedServices() []*ServiceContext(*T) GetAffectedUsersCount() int64(*T) GetCount() int64(*T) GetFirstSeenTime() *timestamppb.Timestamp(*T) GetGroup() *ErrorGroup(*T) GetLastSeenTime() *timestamppb.Timestamp(*T) GetNumAffectedServices() int32(*T) GetRepresentative() *ErrorEvent(*T) GetTimedCounts() []*TimedCount(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func (*ListGroupStatsResponse).GetErrorGroupStats() []*ErrorGroupStats
func cloud.google.com/go/errorreporting/apiv1beta1.(*ErrorGroupStatsIterator).Next() (*ErrorGroupStats, error)
ErrorStatsServiceClient is the client API for ErrorStatsService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
Deletes all error events of a given project.
Lists the specified events.
Lists the specified groups.
*errorStatsServiceClient
func NewErrorStatsServiceClient(cc grpc.ClientConnInterface) ErrorStatsServiceClient
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 type of HTTP request, such as `GET`, `POST`, etc.
The referrer information that is provided with the request.
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.
The HTTP response status code for the request.
The URL of the request.
The user agent information that is provided with the request.
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use HttpRequestContext.ProtoReflect.Descriptor instead.
(*T) GetMethod() string(*T) GetReferrer() string(*T) GetRemoteIp() string(*T) GetResponseStatusCode() int32(*T) GetUrl() string(*T) GetUserAgent() string(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func (*ErrorContext).GetHttpRequest() *HttpRequestContext
An error event which is reported to the Error Reporting system.
Optional. A description of the context in which the error occurred.
Optional. Time when the event occurred.
If not provided, the time when the event was received by the
Error Reporting system will be used.
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 start with `PHP (Notice|Parse error|Fatal error|Warning)`
and contain the result of
[`(string)$exception`](http://php.net/manual/en/exception.tostring.php).
* **Go**: Must be the return value of
[`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).
Required. The service context in which this error has occurred.
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use ReportedErrorEvent.ProtoReflect.Descriptor instead.
(*T) GetContext() *ErrorContext(*T) GetEventTime() *timestamppb.Timestamp(*T) GetMessage() string(*T) GetServiceContext() *ServiceContext(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func (*ReportErrorEventRequest).GetEvent() *ReportedErrorEvent
ReportErrorsServiceClient is the client API for ReportErrorsService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
Report an individual error event.
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/projects/example-project/events:report?key=123ABC456`
*reportErrorsServiceClient
func NewReportErrorsServiceClient(cc grpc.ClientConnInterface) ReportErrorsServiceClient
ReportErrorsServiceServer is the server API for ReportErrorsService service.
Report an individual error event.
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/projects/example-project/events:report?key=123ABC456`
*UnimplementedReportErrorsServiceServer
func RegisterReportErrorsServiceServer(s *grpc.Server, srv ReportErrorsServiceServer)
Describes a running service that sends errors.
Its version changes over time and multiple versions can run in parallel.
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.
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.
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.
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use ServiceContext.ProtoReflect.Descriptor instead.
(*T) GetResourceType() string(*T) GetService() string(*T) GetVersion() string(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func (*ErrorEvent).GetServiceContext() *ServiceContext
func (*ErrorGroupStats).GetAffectedServices() []*ServiceContext
func (*ReportedErrorEvent).GetServiceContext() *ServiceContext
Specifies criteria for filtering a subset of service contexts.
The fields in the filter correspond to the fields in `ServiceContext`.
Only exact, case-sensitive matches are supported.
If a field is unset or empty, it matches arbitrary values.
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.
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.
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.
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use ServiceContextFilter.ProtoReflect.Descriptor instead.
(*T) GetResourceType() string(*T) GetService() string(*T) GetVersion() string(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func (*ListEventsRequest).GetServiceFilter() *ServiceContextFilter
func (*ListGroupStatsRequest).GetServiceFilter() *ServiceContextFilter
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 source code filename, which can include a truncated relative
path, or a full path from a production machine.
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.
1-based. 0 indicates that the line number is unknown.
sizeCacheprotoimpl.SizeCachestateprotoimpl.MessageStateunknownFieldsprotoimpl.UnknownFields
Deprecated: Use SourceLocation.ProtoReflect.Descriptor instead.
(*T) GetFilePath() string(*T) GetFunctionName() string(*T) GetLineNumber() int32(*T) ProtoMessage()(*T) ProtoReflect() protoreflect.Message(*T) Reset()(*T) String() string
*T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
*T : google.golang.org/protobuf/runtime/protoiface.MessageV1
*T : expvar.Var
*T : fmt.Stringer
*T : google.golang.org/protobuf/internal/impl.messageV1
*T : context.stringer
*T : runtime.stringer
func (*ErrorContext).GetReportLocation() *SourceLocation
Package-Level Constants (total 14, all are exported)
Number of affected users in the given time window in descending order.
Total count of errors in the given time window in descending order.
Timestamp when the group was created in descending order.
No group order specified.
Timestamp when the group was last seen in the given time window
in descending order.
Retrieve data for the last day.
Recommended minimum timed count duration: 1 hour.
Retrieve data for the last hour.
Recommended minimum timed count duration: 1 min.
Retrieve data for the last week.
Recommended minimum timed count duration: 6 hours.
Retrieve data for the last 30 days.
Recommended minimum timed count duration: 1 day.
Retrieve data for the last 6 hours.
Recommended minimum timed count duration: 10 min.
Do not use.
The time periods shall be consecutive, have width equal to the
requested duration, and be aligned at the end of the requested time
period. This can result in a different size of the
first time period.
The time periods shall be consecutive, have width equal to the
requested duration, and be aligned at the `alignment_time` provided in
the request.
The `alignment_time` does not have to be inside the query period but
even if it is outside, only time periods are returned which overlap
with the query period.
A rounded alignment will typically result in a
different size of the first or the last time period.
No alignment specified.
The pages are generated with Goldsv0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.
