Restarting a Listening Tentacle on Windows results in a port is already in use error.

[nathanwoctopusdeploy]

Team

• I've assigned a team label to this issue

What happened?

When a Windows Listening Tentacle is restarted, it may fail to free up the port being used for incoming requests. This can result in an error when trying to restart Tentacle and may result in a 1-2 minute period where Tentacle cannot start.

Reproduction

Impacts versions 8.0.0 to 8.1.61

Error and Stacktrace

2023-12-01 04:00:02.6299   3692      9  INFO  ==== RunAgentCommand ====
2023-12-01 04:00:02.6299   3692      9  INFO  CommandLine: C:\Tentacle\PFiles\Octopus Deploy\Tentacle\Tentacle.dll run --instance=Tentacle
2023-12-01 04:00:02.8534   3692      9 ERROR  A required communications port is already in use. The required port is being used by another process. The Windows `netstat -o -n -a` command can be used to show which process this is (compare PIDs with those shown in Task Manager). See: http://g.octopushq.com/HttpPortInUse
System.Net.Sockets.SocketException (10048): Only one usage of each socket address (protocol/network address/port) is normally permitted.
   at System.Net.Sockets.Socket.UpdateStatusAfterSocketErrorAndThrowException(SocketError error, String callerName)
   at System.Net.Sockets.Socket.DoBind(EndPoint endPointSnapshot, SocketAddress socketAddress)
   at System.Net.Sockets.Socket.Bind(EndPoint localEP)
   at System.Net.Sockets.TcpListener.Start(Int32 backlog)
   at System.Net.Sockets.TcpListener.Start()
   at Halibut.Transport.SecureListener.Start()
   at Halibut.HalibutRuntime.Listen(IPEndPoint endpoint)
   at Octopus.Tentacle.Communications.HalibutInitializer.Start() in C:\BuildAgent\work\cce1880bf18fcb0c\source\Octopus.Tentacle\Communications\HalibutInitializer.cs:line 47
   at Octopus.Tentacle.Commands.RunAgentCommand.Start() in C:\BuildAgent\work\cce1880bf18fcb0c\source\Octopus.Tentacle\Commands\RunAgentCommand.cs:line 126
   at Octopus.Tentacle.Startup.AbstractCommand.Start(String[] commandLineArguments, ICommandRuntime commandRuntime, OptionSet commonOptions) in C:\BuildAgent\work\cce1880bf18fcb0c\source\Octopus.Tentacle\Startup\AbstractCommand.cs:line 79
   at Octopus.Tentacle.Startup.OctopusProgram.Start(ICommandRuntime commandRuntime) in C:\BuildAgent\work\cce1880bf18fcb0c\source\Octopus.Tentacle\Startup\OctopusProgram.cs:line 544
   at Octopus.Tentacle.Startup.WindowsServiceHost.<>c__DisplayClass2_0.<Run>b__0() in C:\BuildAgent\work\cce1880bf18fcb0c\source\Octopus.Tentacle\Startup\WindowsServiceHost.cs:line 23
   at Octopus.Tentacle.Startup.WindowsServiceAdapter.RunService() in C:\BuildAgent\work\cce1880bf18fcb0c\source\Octopus.Tentacle\Startup\WindowsServiceAdapter.cs:line 44
2023-12-01 04:00:02.9371   3876      1  INFO  Waiting for service to become Running. Current status: Running
2023-12-01 04:00:03.0513   3692      9 FATAL  Unhandled AppDomain exception occurred: A required communications port is already in use. The required port is being used by another process. The Windows `netstat -o -n -a` command can be used to show which process this is (compare PIDs with those shown in Task Manager). See: http://g.octopushq.com/HttpPortInUse
System.Exception
   at Octopus.Tentacle.Startup.WindowsServiceAdapter.RunService() in WindowsServiceAdapter.cs:line 52
   at System.Threading.Thread.StartCallback()

