Remove SourceLocation from App Engine Java logging. It was used for Cloud Debugger tool that was shut down on May 31, 2023: https://docs.cloud.google.com/stackdriver/docs/deprecations/debugger-deprecation

PiperOrigin-RevId: 848655394
Change-Id: Ib9cd8211083beddf84e3c8e824e5c20797317b65

Author: ludoch

protobuf/api/log_service.proto

@@ -20,8 +20,6 @@ syntax = "proto2";
 
 package java.apphosting;
 
-import "source.proto";
-
 option java_package = "com.google.apphosting.api.logservice";
 option java_outer_classname = "LogServicePb";
 
@@ -42,8 +40,6 @@ message UserAppLogLine {
   required int64 level = 2;
   required string message = 3;
 
-  // Line of code that generated this log message.
-  optional SourceLocation source_location = 4;
 }
 
 message UserAppLogGroup {
@@ -81,8 +77,6 @@ message LogLine {
   // User provided log message.
   required string log_message = 3;
 
-  // Line of code that generated this log message.
-  optional SourceLocation source_location = 4;
 }
 
 // Complete log information about a single request to an application.

protobuf/api/source.proto

@@ -18,8 +18,6 @@ syntax = "proto2";
 
 package java.apphosting;
 
-import "source.proto";
-
 option cc_enable_arenas = true;
 option java_package = "com.google.apphosting.base.protos";
 option java_outer_classname = "AppLogsPb";
@@ -36,9 +34,6 @@ message AppLogLine {
 
   // Message generated by application with details.
   required string message = 3;
-
-  // Line of code that generated this log message.
-  optional SourceLocation source_location = 4;
 }
 
 // Application log group.  All logs in this structure belong to the same
@@ -57,9 +52,6 @@ message AppLogMessage {
 
   // Message generated by application with details.
   optional string log_message = 2;
-
-  // Line of code that generated this log message.
-  optional SourceLocation source_location = 4;
 }
 
 // Collection of log messages as stored in the level_X: columns in logs v2.

protobuf/app_logs.proto

@@ -21,18 +21,16 @@
 import com.google.apphosting.base.protos.AppLogsPb.AppLogGroup;
 import com.google.apphosting.base.protos.AppLogsPb.AppLogLine;
 import com.google.apphosting.base.protos.RuntimePb.UPResponse;
-import com.google.apphosting.base.protos.SourcePb.SourceLocation;
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Stopwatch;
-import com.google.common.base.Throwables;
 import com.google.common.collect.ImmutableList;
 import com.google.common.flogger.GoogleLogger;
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Future;
 import java.util.logging.Level;
-import java.util.regex.Pattern;
 import javax.annotation.concurrent.GuardedBy;
 
 /**
@@ -77,17 +75,6 @@ public class AppLogsWriter {
   static final String LOG_TRUNCATED_SUFFIX = "\n<truncated>";
   static final int LOG_TRUNCATED_SUFFIX_LENGTH = LOG_TRUNCATED_SUFFIX.length();
 
-  // This regular expression should match a leading prefix of all
-  // sensitive class names that are to be disregarded for the purposes
-  // of finding the log source location.
-  private static final String PROTECTED_LOGS_CLASSES_REGEXP =
-      "(com\\.google\\.apphosting\\.runtime\\.security"
-          + "|java\\.lang\\.reflect"
-          + "|java\\.lang\\.invoke"
-          + "|java\\.security"
-          + "|sun\\.reflect"
-          + ")\\..+";
-
   private final Object lock = new Object();
 
   private final int maxLogMessageLength;
@@ -105,8 +92,6 @@ public class AppLogsWriter {
   private Future<byte[]> currentFlush;
   @GuardedBy("lock")
   private Stopwatch stopwatch;
-  private static final Pattern PROTECTED_LOGS_CLASSES =
-      Pattern.compile(PROTECTED_LOGS_CLASSES_REGEXP);
 
   public AppLogsWriter(
       MutableUpResponse upResponse,
@@ -192,14 +177,6 @@ public void addLogRecordAndMaybeFlush(ApiProxy.LogRecord fullRecord) {
           .setTimestampUsec(record.getTimestamp())
           .setMessage(record.getMessage());
 
-      StackTraceElement frame = stackFrameFor(record.getStackFrame(), record.getSourceLocation());
-      if (frame != null) {
-        SourceLocation sourceLocation = getSourceLocationProto(frame);
-        if (sourceLocation != null) {
-          logLineBuilder.setSourceLocation(sourceLocation);
-        }
-      }
-
       appLogLines.add(logLineBuilder.build());
     }
 
@@ -228,7 +205,8 @@ private void addLogLinesAndMaybeFlush(Iterable<AppLogLine> appLogLines) {
       currentByteCount += serializedSize;
     }
 
-    if (maxSecondsBetweenFlush > 0 && stopwatch.elapsed().getSeconds() >= maxSecondsBetweenFlush) {
+    if (maxSecondsBetweenFlush > 0
+        && stopwatch.elapsed().compareTo(Duration.ofSeconds(maxSecondsBetweenFlush)) >= 0) {
       waitForCurrentFlushAndStartNewFlush();
     }
   }
@@ -398,69 +376,6 @@ long getByteCountBeforeFlushing() {
     return maxBytesToFlush;
   }
 
-  /**
-   * Converts the stack trace stored in the Throwable into a SourceLocation
-   * proto. Heuristics are applied to strip out non user code, such as the App
-   * Engine logging infrastructure, and the servlet engine. Heuristics are also
-   * employed to convert class paths into file names.
-   */
-  @VisibleForTesting
-  SourceLocation getSourceLocationProto(StackTraceElement sourceLocationFrame) {
-    if (sourceLocationFrame == null || sourceLocationFrame.getFileName() == null) {
-      return null;
-    }
-    return SourceLocation.newBuilder()
-        .setFile(sourceLocationFrame.getFileName())
-        .setLine(sourceLocationFrame.getLineNumber())
-        .setFunctionName(
-            sourceLocationFrame.getClassName() + "." + sourceLocationFrame.getMethodName())
-        .build();
-  }
-
-  /**
-   * Rewrites the given StackTraceElement with a filename and line number found by looking through
-   * the given Throwable for a frame that has the same class and method as the input
-   * StackTraceElement. If the input frame already has source information then just return it
-   * unchanged.
-   */
-  private static StackTraceElement stackFrameFor(StackTraceElement frame, Throwable stack) {
-    if (frame == null) {
-      // No user-provided stack frame.
-      if (stack == null) {
-        return null;
-      }
-      return getTopUserStackFrame(Throwables.lazyStackTrace(stack));
-    }
-
-    // If we have a user-provided file:line, use it.
-    if (frame.getFileName() != null && frame.getLineNumber() > 0) {
-      return frame;
-    }
-
-    // We should have a Throwable given the preceding, but if for some reason we don't, avoid
-    // throwing NullPointerException.
-    if (stack == null) {
-      return null;
-    }
-
-    return findStackFrame(frame.getClassName(), frame.getMethodName(), stack);
-  }
-
-  /** Searches for the stack frame where the Throwable matches the provided class and method. */
-  static StackTraceElement findStackFrame(String className, String methodName, Throwable stack) {
-    List<StackTraceElement> stackFrames = Throwables.lazyStackTrace(stack);
-    for (StackTraceElement stackFrame : stackFrames) {
-      if (className.equals(stackFrame.getClassName())
-          && methodName.equals(stackFrame.getMethodName())) {
-        return stackFrame;
-      }
-    }
-
-    // No matching stack frame was found, return the top user frame, which should be
-    // the one that called the log method.
-    return AppLogsWriter.getTopUserStackFrame(stackFrames);
-  }
-
   /**
    * Converts from a Java Logging level to an App Engine logging level.
    * SEVERE maps to error, WARNING to warn, INFO to info, and all
@@ -484,33 +399,4 @@ public static ApiProxy.LogRecord.Level convertLogLevel(Level level) {
     }
   }
 
-  /**
-   * Analyzes a stack trace and returns the topmost frame that contains user
-   * code, so as to filter out App Engine logging and servlet infrastructure
-   * and just return frames relevant to user code.
-   */
-  public static StackTraceElement getTopUserStackFrame(List<StackTraceElement> stack) {
-    // Find the top-most stack frame in code that belongs to the user.
-    boolean loggerFrameEncountered = false; // Set on the first java.util.logging.Logger frame
-    for (StackTraceElement element : stack) {
-      if (isLoggerFrame(element.getClassName())) {
-        loggerFrameEncountered = true;
-      } else if (loggerFrameEncountered) {
-        // Skip protected frames, e.g., mirrors.
-        if (!isProtectedFrame(element.getClassName())) {
-          return element;
-        }
-      }
-    }
-    return null;
-  }
-
-  private static boolean isLoggerFrame(String cname) {
-    return cname.equals("java.util.logging.Logger")
-        || cname.equals("com.google.devtools.cdbg.debuglets.java.GaeDynamicLogHelper");
-  }
-
-  private static boolean isProtectedFrame(String cname) {
-    return PROTECTED_LOGS_CLASSES.matcher(cname).lookingAt();
-  }
 }

