Error Reporting Client

Client for interacting with the Error Reporting API

class google.cloud.error_reporting.client.Client(project=None, credentials=None, _http=None, service=None, version=None, client_info=<google.api_core.gapic_v1.client_info.ClientInfo object>, client_options=None, _use_grpc=None)

Bases: google.cloud.client.ClientWithProject

Error Reporting client. Currently Error Reporting is done by creating a Logging client.

  • Parameters

    • project (str) – the project which the client acts on behalf of. If not passed falls back to the default inferred from the environment.

    • credentials (google.auth.credentials.Credentials or NoneType) – The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment.

    • _http (Session) – (Optional) HTTP object to make requests. Can be any object that defines request() with the same interface as requests.Session.request(). If not passed, an _http object is created that is bound to the credentials for the current object. This parameter should be considered private, and could change in the future.

    • service (str) – 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.

    • version (str) – Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example. If the developer did not provide a version, the value is set to default.

    • _use_grpc (bool) – (Optional) Explicitly specifies whether to use the gRPC transport or HTTP. If unset, falls back to the GOOGLE_CLOUD_DISABLE_GRPC environment variable. This parameter should be considered private, and could change in the future.

    • client_info (google.api_core.client_info.ClientInfo or google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own library or partner tool.

    • client_options (ClientOptions or dict) – (Optional) Client options used to set user options on the client. API Endpoint should be set through client_options.

  • Raises

    ValueError if the project is neither passed in nor set in the environment.

SCOPE(: Optional[Tuple[str, ...] = ('https://www.googleapis.com/auth/cloud-platform', )

The scopes required for authenticating as an API consumer.

report(message, http_context=None, user=None)

Reports a message to Error Reporting

https://cloud.google.com/error-reporting/docs/formatting-error-messages

  • Parameters

    • message (str) – A user-supplied message to report

    • http_context (:class`google.cloud.error_reporting.HTTPContext`) – The HTTP request which was processed when the error was triggered.

    • user (str) – 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.

Example:

>>>  client.report("Something went wrong!")

property report_errors_api()

Helper for logging-related API calls.

See https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs

  • Return type

    _gapic._ErrorReportingGapicApi or _logging._ErrorReportingLoggingAPI

  • Returns

    A class that implements the report errors API.

report_exception(http_context=None, user=None)

Reports the details of the latest exceptions to Error Reporting.

  • Parameters

    • http_context (:class`google.cloud.error_reporting.HTTPContext`) – The HTTP request which was processed when the error was triggered.

    • user (str) – 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.

      Example:

      >>>     try:
>>>         raise NameError
>>>     except Exception:
>>>         client.report_exception()

class google.cloud.error_reporting.client.HTTPContext(method=None, url=None, user_agent=None, referrer=None, response_status_code=None, remote_ip=None)

Bases: object

HTTPContext defines an object that captures the parameter for the httpRequest part of Error Reporting API

  • Parameters

    • method (str) – The type of HTTP request, such as GET, POST, etc.

    • url (str) – The URL of the request

    • user_agent (str) – The user agent information that is provided with the request.

    • referrer (str) – The referrer information that is provided with the request.

    • response_status_code (int) – The HTTP response status code for the request.

    • remote_ip (str) – 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.