Skip to content
Branch: master
Find file Copy path
Find file Copy path
4 contributors

Users who have contributed to this file

@oleg-nenashev @jeffret-b @Wadeck @kohsuke
140 lines (137 sloc) 5.28 KB

Remoting Configuration

Remoting can be configured via System properties. These properties require independent configuration on both sides of the channel.

Available settings

System property Default value Since Jenkins version(s) Related issues Description
hudson.remoting.ClassFilter.DEFAULTS_OVERRIDE_LOCATION null 2.53.2 1.639 SECURITY-218 The path to a file containing alternative regex patterns for remoting class filtering
hudson.remoting.FlightRecorderInputStream.BUFFER_SIZE 1048576 2.41 1.563 JENKINS-22734 Size (in bytes) of the flight recorder ring buffer used for debugging remoting issues
hudson.remoting.Launcher.pingIntervalSec 0 since 2.60, 600 before 2.0 1.367 JENKINS-35190 Seconds between ping checks to monitor health of slave nodes; 0 to disable ping
hudson.remoting.Launcher.pingTimeoutSec 240 2.0 1.367 N/A If ping of slave node takes longer than this, consider it dead; 0 to disable ping
hudson.remoting.RemoteClassLoader.force null 2.58 2.4 JENKINS-19445 (workaround) Class name String. Forces loading of the specified class name on incoming requests. Works around issues like JENKINS-19445
hudson.remoting.Engine.socketTimeout 30 minutes 2.58 2.4 JENKINS-34808 Socket read timeout in milliseconds. If timeout happens and the failOnSocketTimeoutInReader property is true, the channel will be interrupted.
hudson.remoting.SynchronousCommandTransport.failOnSocketTimeoutInReader false 2.60 TODO JENKINS-22722 Boolean flag. Enables the original aggressive behavior, when the channel reader gets interrupted by any SocketTimeoutException
hudson.remoting.ExportTable.unexportLogSize 1024 2.40 ? JENKINS-20707 Defines number of entries to be stored in the unexport history, which is being analyzed during the invalid object ID analysis.
${PROTOCOL_FULLY_QUALIFIED_NAME}.disabled, where PROTOCOL_FULLY_QUALIFIED_NAME equals PROTOCOL_HANDLER_CLASSNAME without the Handler suffix. false 2.59 2.4 JENKINS-34819 Boolean flag, which allows disabling particular protocols in remoting.

Property example: org.jenkinsci.remoting.engine.JnlpProtocol3.disabled
org.jenkinsci.remoting.nio.NioChannelHub.disabled false 2.62.3 TODO JENKINS-39290 Boolean flag to disable NIO-based socket connection handling, and switch back to classic IO. Used to isolate the problem.
org.jenkinsci.remoting.engine.JnlpAgentEndpointResolver.protocolNamesToTry false TODO TODO JENKINS-41730 If specified, only the protocols from the list will be tried during the connection. The option provides protocol names, but the order of the check is defined internally and cannot be changed.
NO_PROXY (or no_proxy) Provides specifications for hosts that should not be proxied. See the NO_PROXY Environment Variable page for details on supported specifications.
You can’t perform that action at this time.