chore: Set default log file to empty string (#28)

* Set default log file to empty string * update tests * update tests * remove from example config
DevCycleHQ · Oct 7, 2024 · 99df470 · 99df470
1 parent 59cfe86
commit 99df470
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 10 deletions.
diff --git a/config.json.example b/config.json.example
@@ -6,7 +6,7 @@
       "unixSocketEnabled": false,
       "httpEnabled": true,
       "sdkKey": "dvc_YOUR_KEY_HERE",
-      "logFile": "/var/log/devcycle.log",
+      "logFile": "",
       "platformData": {
         "sdkType": "server",
         "sdkVersion": "2.10.2",

diff --git a/options.go b/options.go
@@ -34,7 +34,7 @@ type ProxyInstance struct {
 	SSEEnabled            bool                  `json:"sseEnabled" envconfig:"SSE_ENABLED" default:"false" desc:"Whether to enable the SSE server. Requires setting sseHostname param too. Defaults to false."`
 	SSEHostname           string                `json:"sseHostname" envconfig:"SSE_HOSTNAME" desc:"The hostname to provide to clients to connect to for SSE requests. This must be reachable from the clients and can be either a DNS hostname or a raw IP address."`
 	SDKKey                string                `json:"sdkKey" required:"true" envconfig:"SDK_KEY" desc:"The Server SDK key to use for this instance."`
-	LogFile               string                `json:"logFile" default:"/var/log/devcycle.log" envconfig:"LOG_FILE" desc:"The path to the log file. Defaults to /var/log/devcycle.log"`
+	LogFile               string                `json:"logFile" default:"" envconfig:"LOG_FILE" desc:"The path to the log file."`
 	PlatformData          devcycle.PlatformData `json:"platformData" required:"true"`
 	SDKConfig             SDKConfig             `json:"sdkConfig" required:"true"`
 	dvcClient             *devcycle.Client
@@ -130,9 +130,6 @@ func (i *ProxyInstance) Default() {
 	if i.HTTPEnabled && i.HTTPPort == 0 {
 		i.HTTPPort = 8080
 	}
-	if i.LogFile == "" {
-		i.LogFile = "/var/log/devcycle.log"
-	}
 	if i.UnixSocketEnabled {
 		if i.UnixSocketPath == "" {
 			i.UnixSocketPath = "/tmp/devcycle.sock"

diff --git a/options_test.go b/options_test.go
@@ -41,7 +41,7 @@ func TestParseConfig(t *testing.T) {
 						UnixSocketEnabled:     false,
 						HTTPEnabled:           true,
 						SDKKey:                "dvc-test-key",
-						LogFile:               "/var/log/devcycle.log",
+						LogFile:               "",
 						PlatformData:          api.PlatformData{},
 						SDKConfig:             SDKConfig{},
 					},
@@ -82,7 +82,7 @@ func TestParseConfig(t *testing.T) {
 						UnixSocketPermissions: "0755",
 						HTTPEnabled:           false,
 						SDKKey:                "dvc-test-key",
-						LogFile:               "/var/log/devcycle.log",
+						LogFile:               "",
 						PlatformData: api.PlatformData{
 							SdkType:         "sdk type",
 							SdkVersion:      "v1.2.3",
@@ -124,7 +124,7 @@ func TestParseConfig(t *testing.T) {
 						UnixSocketEnabled: false,
 						HTTPEnabled:       false,
 						SDKKey:            "dvc-sample-key",
-						LogFile:           "/var/log/devcycle.log",
+						LogFile:           "",
 						PlatformData:      api.PlatformData{},
 						SDKConfig:         defaultSDKConfig,
 					},
@@ -144,7 +144,7 @@ func TestParseConfig(t *testing.T) {
 						UnixSocketEnabled: false,
 						HTTPEnabled:       false,
 						SDKKey:            "dvc-sample-key",
-						LogFile:           "/var/log/devcycle.log",
+						LogFile:           "",
 						PlatformData:      api.PlatformData{},
 						SDKConfig:         defaultSDKConfig,
 					},
@@ -163,7 +163,7 @@ func TestParseConfig(t *testing.T) {
 						UnixSocketEnabled: false,
 						HTTPEnabled:       true,
 						SDKKey:            "dvc_YOUR_KEY_HERE",
-						LogFile:           "/var/log/devcycle.log",
+						LogFile:           "",
 						SSEEnabled:        false,
 						PlatformData: api.PlatformData{
 							SdkType:         "server",