server/status: add NodeStatus.{Args,Env}

Add the COCKROACH_* and GO* env vars and the command line flags to
NodeStatus so that they will be collected by the debug zip command.

Fixes #14065

pkg/server/status/recorder.go

@@ -20,6 +20,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
+	"os"
 	"strconv"
 
 	"golang.org/x/net/context"
@@ -30,6 +31,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/roachpb"
 	"github.com/cockroachdb/cockroach/pkg/storage/engine/enginepb"
 	"github.com/cockroachdb/cockroach/pkg/ts/tspb"
+	"github.com/cockroachdb/cockroach/pkg/util/envutil"
 	"github.com/cockroachdb/cockroach/pkg/util/hlc"
 	"github.com/cockroachdb/cockroach/pkg/util/log"
 	"github.com/cockroachdb/cockroach/pkg/util/metric"
@@ -261,6 +263,8 @@ func (mr *MetricsRecorder) GetStatusSummary() *NodeStatus {
 		StartedAt:     mr.mu.startedAt,
 		StoreStatuses: make([]StoreStatus, 0, mr.mu.lastSummaryCount),
 		Metrics:       make(map[string]float64, mr.mu.lastNodeMetricCount),
+		Args:          os.Args,
+		Env:           envutil.GetEnvVarsUsed(),
 	}
 
 	eachRecordableValue(mr.mu.nodeRegistry, func(name string, val float64) {

pkg/server/status/recorder_test.go

@@ -17,6 +17,7 @@
 package status
 
 import (
+	"os"
 	"reflect"
 	"sort"
 	"strconv"
@@ -331,13 +332,27 @@ func TestMetricsRecorder(t *testing.T) {
 		},
 	}
 
+	// Make sure there is at least one environment variable that will be
+	// reported.
+	if err := os.Setenv("GOGC", "100"); err != nil {
+		t.Fatal(err)
+	}
+
 	nodeSummary := recorder.GetStatusSummary()
 	if nodeSummary == nil {
 		t.Fatalf("recorder did not return nodeSummary")
 	}
+	if len(nodeSummary.Args) == 0 {
+		t.Fatalf("expected args to be present")
+	}
+	if len(nodeSummary.Env) == 0 {
+		t.Fatalf("expected env to be present")
+	}
+	nodeSummary.Args = nil
+	nodeSummary.Env = nil
 
 	sort.Sort(byStoreDescID(nodeSummary.StoreStatuses))
 	if a, e := nodeSummary, expectedNodeSummary; !reflect.DeepEqual(a, e) {
-		t.Errorf("recorder did not produce expected NodeSummary; diff:\n %v", pretty.Diff(e, a))
+		t.Errorf("recorder did not produce expected NodeSummary; diff:\n %s", pretty.Diff(e, a))
 	}
 }

pkg/server/status/status.proto

@@ -36,5 +36,7 @@ message NodeStatus {
   optional int64 updated_at = 4 [(gogoproto.nullable) = false];
   map<string, double> metrics = 5;
   repeated StoreStatus store_statuses = 6 [(gogoproto.nullable) = false];
+  repeated string args = 7 [(gogoproto.nullable) = false];
+  repeated string env = 8 [(gogoproto.nullable) = false];
 }
 

pkg/ui/app/js/protos.js

@@ -3519,6 +3519,24 @@ module.exports = require("protobufjs").newBuilder({})['import']({
                                             "options": {
                                                 "(gogoproto.nullable)": false
                                             }
+                                        },
+                                        {
+                                            "rule": "repeated",
+                                            "type": "string",
+                                            "name": "args",
+                                            "id": 7,
+                                            "options": {
+                                                "(gogoproto.nullable)": false
+                                            }
+                                        },
+                                        {
+                                            "rule": "repeated",
+                                            "type": "string",
+                                            "name": "env",
+                                            "id": 8,
+                                            "options": {
+                                                "(gogoproto.nullable)": false
+                                            }
                                         }
                                     ]
                                 }

pkg/ui/generated/protos.d.ts

@@ -6239,6 +6239,24 @@ getStoreStatuses?() : StoreStatus[];
 
 
 
+args?: string[];
+
+
+getArgs?() : string[];
+		setArgs?(args : string[]): void;
+
+
+
+
+env?: string[];
+
+
+getEnv?() : string[];
+		setEnv?(env : string[]): void;
+
+
+
+
 }
 
 	export interface NodeStatusMessage extends NodeStatus {

pkg/ui/generated/protos.json

@@ -3518,6 +3518,24 @@
                                             "options": {
                                                 "(gogoproto.nullable)": false
                                             }
+                                        },
+                                        {
+                                            "rule": "repeated",
+                                            "type": "string",
+                                            "name": "args",
+                                            "id": 7,
+                                            "options": {
+                                                "(gogoproto.nullable)": false
+                                            }
+                                        },
+                                        {
+                                            "rule": "repeated",
+                                            "type": "string",
+                                            "name": "env",
+                                            "id": 8,
+                                            "options": {
+                                                "(gogoproto.nullable)": false
+                                            }
                                         }
                                     ]
                                 }

pkg/util/envutil/env.go

@@ -121,7 +121,13 @@ func GetEnvVarsUsed() []string {
 	var vars []string
 	for k, v := range envVarRegistry.cache {
 		if v.present {
-			vars = append(vars, k)
+			vars = append(vars, k+"="+os.Getenv(k))
+		}
+	}
+
+	for _, name := range []string{"GOGC", "GODEBUG", "GOMAXPROCS", "GOTRACEBACK"} {
+		if val, ok := os.LookupEnv(name); ok {
+			vars = append(vars, name+"="+val)
 		}
 	}
 	return vars