--Inner Exception--
Only one usage of each socket address (protocol/network address/port) is normally permitted.
System.Net.Sockets.SocketException
   at System.Net.Sockets.Socket.UpdateStatusAfterSocketErrorAndThrowException(SocketError error, String callerName)
   at System.Net.Sockets.Socket.DoBind(EndPoint endPointSnapshot, SocketAddress socketAddress)
   at System.Net.Sockets.Socket.Bind(EndPoint localEP)
   at System.Net.Sockets.TcpListener.Start(Int32 backlog)
   at System.Net.Sockets.TcpListener.Start()
   at Halibut.Transport.SecureListener.Start()
   at Halibut.HalibutRuntime.Listen(IPEndPoint endpoint)
   at Octopus.Tentacle.Communications.HalibutInitializer.Start() in HalibutInitializer.cs:line 47
   at Octopus.Tentacle.Commands.RunAgentCommand.Start() in RunAgentCommand.cs:line 126
   at Octopus.Tentacle.Startup.AbstractCommand.Start(String[] commandLineArguments, ICommandRuntime commandRuntime, OptionSet commonOptions) in AbstractCommand.cs:line 79
   at Octopus.Tentacle.Startup.OctopusProgram.Start(ICommandRuntime commandRuntime) in OctopusProgram.cs:line 544
   at Octopus.Tentacle.Startup.WindowsServiceHost.<>c__DisplayClass2_0.<Run>b__0() in WindowsServiceHost.cs:line 23
   at Octopus.Tentacle.Startup.WindowsServiceAdapter.RunService() in WindowsServiceAdapter.cs:line 44
System.Exception: A required communications port is already in use. The required port is being used by another process. The Windows `netstat -o -n -a` command can be used to show which process this is (compare PIDs with those shown in Task Manager). See: http://g.octopushq.com/HttpPortInUse
 ---> System.Net.Sockets.SocketException (10048): Only one usage of each socket address (protocol/network address/port) is normally permitted.
   at System.Net.Sockets.Socket.UpdateStatusAfterSocketErrorAndThrowException(SocketError error, String callerName)
   at System.Net.Sockets.Socket.DoBind(EndPoint endPointSnapshot, SocketAddress socketAddress)
   at System.Net.Sockets.Socket.Bind(EndPoint localEP)
   at System.Net.Sockets.TcpListener.Start(Int32 backlog)
   at System.Net.Sockets.TcpListener.Start()
   at Halibut.Transport.SecureListener.Start()
   at Halibut.HalibutRuntime.Listen(IPEndPoint endpoint)
   at Octopus.Tentacle.Communications.HalibutInitializer.Start() in C:\BuildAgent\work\cce1880bf18fcb0c\source\Octopus.Tentacle\Communications\HalibutInitializer.cs:line 47
   at Octopus.Tentacle.Commands.RunAgentCommand.Start() in C:\BuildAgent\work\cce1880bf18fcb0c\source\Octopus.Tentacle\Commands\RunAgentCommand.cs:line 126
   at Octopus.Tentacle.Startup.AbstractCommand.Start(String[] commandLineArguments, ICommandRuntime commandRuntime, OptionSet commonOptions) in C:\BuildAgent\work\cce1880bf18fcb0c\source\Octopus.Tentacle\Startup\AbstractCommand.cs:line 79
   at Octopus.Tentacle.Startup.OctopusProgram.Start(ICommandRuntime commandRuntime) in C:\BuildAgent\work\cce1880bf18fcb0c\source\Octopus.Tentacle\Startup\OctopusProgram.cs:line 544
   at Octopus.Tentacle.Startup.WindowsServiceHost.<>c__DisplayClass2_0.<Run>b__0() in C:\BuildAgent\work\cce1880bf18fcb0c\source\Octopus.Tentacle\Startup\WindowsServiceHost.cs:line 23
   at Octopus.Tentacle.Startup.WindowsServiceAdapter.RunService() in C:\BuildAgent\work\cce1880bf18fcb0c\source\Octopus.Tentacle\Startup\WindowsServiceAdapter.cs:line 44
   --- End of inner exception stack trace ---
   at Octopus.Tentacle.Startup.WindowsServiceAdapter.RunService() in C:\BuildAgent\work\cce1880bf18fcb0c\source\Octopus.Tentacle\Startup\WindowsServiceAdapter.cs:line 52
   at System.Threading.Thread.StartCallback()
2023-12-01 04:00:03.2495   3876      1  INFO  Service started
2023-12-01 04:00:56.1878   1312      1  INFO

More Information

No response

Workaround

Wait for 1-2 minutes and then restart Tentacle

[octoreleasebot]

Release Note: Fix an issue where restarting a Windows Listening Tentacle may not free up the listening port