Switch to enabling/disabling runtime state writing to a hard-coded path.

Author: maru-ava

config/config.go

@@ -1295,6 +1295,14 @@ func getPluginDir(v *viper.Viper) (string, error) {
 	return pluginDir, nil
 }
 
+// GetRuntimeStatePath returns the path that the node's runtime state
+// (including PID, API URI, boostrap address) will be written to if
+// --write-runtime-state-enabled is set to true. Exported to support
+// local network orchestration.
+func GetRuntimeStatePath(baseDataDir string) string {
+	return filepath.Join(baseDataDir, "runtime.json")
+}
+
 func GetNodeConfig(v *viper.Viper) (node.Config, error) {
 	var (
 		nodeConfig node.Config
@@ -1495,7 +1503,8 @@ func GetNodeConfig(v *viper.Viper) (node.Config, error) {
 
 	nodeConfig.ChainDataDir = GetExpandedArg(v, ChainDataDirKey)
 
-	nodeConfig.RuntimeStatePath = v.GetString(RuntimeStatePathKey)
+	nodeConfig.WriteRuntimeStateEnabled = v.GetBool(WriteRuntimeStateEnabledKey)
+	nodeConfig.RuntimeStatePath = GetRuntimeStatePath(v.GetString(DataDirKey))
 
 	nodeConfig.ProvidedFlags = providedFlags(v)
 	return nodeConfig, nil

config/flags.go

@@ -389,7 +389,7 @@ func addNodeFlags(fs *pflag.FlagSet) {
 	fs.StringToString(TracingHeadersKey, map[string]string{}, "The headers to provide the trace indexer")
 	// TODO add flag to take in headers to send from exporter
 
-	fs.String(RuntimeStatePathKey, "", "The path to write runtime state to (including uri, bootstrap address and pid). If empty, runtime state will not be written.")
+	fs.Bool(WriteRuntimeStateEnabledKey, false, "Whether to write runtime state (including PID, API URI, and boostrap address) to [base-data-dir]/runtime.json. If false (the default), runtime state will not be written.")
 }
 
 // BuildFlagSet returns a complete set of flags for avalanchego

config/keys.go

@@ -219,5 +219,5 @@ const (
 	TracingSampleRateKey                               = "tracing-sample-rate"
 	TracingExporterTypeKey                             = "tracing-exporter-type"
 	TracingHeadersKey                                  = "tracing-headers"
-	RuntimeStatePathKey                                = "runtime-state-path"
+	WriteRuntimeStateEnabledKey                        = "write-runtime-state-enabled"
 )

node/config.go

@@ -234,7 +234,12 @@ type Config struct {
 	// write arbitrary data.
 	ChainDataDir string `json:"chainDataDir"`
 
-	// Path to write runtime state to (including uri, bootstrap
-	// address and pid). If empty, runtime state will not be written.
+	// Whether to write runtime state (including PID, API URI and
+	// bootstrap address) to the default path of
+	// [base-data-dir]/runtime.json. If false, runtime state will not
+	// be written.
+	WriteRuntimeStateEnabled bool `json:"writeRuntimeStateEnabled"`
+
+	// The path to write runtime state to.
 	RuntimeStatePath string `json:"runtimeStatePath"`
 }

node/node.go

@@ -397,7 +397,7 @@ type NodeRuntimeState struct {
 // Write runtime state to the configured path. Supports the use of
 // dynamically chosen network ports with local network orchestration.
 func (n *Node) writeRuntimeState() {
-	n.Log.Info("attempting to write runtime state to configured path", zap.String("path", n.Config.RuntimeStatePath))
+	n.Log.Info("attempting to write runtime state", zap.String("path", n.Config.RuntimeStatePath))
 
 	uri := ""
 
@@ -463,7 +463,7 @@ func (n *Node) Dispatch() error {
 		n.Shutdown(1)
 	})
 
-	if len(n.Config.RuntimeStatePath) > 0 {
+	if n.Config.WriteRuntimeStateEnabled {
 		go n.writeRuntimeState()
 	}
 
@@ -497,8 +497,9 @@ func (n *Node) Dispatch() error {
 	// Wait until the node is done shutting down before returning
 	n.DoneShuttingDown.Wait()
 
-	if len(n.Config.RuntimeStatePath) > 0 {
-		// Attempt to remove the runtime state path
+	if n.Config.WriteRuntimeStateEnabled {
+		// Attempt to remove the runtime state path to communicate to an
+		// orchestrator that the node is no longer running.
 		if err := os.Remove(n.Config.RuntimeStatePath); err != nil && !os.IsNotExist(err) {
 			n.Log.Error("removal of runtime state file failed",
 				zap.String("path", n.Config.RuntimeStatePath),