address review

Author: gregns1

base/constants.go

@@ -157,7 +157,7 @@ const (
 	FromConnStrWarningThreshold = 10 * time.Second
 
 	// StackFilePrefix is the prefix used when writing stack trace files
-	StackFilePrefix = "sg_stack_trace_"
+	StackFilePrefix = "sg_goroutines_"
 )
 
 // SyncGatewayRawDocXattrs is a list of xattrs that Sync Gateway will fetch when reading a raw document.

base/util.go

@@ -1842,9 +1842,9 @@ func GetStackTrace() (bytes.Buffer, error) {
 	return profBuf, err
 }
 
-// RotateProfilesIfNeeded will remove old files if there are more than
+// RotateFilenamesIfNeeded will remove old files if there are more than
 // 10 matching the given filename pattern.
-func RotateProfilesIfNeeded(filename string) error {
+func RotateFilenamesIfNeeded(filename string) error {
 	existingFiles, err := filepath.Glob(filename)
 	if err != nil {
 		return fmt.Errorf("Error listing existing profiles in %q: %w", filename, err)
@@ -1868,6 +1868,19 @@ func LogStackTraces(ctx context.Context, logDirectory string, stackTrace bytes.B
 	// log to console
 	_, _ = fmt.Fprintf(os.Stderr, "Stack trace:\n%s\n", stackTrace.String())
 
+	err := writeStackTraceFile(ctx, logDirectory, timestamp, stackTrace)
+	if err != nil {
+		return
+	}
+
+	rotatePath := filepath.Join(logDirectory, StackFilePrefix+"*.log")
+	err = RotateFilenamesIfNeeded(rotatePath)
+	if err != nil {
+		WarnfCtx(ctx, "Error rotating stack trace files in path %s: %v", rotatePath, err)
+	}
+}
+
+func writeStackTraceFile(ctx context.Context, logDirectory, timestamp string, stackTrace bytes.Buffer) error {
 	filename := filepath.Join(logDirectory, StackFilePrefix+timestamp+".log")
 	file, err := os.Create(filename)
 	defer func() {
@@ -1878,16 +1891,13 @@ func LogStackTraces(ctx context.Context, logDirectory string, stackTrace bytes.B
 	}()
 	if err != nil {
 		WarnfCtx(ctx, "Error opening stack trace file %s: %v", filename, err)
+		return err
 	}
 
 	_, err = file.WriteString(fmt.Sprintf("Stack trace:\n%s\n", stackTrace.String()))
 	if err != nil {
 		WarnfCtx(ctx, "Error writing stack trace to file %s: %v", filename, err)
+		return err
 	}
-
-	rotatePath := filepath.Join(logDirectory, StackFilePrefix+"*.log")
-	err = RotateProfilesIfNeeded(rotatePath)
-	if err != nil {
-		WarnfCtx(ctx, "Error rotating stack trace files in path %s: %v", rotatePath, err)
-	}
+	return nil
 }

rest/stats_context.go

@@ -409,5 +409,5 @@ func (statsContext *statsContext) collectMemoryProfile(ctx context.Context, outp
 
 	// rotate old profiles
 	path := filepath.Join(outputDir, pprofPrefix+"*.pb.gz")
-	return base.RotateProfilesIfNeeded(path)
+	return base.RotateFilenamesIfNeeded(path)
 }

tools-tests/sgcollect_info_test.py

@@ -81,7 +81,7 @@ def test_make_collect_logs_stacktrace(tmpdir):
             ).encode("utf-8")
         ),
     ):
-        stacktrace_file = tmpdir.join("sg_stack_trace.log")
+        stacktrace_file = tmpdir.join("sg_goroutines.log")
         stacktrace_file.write("foo")
         tasks = sgcollect.make_collect_logs_tasks(
             sg_url="fakeurl",

tools/sgcollect.py

@@ -291,7 +291,7 @@ def make_http_client_stack_trace_task(
         name="Collect stack trace via http client",
         auth_headers=auth_headers,
         url=stack_trace_url,
-        log_file="sg_stack_trace.log",
+        log_file="sg_goroutines.log",
     )
     stack_trace_task.no_header = True
 
@@ -386,7 +386,7 @@ def make_collect_logs_tasks(
         "sg_debug.log": "sg_debug.log",
         "sg_trace.log": "sg_trace.log",
         "sg_stats.log": "sg_stats.log",
-        "sg_stack_trace.log": "sg_stack_trace.log",
+        "sg_goroutines.log": "sg_goroutines.log",
         "sync_gateway_access.log": "sync_gateway_access.log",
         "sync_gateway_error.log": "sync_gateway_error.log",
         "pprof.pb": "pprof.pb",