Go Agent Parameter Reference Table

SeaLights Go 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 slgoagent config command

• ⚡Runtime - Set and applied at runtime of the instrumented code (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

Best Practices

• BP Notes in Description - Used when instrumenting applications to collect coverage data

A blank “Config File key” means that particular parameter cannot be set inside .slconfig.yaml; use flags or env vars instead.

Parameter	Timing	Usage Mode	Config File Key	CLI Flags	Environment Variables	Description	Accepts/Type	Default Value
Config file	🔧Config	- Coverage Listener Mode (AUT) - Test Runner Mode	—	--config	—	YAML config file	STRING	.slconfig.yaml
Fail on error	🔧Config ⚡Runtime	- Coverage Listener Mode (AUT) - Test Runner Mode	—	--failOnError	SL_FAIL_ON_ERROR SEALIGHTS_FAIL_ON_ERROR	Exit immediately with status code 1 on any error	BOOL	false
Log level	🔧Config ⚡Runtime	- Coverage Listener Mode (AUT) - Test Runner Mode	logLevel	--logLevel	SL_LOG_LEVEL SEALIGHTS_LOG_LEVEL	Set the log level for the SL Go Agent. Must be set in build env and runtime env separately.	ENUM {none | debug | info | warn | error}	none
Log file	🔧Config	- Coverage Listener Mode (AUT) - Test Runner Mode	logFile	--logFile	SL_LOG_FILE SEALIGHTS_LOG_FILE	Path to a file to write log output to	STRING	—
Quiet	🔧Config ⚡Runtime	- Coverage Listener Mode (AUT) - Test Runner Mode	—	--quiet	SL_QUIET SEALIGHTS_QUIET	Suppress all [SeaLights] console messages on stdout	BOOL	false
Authentication token	🔧Config ⚡Runtime	- Coverage Listener Mode (AUT) - Test Runner Mode	—	--token --tokenFile	SL_TOKEN SEALIGHTS_TOKEN	Sealights authentication token or path to token file.	STRING	—
Proxy URL	🔧Config ⚡Runtime	- Coverage Listener Mode (AUT) - Test Runner Mode	proxyUrl	--proxy	SL_PROXY SEALIGHTS_PROXY SL_PROXY_URL SEALIGHTS_PROXY_URL	HTTP/HTTPS proxy server URL.	STRING	—
Collector URL	🔧Config ⚡Runtime	- Coverage Listener Mode (AUT)	collectorUrl	--collectorUrl --collector-url	SL_COLLECTOR_URL SEALIGHTS_COLLECTOR_URL	URL of the collector. Set on Lambda at runtime. BP: set at Runtime via Env Var	STRING	—
Disable token save	🔧Config	- Coverage Listener Mode (AUT)	disableTokenSave	--disableTokenSave	SL_DISABLE_TOKEN_SAVE SEALIGHTS_DISABLE_TOKEN_SAVE	Don't write token into instrumented binary. (BSID must be provided via secret as env var at runtime.)	BOOL	false
Scan directory	🔧Config	- Coverage Listener Mode (AUT) - Test Runner Mode	rootDir	--scanDir --workspacepath --root-dir	SL_SCAN_DIR SEALIGHTS_SCAN_DIR SL_ROOT_DIR SEALIGHTS_ROOT_DIR SL_WORKSPACE_PATH SEALIGHTS_WORKSPACE_PATH	The directory to scan/instrument. Used during agent configuration	STRING	./
Application name	🔧Config	- Coverage Listener Mode (AUT)	appName	--appName --app --app-name	SL_APP_NAME SEALIGHTS_APP_NAME	Application name for identification in Sealights	STRING	—
Build name	🔧Config	- Coverage Listener Mode (AUT)	build	--buildName --build	SL_BUILD_NAME SEALIGHTS_BUILD_NAME	Build identifier (auto-generated if omitted)	STRING	Auto: SL_YYYYMMDD-HHMMSS
Branch name	🔧Config	- Coverage Listener Mode (AUT)	branch	--branchName --branch	SL_BRANCH_NAME SEALIGHTS_BRANCH_NAME SL_BRANCH SEALIGHTS_BRANCH	Source code branch name for the current build	STRING	main
Go mod file	🔧Config	- Coverage Listener Mode (AUT)	goModFile	--goModFile	SL_GO_MOD_FILE SEALIGHTS_GO_MOD_FILE	Alternate go.mod location	STRING	—
Build session ID	🔧Config	- Coverage Listener Mode (AUT)	—	--buildSessionId --bsid	SL_BUILD_SESSION_ID SEALIGHTS_BUILD_SESSION_ID	Use a custom build session ID	STRING	—
Build session ID from file	🔧Config	- Coverage Listener Mode (AUT) - Test Runner Mode	—	--buildSessionIdFile --bsid-from-file	SL_BUILD_SESSION_ID_FILE SEALIGHTS_BUILD_SESSION_ID_FILE SL_BUILD_SESSION_ID_FROM_FILE SEALIGHTS_BUILD_SESSION_ID_FROM_FILE	Load build session ID from a file	STRING	—
Save build session ID to file	🔧Config	- Coverage Listener Mode (AUT)	—	--saveBsidToFile	SL_SAVE_BSID_TO_FILE SEALIGHTS_SAVE_BSID_TO_FILE	Persist the build session ID (generated during Coverage Listener config command) to a file	STRING	—
Build tags	🔧Config	- Coverage Listener Mode (AUT)	buildTags	--tags --buildTags	SL_BUILD_TAGS SEALIGHTS_BUILD_TAGS	Build tags to include for instrumentation	STRING	—
Build environment	🔧Config	- Coverage Listener Mode (AUT)	buildEnv	--buildEnv	SL_BUILD_ENV SEALIGHTS_BUILD_ENV	Extra Go environment variables required for the build	STRING	—
Packages Included	🔧Config	- Coverage Listener Mode (AUT) - Test Runner Mode	packagesIncludes	--includePackages --include --includes --packages-included	SL_INCLUDE_PACKAGES SEALIGHTS_INCLUDE_PACKAGES SL_PACKAGES_INCLUDED SEALIGHTS_PACKAGES_INCLUDED	Go packages to instrument (works on the Go package import path, not file path)	STRING	—
Packages Excluded	🔧Config	- Coverage Listener Mode (AUT) - Test Runner Mode	packagesExcludes	--excludePackages --exclude --excludes --packages-excluded	SL_EXCLUDE_PACKAGES SEALIGHTS_EXCLUDE_PACKAGES SL_PACKAGES_EXCLUDED SEALIGHTS_PACKAGES_EXCLUDED	Go packages to skip (works on the Go package import path, not file path)	STRING	—
Test runner mode	🔧Config ⚡Runtime	- Test Runner Mode	testsRunner	--testRunner --tests-runner --test-runner	SL_TEST_RUNNER SEALIGHTS_TEST_RUNNER	Run as test listener only. BP: set at Runtime via Env Var	BOOL	false
Lab ID	🔧Config ⚡Runtime	- Coverage Listener Mode (AUT) - Test Runner Mode	labId	--labId	SL_LAB_ID SEALIGHTS_LAB_ID	A unique name representing the environment in which your AUT was deployed (and against which you are testing) BP: set at Runtime via Env Var	STRING	—
Test stage	🔧Config ⚡Runtime	- Test Runner Mode	testStage	--testStage	SL_TEST_STAGE SEALIGHTS_TEST_STAGE	Test Stage name shown in UI. BP: set at Runtime via Env Var	STRING	—
Test project ID	🔧Config ⚡Runtime	- Test Runner Mode	testProjectId	--testProjectId	SL_TEST_PROJECT_ID SEALIGHTS_TEST_PROJECT_ID	Test project identifier for test cycle differentiation BP: set at Runtime via Env Var	STRING	—
Test group ID	🔧Config ⚡Runtime	- Test Runner Mode	testGroupId	--testGroupId	SL_TEST_GROUP_ID SEALIGHTS_TEST_GROUP_ID	Test group identifier for execution grouping BP: set at Runtime via Env Var	STRING	—
Enable Ginkgo	🔧Config	- Test Runner Mode	enableGinkgo	--enableGinkgo --ginkgo	SL_ENABLE_GINKGO SEALIGHTS_ENABLE_GINKGO	Instrument Ginkgo test runner	BOOL	false
Enable Godog	🔧Config	- Test Runner Mode	enableGodog	--enableGodog --godog	SL_ENABLE_GODOG SEALIGHTS_ENABLE_GODOG	Instrument Godog test runner	BOOL	false
SCM provider	🔧Config	- Coverage Listener Mode (AUT)	scmProvider	--scmProvider	SL_SCM_PROVIDER SEALIGHTS_SCM_PROVIDER	SCM provider	ENUM {git | github | gitlab | bitbucket | azure-devops | other}	—
SCM version	🔧Config	- Coverage Listener Mode (AUT)	scmVersion	--scmVersion	SL_SCM_VERSION SEALIGHTS_SCM_VERSION	SCM tool/API version	STRING	—
SCM base URL	🔧Config	- Coverage Listener Mode (AUT)	scmBaseUrl	--scmUrl	SL_SCM_URL SEALIGHTS_SCM_URL	SCM server root URL (if not using Github)	STRING	—
SCM git directory	🔧Config	- Coverage Listener Mode (AUT)	scmGitDir	--scmGitDir	SL_SCM_GIT_DIR SEALIGHTS_SCM_GIT_DIR	Path to .git directory (monorepos)	STRING	./
Light mode	⚡Runtime	- Coverage Listener Mode (AUT)	–	–	SL_LIGHT_MODE SEALIGHTS_LIGHT_MODE	Minimal footprint mode. Set on Lambda at runtime	BOOL	false
Disable on init	🔧Config ⚡Runtime	- Coverage Listener Mode (AUT)	disableSealightsOnInit	--disableOnInit	SL_DISABLE_ON_INIT SEALIGHTS_DISABLE_ON_INIT	Disable Sealights Agent at runtime. BP: set at Runtime via Env Var	BOOL	false

---

PR Related Parameters

Parameter	Timing	Usage Mode	Config File Key	CLI Flags	Environment Variables	Description	Accepts/Type	Default Value
PR build session ID	🔧Config	- Coverage Listener Mode (AUT)	—	--prBuildSessionId, --pr-bsid, --pr-build-session-id, --pull-request-build-session-id	SL_PR_BUILD_SESSION_ID, SEALIGHTS_PR_BUILD_SESSION_ID	Build Session ID used for PR comparison	STRING	—
Pull request number	🔧Config	- Coverage Listener Mode (AUT)	—	--pullRequestNumber, --pr-number, --pull-request-number	SL_PULL_REQUEST_NUMBER, SEALIGHTS_PULL_REQUEST_NUMBER, SL_PR_NUMBER, SEALIGHTS_PR_NUMBER	Pull request number	INT	—
PR latest commit	🔧Config	- Coverage Listener Mode (AUT)	—	--latestCommit, --pr-latest-commit, --latest-commit, --pull-request-latest_commit	SL_LATEST_COMMIT, SEALIGHTS_LATEST_COMMIT, SL_PR_LATEST_COMMIT, SEALIGHTS_PR_LATEST_COMMIT	Latest commit SHA of the PR	STRING	—
PR repository URL	🔧Config	- Coverage Listener Mode (AUT)	—	--repositoryUrl, --repository-url, --pr-repository-url, --pull-request	SL_REPOSITORY_URL, SEALIGHTS_REPOSITORY_URL, SL_PR_REPOSITORY_URL, SEALIGHTS_PR_REPOSITORY_URL	Source repo URL of the PR	STRING	—
PR target branch	🔧Config	- Coverage Listener Mode (AUT)	—	--targetBranch, --target-branch, --pr-target-branch, --pull-request-target-branch	SL_TARGET_BRANCH, SEALIGHTS_TARGET_BRANCH	Branch the PR will merge into	STRING	—
PR ID	🔧Config ⚡Runtime	- Coverage Listener Mode (AUT) - Test Runner Mode	prId	--prId, --prid, --pr-id, --prID	SL_PR_ID, SEALIGHTS_PR_ID, SL_PRID, SEALIGHTS_PRID	Differentiate executions of same test stage/branch/PR	STRING	—

Parameters That Can Be Deferred to Runtime

In the above table, the parameters with a "Timing" value of "Runtime" do not need to be set during slgoagent config commands; they can be set later at runtime using environment variables.

1. These parameters are optional during the config/instrument phase. In some cases, we recommend setting at runtime (as noted in the description above).

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.