C++ Agent Parameter Reference Table
SeaLights C++ Agent β Configuration Parameters Reference
A concise lookup table for every configuration parameter and the ways you can provide it.
Table Legend
Column Definitions
Timing - At which phase in the workflow can the parameter be configured
Usage Mode - In which agent usage mode the parameter can be used
Timing Values
π§ Config - Typically set during
SL.Agent.Cpp configcommandπ§β‘ Either - Can be set during config or runtime (commonly deferred for deployment flexibility)
Usage Mode Values
Coverage Listener Mode (AUT) - Used when instrumenting applications to collect coverage data
Test Runner Mode - Used when instrumenting test frameworks to collect test execution details
Both - Used in either operating mode
Authentication token
π§β‘ Either
Both
β
--token | --tokenFile
SL_TOKEN | SL_TOKENFILE
Raw token or path to token file (required)
β
Build session ID
π§ Config
Both
β
--buildSessionId | --buildSessionIdFile
SL_BUILDSESSIONID| SL_BUILDSESSIONFILE
Build-session identifier
β
Application name
π§ Config
Coverage Listener Mode (AUT)
appName
--appName
SL_APPNAME
Display name in Sealights
β
Build name
π§ Config
Coverage Listener Mode (AUT)
buildName
--buildName
SL_BUILDNAME
Build identifier (auto-generated if omitted)
β
Branch name
π§ Config
Coverage Listener Mode (AUT)
branchName
--branchName
SL_BRANCHNAME
Git branch for build
Unspecified
Proxy URL
π§β‘ Either
Both
proxyUrl
--proxy-url | --proxy
SEALIGHTS_PROXY_URL
HTTP/HTTPS proxy
β
Collector URL
π§β‘ Either
Both
collectorUrl
--collector-url | --collector | -c
SEALIGHTS_COLLECTOR_URL
Override backend collector
β
Packages included
π§ Config
Coverage Listener Mode (AUT)
include
--include
SL_INCLUDE
Globs of C++ packages to instrument
β
Packages excluded
π§ Config
Coverage Listener Mode (AUT)
exclude
--exclude
SL_EXCLUDE
Packages to skip
β
Logging enabled
π§β‘ Either
Both
loggingEnables
--loggingEnabled
SL_LOGGING_ENABLED
Boolean
false
Log level
π§β‘ Either
Both
logLevel
--logLevel
SL_LOGLEVEL
silent | debug | info | warn | error
info
Log directory
π§β‘ Either
Both
logDir
--logDir
SL_LogDir
Folder where the logs will be saved
Lab ID
π§β‘ Either
Both
labId
--labId
SL_LABID
Group related executions
Test stage
π§β‘ Either
Both
testStage
--test-stage
SL_TEST_STAGE
Stage name shown in UI
Test Listener Session ID
π§β‘ Either
Both
testListenerSessionKey
--testListenerSessionKey
Agent address
agentAddress
--agentAddress
SL_AGENT_ADDRESS
If the AUT and the Test Runner are on different machines, enter the IP of the Test Runner machine
Agent port
agentPort
--agentPort
SL_AGENT_PORT
Port of the Test Runner machine
Bin directory
π§ Config
Coverage Listener Mode (AUT)
binDir
--binDir
SL_BINDIR
Path to the source folder
A blank βConfig File keyβ means that particular parameter cannot be set inside settings.json; use flags or env vars instead.
Parameters That Can Be Deferred to Runtime
In the above table, the parameters with a "Timing" value of "Either" do not need to be set during SL.Agent.Cpp config command; they can be set later at runtime using environment variables.
These parameters are optional during the config phase
They can be set during config if desired, but it's not required
They have the flexibility to be set at runtime via environment variables instead
Last updated
Was this helpful?

