gridopadesham

An end-to-end documentation on Grid

View the Project on GitHub

Image Courtesy: Boloji.com

«Back Home

Configuration parameters for the Hub

To see the documentation related to the Selenium Hub, run :

java -jar selenium-server-standalone-3.141.59.jar -role hub -help

You should see something like below :

Usage: <main class> [options]
  Options:
    --debug, -debug
      <Boolean> : enables LogLevel.FINE.
      Default: false
    --version, -version
      Displays the version and exits.
      Default: false
    -browserTimeout
      <Integer> in seconds : number of seconds a browser session is allowed to
      hang while a WebDriver command is running (example: driver.get(url)). If
      the timeout is reached while a WebDriver command is still processing,
      the session will quit. Minimum value is 60. An unspecified, zero, or
      negative value means wait indefinitely. If a node does not specify it,
      the hub value will be used.
    -matcher, -capabilityMatcher
      <String> class name : a class implementing the CapabilityMatcher
      interface. Specifies the logic the hub will follow to define whether a
      request can be assigned to a node. For example, if you want to have the
      matching process use regular expressions instead of exact match when
      specifying browser version. ALL nodes of a grid ecosystem would then use
      the same capabilityMatcher, as defined here.
    -cleanUpCycle
      <Integer> in ms : specifies how often the hub will poll running proxies
      for timed-out (i.e. hung) threads. Must also specify "timeout" option
    -custom
      <String> : comma separated key=value pairs for custom grid extensions.
      NOT RECOMMENDED -- may be deprecated in a future revision. Example:
      -custom myParamA=Value1,myParamB=Value2
    -host
      <String> IP or hostname : usually determined automatically. Most
      commonly useful in exotic network configurations (e.g. network with VPN)
    -hubConfig
      <String> filename: a JSON file (following grid2 format), which defines
      the hub properties
    -jettyThreads, -jettyMaxThreads
      <Integer> : max number of threads for Jetty. An unspecified, zero, or
      negative value means the Jetty default value (200) will be used.
    -log
      <String> filename : the filename to use for logging. If omitted, will
      log to STDOUT
    -maxSession
      <Integer> max number of tests that can run at the same time on the node,
      irrespective of the browser used
    -newSessionWaitTimeout
      <Integer> in ms : The time after which a new test waiting for a node to
      become available will time out. When that happens, the test will throw
      an exception before attempting to start a browser. An unspecified, zero,
      or negative value means wait indefinitely.
    -port
      <Integer> : the port number the server will use.
    -prioritizer
      <String> class name : a class implementing the Prioritizer interface.
      Specify a custom Prioritizer if you want to sort the order in which new
      session requests are processed when there is a queue. Default to null (
      no priority = FIFO )
    -registry
      <String> class name : a class implementing the GridRegistry interface.
      Specifies the registry the hub will use.
    -role
      <String> options are [hub], [node], or [standalone].
    -servlet, -servlets
      <String> : list of extra servlets the grid (hub or node) will make
      available. Specify multiple on the command line: -servlet
      tld.company.ServletA -servlet tld.company.ServletB. The servlet must
      exist in the path: /grid/admin/ServletA /grid/admin/ServletB
    -timeout, -sessionTimeout
      <Integer> in seconds : Specifies the timeout before the server
      automatically kills a session that hasn't had any activity in the last X
      seconds. The test slot will then be released for another test to use.
      This is typically used to take care of client crashes. For grid hub/node
      roles, cleanUpCycle must also be set. If a node does not specify it, the
      hub value will be used.
    -throwOnCapabilityNotPresent
      <Boolean> true or false : If true, the hub will reject all test requests
      if no compatible proxy is currently registered. If set to false, the
      request will queue until a node supporting the capability is registered
      with the grid.
    -withoutServlet, -withoutServlets
      <String> : list of default (hub or node) servlets to disable. Advanced
      use cases only. Not all default servlets can be disabled. Specify
      multiple on the command line: -withoutServlet tld.company.ServletA
      -withoutServlet tld.company.ServletB

«Back Home