|
| 1 | +#!/usr/bin/env python |
| 2 | +# Copyright 2016 Google Inc. All Rights Reserved. |
| 3 | +# |
| 4 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +# you may not use this file except in compliance with the License. |
| 6 | +# You may obtain a copy of the License at |
| 7 | +# |
| 8 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +# |
| 10 | +# Unless required by applicable law or agreed to in writing, software |
| 11 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +# See the License for the specific language governing permissions and |
| 14 | +# limitations under the License. |
| 15 | + |
| 16 | +"""Client for interacting with the Stackdriver Logging API""" |
| 17 | + |
| 18 | +import traceback |
| 19 | + |
| 20 | +import gcloud.logging.client |
| 21 | + |
| 22 | + |
| 23 | +class HTTPContext(object): |
| 24 | + """HTTPContext defines an object that captures the parameter for the |
| 25 | + httpRequest part of Error Reporting API |
| 26 | +
|
| 27 | + :type method: string |
| 28 | + :param method: The type of HTTP request, such as GET, POST, etc. |
| 29 | +
|
| 30 | + :type url: string |
| 31 | + :param url: The URL of the request |
| 32 | +
|
| 33 | + :type user_agent: string |
| 34 | + :param user_agent: The user agent information that is provided with the |
| 35 | + request. |
| 36 | +
|
| 37 | + :type referrer: string |
| 38 | + :param referrer: The referrer information that is provided with the |
| 39 | + request. |
| 40 | +
|
| 41 | + :type response_status_code: int |
| 42 | + :param response_status_code: The HTTP response status code for the request. |
| 43 | +
|
| 44 | + :type remote_ip: string |
| 45 | + :param remote_ip: The IP address from which the request originated. This |
| 46 | + can be IPv4, IPv6, or a token which is derived from |
| 47 | + the IP address, depending on the data that has been |
| 48 | + provided in the error report. |
| 49 | + """ |
| 50 | + |
| 51 | + def __init__(self, method=None, url=None, |
| 52 | + user_agent=None, referrer=None, |
| 53 | + response_status_code=None, remote_ip=None): |
| 54 | + self.method = method |
| 55 | + self.url = url |
| 56 | + # intentionally camel case for mapping to JSON API expects |
| 57 | + # pylint: disable=invalid-name |
| 58 | + self.userAgent = user_agent |
| 59 | + self.referrer = referrer |
| 60 | + self.responseStatusCode = response_status_code |
| 61 | + self.remoteIp = remote_ip |
| 62 | + |
| 63 | + |
| 64 | +class Client(object): |
| 65 | + """Error Reporting client. Currently Error Reporting is done by creating |
| 66 | + a Logging client. |
| 67 | +
|
| 68 | + :type project: string |
| 69 | + :param project: the project which the client acts on behalf of. If not |
| 70 | + passed falls back to the default inferred from the |
| 71 | + environment. |
| 72 | +
|
| 73 | + :type credentials: :class:`oauth2client.client.OAuth2Credentials` or |
| 74 | + :class:`NoneType` |
| 75 | + :param credentials: The OAuth2 Credentials to use for the connection |
| 76 | + owned by this client. If not passed (and if no ``http`` |
| 77 | + object is passed), falls back to the default inferred |
| 78 | + from the environment. |
| 79 | +
|
| 80 | + :type http: :class:`httplib2.Http` or class that defines ``request()``. |
| 81 | + :param http: An optional HTTP object to make requests. If not passed, an |
| 82 | + ``http`` object is created that is bound to the |
| 83 | + ``credentials`` for the current object. |
| 84 | +
|
| 85 | + :type service: str |
| 86 | + :param service: An identifier of the service, such as the name of the |
| 87 | + executable, job, or Google App Engine service name. This |
| 88 | + field is expected to have a low number of values that are |
| 89 | + relatively stable over time, as opposed to version, |
| 90 | + which can be changed whenever new code is deployed. |
| 91 | +
|
| 92 | +
|
| 93 | + :type version: str |
| 94 | + :param version: Represents the source code version that the developer |
| 95 | + provided, which could represent a version label or a Git |
| 96 | + SHA-1 hash, for example. If the developer did not provide |
| 97 | + a version, the value is set to default. |
| 98 | +
|
| 99 | + :raises: :class:`ValueError` if the project is neither passed in nor |
| 100 | + set in the environment. |
| 101 | + """ |
| 102 | + |
| 103 | + def __init__(self, project=None, |
| 104 | + credentials=None, |
| 105 | + http=None, |
| 106 | + service=None, |
| 107 | + version=None): |
| 108 | + self.logging_client = gcloud.logging.client.Client( |
| 109 | + project, credentials, http) |
| 110 | + self.service = service if service else self.DEFAULT_SERVICE |
| 111 | + self.version = version |
| 112 | + |
| 113 | + DEFAULT_SERVICE = 'python' |
| 114 | + |
| 115 | + def _send_error_report(self, message, |
| 116 | + report_location=None, http_context=None, user=None): |
| 117 | + """Makes the call to the Error Reporting API via the log stream. |
| 118 | +
|
| 119 | + This is the lower-level interface to build the payload, generally |
| 120 | + users will use either report() or report_exception() to automatically |
| 121 | + gather the parameters for this method. |
| 122 | +
|
| 123 | + Currently this method sends the Error Report by formatting a structured |
| 124 | + log message according to |
| 125 | +
|
| 126 | + https://cloud.google.com/error-reporting/docs/formatting-error-messages |
| 127 | +
|
| 128 | + :type message: string |
| 129 | + :param message: The stack trace that was reported or logged by the |
| 130 | + service. |
| 131 | +
|
| 132 | + :type report_location: dict |
| 133 | + :param report_location: The location in the source code where the |
| 134 | + decision was made to report the error, usually the place |
| 135 | + where it was logged. For a logged exception this would be the |
| 136 | + source line where the exception is logged, usually close to |
| 137 | + the place where it was caught. |
| 138 | +
|
| 139 | + This should be a Python dict that contains the keys 'filePath', |
| 140 | + 'lineNumber', and 'functionName' |
| 141 | +
|
| 142 | + :type http_context: :class`gcloud.error_reporting.HTTPContext` |
| 143 | + :param http_context: The HTTP request which was processed when the |
| 144 | + error was triggered. |
| 145 | +
|
| 146 | + :type user: string |
| 147 | + :param user: The user who caused or was affected by the crash. This can |
| 148 | + be a user ID, an email address, or an arbitrary token that |
| 149 | + uniquely identifies the user. When sending an error |
| 150 | + report, leave this field empty if the user was not |
| 151 | + logged in. In this case the Error Reporting system will |
| 152 | + use other data, such as remote IP address, |
| 153 | + to distinguish affected users. |
| 154 | + """ |
| 155 | + payload = { |
| 156 | + 'serviceContext': { |
| 157 | + 'service': self.service, |
| 158 | + }, |
| 159 | + 'message': '{0}'.format(message) |
| 160 | + |
| 161 | + } |
| 162 | + |
| 163 | + if self.version: |
| 164 | + payload['serviceContext']['version'] = self.version |
| 165 | + |
| 166 | + if report_location or http_context or user: |
| 167 | + payload['context'] = {} |
| 168 | + |
| 169 | + if report_location: |
| 170 | + payload['context']['reportLocation'] = report_location |
| 171 | + |
| 172 | + if http_context: |
| 173 | + http_context_dict = http_context.__dict__ |
| 174 | + # strip out None values |
| 175 | + # once py26 support is dropped this can use for k, v syntax |
| 176 | + not_none = {} |
| 177 | + for key, value in http_context_dict.items(): |
| 178 | + if value is not None: |
| 179 | + not_none[key] = value |
| 180 | + payload['context']['httpContext'] = not_none |
| 181 | + |
| 182 | + if user: |
| 183 | + payload['context']['user'] = user |
| 184 | + |
| 185 | + logger = self.logging_client.logger('errors') |
| 186 | + logger.log_struct(payload) |
| 187 | + |
| 188 | + def report(self, message, http_context=None, user=None): |
| 189 | + """ Reports a message to Stackdriver Error Reporting |
| 190 | + https://cloud.google.com/error-reporting/docs/formatting-error-messages |
| 191 | +
|
| 192 | + :type message: str |
| 193 | + :param message: A user-supplied message to report |
| 194 | +
|
| 195 | +
|
| 196 | + :type http_context: :class`gcloud.error_reporting.HTTPContext` |
| 197 | + :param http_context: The HTTP request which was processed when the |
| 198 | + error was triggered. |
| 199 | +
|
| 200 | + :type user: string |
| 201 | + :param user: The user who caused or was affected by the crash. This |
| 202 | + can be a user ID, an email address, or an arbitrary |
| 203 | + token that uniquely identifies the user. When sending |
| 204 | + an error report, leave this field empty if the user |
| 205 | + was not logged in. In this case the Error Reporting |
| 206 | + system will use other data, such as remote IP address, |
| 207 | + to distinguish affected users. |
| 208 | +
|
| 209 | + Example:: |
| 210 | + >>> client.report("Something went wrong!") |
| 211 | + """ |
| 212 | + stack = traceback.extract_stack() |
| 213 | + last_call = stack[-2] |
| 214 | + file_path = last_call[0] |
| 215 | + line_number = last_call[1] |
| 216 | + function_name = last_call[2] |
| 217 | + report_location = { |
| 218 | + 'filePath': file_path, |
| 219 | + 'lineNumber': line_number, |
| 220 | + 'functionName': function_name |
| 221 | + } |
| 222 | + |
| 223 | + self._send_error_report(message, |
| 224 | + http_context=http_context, |
| 225 | + user=user, |
| 226 | + report_location=report_location) |
| 227 | + |
| 228 | + def report_exception(self, http_context=None, user=None): |
| 229 | + """ Reports the details of the latest exceptions to Stackdriver Error |
| 230 | + Reporting. |
| 231 | +
|
| 232 | + :type http_context: :class`gcloud.error_reporting.HTTPContext` |
| 233 | + :param http_context: The HTTP request which was processed when the |
| 234 | + error was triggered. |
| 235 | +
|
| 236 | + :type user: string |
| 237 | + :param user: The user who caused or was affected by the crash. This |
| 238 | + can be a user ID, an email address, or an arbitrary |
| 239 | + token that uniquely identifies the user. When sending an |
| 240 | + error report, leave this field empty if the user was |
| 241 | + not logged in. In this case the Error Reporting system |
| 242 | + will use other data, such as remote IP address, |
| 243 | + to distinguish affected users. |
| 244 | +
|
| 245 | + Example:: |
| 246 | +
|
| 247 | + >>> try: |
| 248 | + >>> raise NameError |
| 249 | + >>> except Exception: |
| 250 | + >>> client.report_exception() |
| 251 | + """ |
| 252 | + self._send_error_report(traceback.format_exc(), |
| 253 | + http_context=http_context, |
| 254 | + user=user) |
0 commit comments