#66: Disable UDP logging feature by default because it's experimental.

sevensolutions · Aug 23, 2024 · ec6b4cd · ec6b4cd
1 parent 5bc8aca
commit ec6b4cd
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 6 deletions.
diff --git a/src/NomadIIS/Properties/launchSettings.json b/src/NomadIIS/Properties/launchSettings.json
@@ -10,16 +10,16 @@
 		},
 		"Nomad (Dev)": {
 			"commandName": "Executable",
-			"executablePath": "../../../../../nomad/nomad.exe",
-			"commandLineArgs": "agent -dev -config=../../../../../examples/agent.dev.hcl -plugin-dir=$(MSBuildProjectDirectory)\\bin\\Debug\\net8.0",
+			"executablePath": "$(MSBuildProjectDirectory)\\..\\..\\nomad\\nomad.exe",
+			"commandLineArgs": "agent -dev -config=$(MSBuildProjectDirectory)\\..\\..\\examples\\agent.dev.hcl -plugin-dir=$(MSBuildProjectDirectory)\\bin\\Debug\\net8.0",
 			"environmentVariables": {
 				"ASPNETCORE_ENVIRONMENT": "Development"
 			}
 		},
 		"Nomad": {
 			"commandName": "Executable",
 			"executablePath": "$(MSBuildProjectDirectory)\\..\\..\\nomad\\nomad.exe",
-			"commandLineArgs": "agent -config=$(MSBuildProjectDirectory)\\..\\..\\examples\\agent.hcl -data-dir=$(MSBuildProjectDirectory)\\..\\..\\nomad\\data -plugin-dir=$(MSBuildProjectDirectory)\\bin\\Debug\\net8.0",
+			"commandLineArgs": "agent -config=$(MSBuildProjectDirectory)\\..\\..\\examples\\agent.hcl -plugin-dir=$(MSBuildProjectDirectory)\\bin\\Debug\\net8.0 -data-dir=$(MSBuildProjectDirectory)\\..\\..\\nomad\\data",
 			"environmentVariables": {
 				"ASPNETCORE_ENVIRONMENT": "Development"
 			}

diff --git a/src/NomadIIS/Services/Configuration/DriverConfig.cs b/src/NomadIIS/Services/Configuration/DriverConfig.cs
@@ -21,7 +21,7 @@ public sealed class DriverConfig
 	[ConfigurationField( "allowed_target_websites" )]
 	public string[]? AllowedTargetWebsites { get; set; }
 
-	[DefaultValue( 64001 )]
+	[DefaultValue( 0 )]
 	[ConfigurationField( "udp_logger_port" )]
-	public int? UdpLoggerPort { get; set; } = 64001;
+	public int? UdpLoggerPort { get; set; } = 0;
 }
diff --git a/website/docs/features/udp-logging.md b/website/docs/features/udp-logging.md
@@ -6,6 +6,7 @@ sidebar_position: 6
 
 :::caution
 This feature is considered experimental and not very well tested yet.
+It needs to be [enabled](../getting-started/driver-configuration.md) by specifying a port at `udp_logger_port`.
 :::
 
 Unfortunately, IIS doesn't attach a Console to the *w3wp* processes and therefore *STDOUT* and *STDERR* streams are not available.

diff --git a/website/docs/getting-started/driver-configuration.md b/website/docs/getting-started/driver-configuration.md
@@ -10,7 +10,7 @@ sidebar_position: 4
 | fingerprint_interval | string | no | 30s | Defines the interval how often the plugin should report the driver's fingerprint to Nomad. The smallest possible value is 10s. |
 | directory_security | bool | no | true | Enables Directory Permission Management for [Filesystem Isolation](../features/filesystem-isolation.md). |
 | allowed_target_websites | string[] | no | *none* | A list of IIS websites which are allowed to be used as [target_website](../features/existing-website.md). An asterisk (*\**) may be used as a wildcard to allow any website. |
-| udp_logger_port | number | no | 64001 | The local UDP port where the driver is listening for log-events which will be shipped to the Nomad client. The value 0 will disable this feature. Please read the details [here](../features/udp-logging.md). |
+| udp_logger_port | number | no | 0 | The local UDP port where the driver is listening for log-events which will be shipped to the Nomad client. The value 0 will disable this feature. Please read the details [here](../features/udp-logging.md). |
 
 **Example**