runtime/impl/src/main/java/com/google/apphosting/runtime/AppLogsWriter.java

@@ -33,7 +33,6 @@
 /** A log handler that publishes log messages in a json format. */
 public final class JsonLogHandler extends LogHandler {
   private static final String TRACE_KEY = "\"logging.googleapis.com/trace\": ";
-  private static final String SOURCE_LOCATION_KEY = "\"logging.googleapis.com/sourceLocation\": ";
   private static final String SPAN_KEY = "\"logging.googleapis.com/spanId\": ";
   private static final String DEBUG = "DEBUG";
   private static final String INFO = "INFO";
@@ -75,7 +74,6 @@ public void publish(LogRecord record) {
     appendTraceId(json);
     appendSpanId(json);
     appendSeverity(json, record);
-    appendSourceLocation(json, record);
     appendMessage(json, record); // must be last, see appendMessage
     json.append("}");
     // We must output the log all at once (should only call println once per call to publish)
@@ -135,24 +133,6 @@ private static void appendSeverity(StringBuilder json, LogRecord record) {
     json.append("\"severity\": \"").append(levelToSeverity(record.getLevel())).append("\", ");
   }
 
-  private static void appendSourceLocation(StringBuilder json, LogRecord record) {
-    if (record.getSourceClassName() != null && record.getSourceMethodName() != null) {
-      StackTraceElement stackFrame =
-          AppLogsWriter.findStackFrame(
-              record.getSourceClassName(), record.getSourceMethodName(), new Throwable());
-      String function = '"' + stackFrame.getClassName() + "." + stackFrame.getMethodName() + '"';
-      json.append(SOURCE_LOCATION_KEY)
-          .append('{')
-          .append("\"function\": ")
-          .append(function)
-          .append(", \"file\": \"")
-          .append(stackFrame.getFileName())
-          .append("\", \"line\": \"")
-          .append(stackFrame.getLineNumber())
-          .append("\"}, ");
-    }
-  }
-
   private static String levelToSeverity(Level level) {
     int intLevel = (level == null) ? 0 : level.intValue();
     switch (intLevel) {

runtime/impl/src/main/java/com/google/apphosting/runtime/JsonLogHandler.java

@@ -55,22 +55,10 @@ public void publish(LogRecord record) {
     }
   }
 
-  private boolean logSourceLocationFor(LogRecord record) {
-    // It is completely possible for the class or method name to be null, especially if the
-    // LogRecord came from the form of Logger.logp that has explicit class and method name params.
-    return record.getSourceClassName() != null && record.getSourceMethodName() != null;
-  }
-
   private ApiProxy.LogRecord convertLogRecord(LogRecord record, String message) {
     ApiProxy.LogRecord.Level level = AppLogsWriter.convertLogLevel(record.getLevel());
     long timestamp = record.getMillis() * 1000;
-    if (logSourceLocationFor(record)) {
-      StackTraceElement stackFrame = new StackTraceElement(
-          record.getSourceClassName(), record.getSourceMethodName(), null, -1);
-      return new ApiProxy.LogRecord(level, timestamp, message, stackFrame);
-    } else {
-      return new ApiProxy.LogRecord(level, timestamp, message);
-    }
+    return new ApiProxy.LogRecord(level, timestamp, message);
   }
 
   @Override