package google.devtools.clouderrorreporting.v1beta1
Get desktop application:
View/edit binary Protocol Buffers messages
Service for retrieving and updating individual error groups.
rpc GetGroup (, )
error_group_service.proto:32Get the specified group.
message
error_group_service.proto:49A request to return an individual group.
string group_name = 1
[Required] The group resource name. Written as <code>projects/<var>projectID</var>/groups/<var>group_name</var></code>. Call <a href="/error-reporting/reference/rest/v1beta1/projects.groupStats/list"> <code>groupStats.list</code></a> to return a list of groups belonging to this project. Example: <code>projects/my-project-123/groups/my-group</code>
Replace the data for the specified group. Fails if the group does not exist.
message
error_group_service.proto:62A request to replace the existing data for the given group.
optional group = 1
[Required] The group which replaces the resource on the server.
An API for retrieving and managing error statistics as well as data for individual events.
Lists the specified groups.
message
error_stats_service.proto:57Specifies a set of `ErrorGroupStats` to return.
string project_name = 1
[Required] The resource name of the Google Cloud Platform project. Written as <code>projects/</code> plus the <a href="https://support.google.com/cloud/answer/6158840">Google Cloud Platform project ID</a>. Example: <code>projects/my-project-123</code>.
repeated string group_id = 2
[Optional] List all <code>ErrorGroupStats</code> with these IDs.
optional service_filter = 3
[Optional] List only <code>ErrorGroupStats</code> which belong to a service context that matches the filter. Data for all service contexts is returned if this field is not specified.
optional time_range = 5
[Optional] List data for the given time range. If not set a default time range is used. The field time_range_begin in the response will specify the beginning of this time range. Only <code>ErrorGroupStats</code> with a non-zero count in the given time range are returned, unless the request contains an explicit group_id list. If a group_id list is given, also <code>ErrorGroupStats</code> with zero occurrences are returned.
optional timed_count_duration = 6
[Optional] The preferred duration for a single returned `TimedCount`. If not set, no timed counts are returned.
TimedCountAlignment alignment = 7
[Optional] The alignment of the timed counts to be returned. Default is `ALIGNMENT_EQUAL_AT_END`.
optional alignment_time = 8
[Optional] Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.
ErrorGroupOrder order = 9
[Optional] The sort order in which the results are returned. Default is `COUNT_DESC`.
int32 page_size = 11
[Optional] The maximum number of results to return per response. Default is 20.
string page_token = 12
[Optional] A `next_page_token` provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request.
message
error_stats_service.proto:110Contains a set of requested error group stats.
repeated error_group_stats = 1
The error group stats which match the given request.
string next_page_token = 2
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.
optional time_range_begin = 4
The timestamp specifies the start time to which the request was restricted. The start time is set based on the requested time range. It may be adjusted to a later time if a project has exceeded the storage quota and older data has been deleted.
Lists the specified events.
message
error_stats_service.proto:200Specifies a set of error events to return.
string project_name = 1
[Required] The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`.
string group_id = 2
[Required] The group for which events shall be returned.
optional service_filter = 3
[Optional] List only ErrorGroups which belong to a service context that matches the filter. Data for all service contexts is returned if this field is not specified.
optional time_range = 4
[Optional] List only data for the given time range. If not set a default time range is used. The field time_range_begin in the response will specify the beginning of this time range.
int32 page_size = 6
[Optional] The maximum number of results to return per response.
string page_token = 7
[Optional] A `next_page_token` provided by a previous response.
message
error_stats_service.proto:229Contains a set of requested error events.
repeated error_events = 1
The error events which match the given request.
string next_page_token = 2
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.
optional time_range_begin = 4
The timestamp specifies the start time to which the request was restricted.
Deletes all error events of a given project.
message
error_stats_service.proto:294Deletes all events in the project.
string project_name = 1
[Required] The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`.
message
error_stats_service.proto:304Response message for deleting error events.
(message has no fields)
An API for reporting error events.
Report an individual error event. This endpoint accepts <strong>either</strong> an OAuth token, <strong>or</strong> an <a href="https://support.google.com/cloud/answer/6158862">API key</a> for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: <pre>POST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456</pre>
message
report_errors_service.proto:51A request for reporting an individual error event.
string project_name = 1
[Required] The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`.
optional event = 2
[Required] The error event to be reported.
message
report_errors_service.proto:65Response for reporting an individual error event. Data may be added to this message in the future.
(message has no fields)
message
common.proto:96A 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.
Used in: ,
optional http_request = 1
The HTTP request which was processed when the error was triggered.
string user = 2
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`.
optional report_location = 3
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.
message
common.proto:52An error event which is returned by the Error Reporting system.
Used in: ,
optional event_time = 1
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.
optional service_context = 2
The `ServiceContext` for which this error was reported.
string message = 3
The stack trace that was reported or logged by the service.
optional context = 5
Data about the context in which the error occurred.
message
common.proto:31Description of a group of similar error events.
Used as response type in: ErrorGroupService.GetGroup, ErrorGroupService.UpdateGroup
Used as field type in: ,
string name = 1
The group resource name. Example: <code>projects/my-project-123/groups/my-groupid</code>
string group_id = 2
Group IDs are unique for a given project. If the same kind of error occurs in different service contexts, it will receive the same group ID.
repeated tracking_issues = 3
Associated tracking issues.
A sorting order of error groups.
Used in:
GROUP_ORDER_UNSPECIFIED = 0
No group order specified.
COUNT_DESC = 1
Total count of errors in the given time window in descending order.
LAST_SEEN_DESC = 2
Timestamp when the group was last seen in the given time window in descending order.
CREATED_DESC = 3
Timestamp when the group was created in descending order.
AFFECTED_USERS_DESC = 4
Number of affected users in the given time window in descending order.
message
error_stats_service.proto:128Data extracted for a specific group based on certain filter criteria, such as a given time period and/or service filter.
Used in:
optional group = 1
Group data that is independent of the filter criteria.
int64 count = 2
Approximate total number of events in the given group that match the filter criteria.
int64 affected_users_count = 3
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.
repeated timed_counts = 4
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.
optional first_seen_time = 5
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.
optional last_seen_time = 6
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.
repeated affected_services = 7
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.
int32 num_affected_services = 8
The total number of services with a non-zero error count for the given filter criteria.
optional representative = 9
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.
message
common.proto:124HTTP 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.
Used in:
string method = 1
The type of HTTP request, such as `GET`, `POST`, etc.
string url = 2
The URL of the request.
string user_agent = 3
The user agent information that is provided with the request.
string referrer = 4
The referrer information that is provided with the request.
int32 response_status_code = 5
The HTTP response status code for the request.
string remote_ip = 6
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.
message
error_stats_service.proto:244Requests might be rejected or the resulting timed count durations might be adjusted for lower durations.
Used in: ,
QueryTimeRange.Period period = 1
Restricts the query to the specified time range.
The supported time ranges.
Used in:
PERIOD_UNSPECIFIED = 0
Do not use.
PERIOD_1_HOUR = 1
Retrieve data for the last hour. Recommended minimum timed count duration: 1 min.
PERIOD_6_HOURS = 2
Retrieve data for the last 6 hours. Recommended minimum timed count duration: 10 min.
PERIOD_1_DAY = 3
Retrieve data for the last day. Recommended minimum timed count duration: 1 hour.
PERIOD_1_WEEK = 4
Retrieve data for the last week. Recommended minimum timed count duration: 6 hours.
PERIOD_30_DAYS = 5
Retrieve data for the last 30 days. Recommended minimum timed count duration: 1 day.
message
report_errors_service.proto:68An error event which is reported to the Error Reporting system.
Used in:
optional event_time = 1
[Optional] Time when the event occurred. If not provided, the time when the event was received by the Error Reporting system will be used.
optional service_context = 2
[Required] The service context in which this error has occurred.
string message = 3
[Required] A message describing the error. The message can contain an exception stack in one of the supported programming languages and formats. In that case, the message is parsed and detailed exception information is returned when retrieving the error event again.
optional context = 4
[Optional] A description of the context in which the error occurred.
message
common.proto:70Describes a running service that sends errors. Its version changes over time and multiple versions can run in parallel.
Used in: , ,
string service = 2
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.
string version = 3
Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example.
string resource_type = 4
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.
message
error_stats_service.proto:279Specifies 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.
Used in: ,
string service = 2
[Optional] The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).
string version = 3
[Optional] The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).
string resource_type = 4
[Optional] The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).
message
common.proto:152Indicates a location in the source code of the service for which 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.
Used in:
string file_path = 1
The source code filename, which can include a truncated relative path, or a full path from a production machine.
int32 line_number = 2
1-based. 0 indicates that the line number is unknown.
string function_name = 4
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.
message
error_stats_service.proto:188The number of errors in a given time period. All numbers are approximate since the error events are sampled before counting them.
Used in:
int64 count = 1
Approximate number of occurrences in the given time period.
optional start_time = 2
Start of the time period to which `count` refers (included).
optional end_time = 3
End of the time period to which `count` refers (excluded).
Specifies how the time periods of error group counts are aligned.
Used in:
ERROR_COUNT_ALIGNMENT_UNSPECIFIED = 0
No alignment specified.
ALIGNMENT_EQUAL_ROUNDED = 1
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.
ALIGNMENT_EQUAL_AT_END = 2
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.
message
common.proto:45Information related to tracking the progress on resolving the error.
Used in:
string url = 1
A URL pointing to a related entry in an issue tracking system. Example: https://github.com/user/project/issues/4