Fix location information for logpoint output.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=130294233

Author: b-daniels

src/googleclouddebugger/__init__.py

@@ -54,9 +54,7 @@ def _StartDebugger():
   _breakpoints_manager = breakpoints_manager.BreakpointsManager(_hub_client)
 
   # Set up loggers for logpoints.
-  capture_collector.log_info_message = logging.info
-  capture_collector.log_warning_message = logging.warning
-  capture_collector.log_error_message = logging.error
+  capture_collector.SetLogger(logging.getLogger())
 
   capture_collector.CaptureCollector.pretty_printers.append(
       appengine_pretty_printers.PrettyPrinter)

src/googleclouddebugger/capture_collector.py

@@ -19,6 +19,7 @@
 import copy
 import datetime
 import inspect
+import logging
 import os
 import re
 import sys
@@ -49,6 +50,70 @@
 INVALID_EXPRESSION_INDEX = '<N/A>'
 
 
+def NormalizePath(path):
+  """Removes any Python system path prefix from the given path.
+
+  Python keeps almost all paths absolute. This is not what we actually
+  want to return. This loops through system paths (directories in which
+  Python will load modules). If "path" is relative to one of them, the
+  directory prefix is removed.
+
+  Args:
+    path: absolute path to normalize (relative paths will not be altered)
+
+  Returns:
+    Relative path if "path" is within one of the sys.path directories or
+    the input otherwise.
+  """
+  path = os.path.normpath(path)
+
+  for sys_path in sys.path:
+    if not sys_path:
+      continue
+
+    # Append '/' at the end of the path if it's not there already.
+    sys_path = os.path.join(sys_path, '')
+
+    if path.startswith(sys_path):
+      return path[len(sys_path):]
+
+  return path
+
+
+class LineNoFilter(logging.Filter):
+  """Enables overriding the path and line number in a logging record.
+
+  The "extra" parameter in logging cannot override existing fields in log
+  record, so we can't use it to directly set pathname and lineno. Instead,
+  we add this filter to the default logger, and it looks for "cdbg_pathname"
+  and "cdbg_lineno", moving them to the pathname and lineno fields accordingly.
+  """
+
+  def filter(self, record):
+    # This method gets invoked for user-generated logging, so verify that this
+    # particular invocation came from our logging code.
+    if record.pathname != inspect.currentframe().f_code.co_filename:
+      return True
+    if hasattr(record, 'cdbg_pathname'):
+      record.pathname = record.cdbg_pathname
+      del record.cdbg_pathname
+    if hasattr(record, 'cdbg_lineno'):
+      record.lineno = record.cdbg_lineno
+      del record.cdbg_lineno
+    return True
+
+
+def SetLogger(logger):
+  """Sets the logger object to use for all 'LOG' breakpoint actions."""
+  global log_info_message
+  global log_warning_message
+  global log_error_message
+  log_info_message = logger.info
+  log_warning_message = logger.warning
+  log_error_message = logger.error
+  logger.addFilter(LineNoFilter())
+
+
 class CaptureCollector(object):
   """Captures application state snapshot.
 
@@ -145,7 +210,7 @@ def Collect(self, top_frame):
       breakpoint_frames.append({
           'function': code.co_name,
           'location': {
-              'path': CaptureCollector._NormalizePath(code.co_filename),
+              'path': NormalizePath(code.co_filename),
               'line': frame.f_lineno},
           'arguments': frame_arguments,
           'locals': frame_locals})
@@ -403,36 +468,6 @@ def _CaptureRequestLogId(self):
         self.breakpoint['labels'][
             labels.Breakpoint.REQUEST_LOG_ID] = request_log_id
 
-  @staticmethod
-  def _NormalizePath(path):
-    """Converts an absolute path to a relative one.
-
-    Python keeps almost all paths absolute. This is not what we actually
-    want to return. This loops through system paths (directories in which
-    Python will load modules). If "path" is relative to one of them, the
-    directory prefix is removed.
-
-    Args:
-      path: absolute path to normalize (relative paths will not be altered)
-
-    Returns:
-      Relative path if "path" is within one of the sys.path directories or
-      the input otherwise.
-    """
-    path = os.path.normpath(path)
-
-    for sys_path in sys.path:
-      if not sys_path:
-        continue
-
-      # Append '/' at the end of the path if it's not there already.
-      sys_path = os.path.join(sys_path, '')
-
-      if path.startswith(sys_path):
-        return path[len(sys_path):]
-
-    return path
-
 
 class LogCollector(object):
   """Captures minimal application snapshot and logs it to application log.
@@ -489,7 +524,10 @@ def Log(self, frame):
         self._definition.get('logMessageFormat', ''),
         self._EvaluateExpressions(frame))
 
-    self._log_message('LOGPOINT: ' + message)
+    self._log_message('LOGPOINT: ' + message, extra={
+        'cdbg_pathname': NormalizePath(frame.f_code.co_filename),
+        'cdbg_lineno': frame.f_lineno
+    })
     return None
 
   def _EvaluateExpressions(self, frame):