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.

chevron-rightTable Legendhashtag

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 config command

  • πŸ”§βš‘ 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

Parameter
Timing
Usage Mode
Config File key
CLI Flags
Environment Variables
Description
Default

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

circle-info

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.

  1. These parameters are optional during the config phase

  2. They can be set during config if desired, but it's not required

  3. They have the flexibility to be set at runtime via environment variables instead

Last updated

Was this helpful?