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

  • 🔧⚡ 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

Root directory

🔧 Config

Both

rootDir

--root-dir | --workspacepath

SEALIGHTS_ROOT_DIR, SL_ROOT_DIR, SEALIGHTS_WORKSPACE_PATH, SL_WORKSPACE_PATH

Project/workspace root; default ./

Authentication token

🔧⚡ Either

Both

--token | -t | --auth-token

SEALIGHTS_TOKEN, SL_TOKEN

Raw token or path to token file (required)

Build session ID

🔧 Config

Both

--bsid | --build-session-id

SEALIGHTS_BUILD_SESSION_ID

Build-session identifier

Build session ID from file

🔧 Config

Both

--bsid-from-file

SEALIGHTS_BUILD_SESSION_ID_FROM_FILE

Load build-session ID from a file

Save build session ID to file

🔧 Config

Coverage Listener Mode (AUT)

--save-bsid-to-file

SEALIGHTS_SAVE_BUILD_SESSION_ID_TO_FILE, SL_SAVE_BUILD_SESSION_ID_TO_FILE

Persist generated session ID

PR build session ID

🔧 Config

Coverage Listener Mode (AUT)

--pr-bsid

SEALIGHTS_PR_BUILD_SESSION_ID, SL_PR_BUILD_SESSION_ID

Session ID used for PR comparison

PR number

🔧 Config

Coverage Listener Mode (AUT)

--pr-number

SEALIGHTS_PR_NUMBER, SL_PR_NUMBER

Pull request number

PR latest commit

🔧 Config

Coverage Listener Mode (AUT)

--pr-latest-commit | --latest-commit

SEALIGHTS_PR_LATEST_COMMIT, SL_PR_LATEST_COMMIT

Latest commit SHA of the PR

PR repository URL

🔧 Config

Coverage Listener Mode (AUT)

--repository-url

SEALIGHTS_PR_REPOSITORY_URL, SL_PR_REPOSITORY_URL

Source repo URL of the PR

PR target branch

🔧 Config

Coverage Listener Mode (AUT)

--target-branch

SEALIGHTS_TARGET_BRANCH, SL_TARGET_BRANCH

Branch the PR will merge into

Application name

🔧 Config

Coverage Listener Mode (AUT)

appName

--app-name | --app

SEALIGHTS_APP_NAME, SL_APP_NAME

Display name in Sealights

Build name

🔧 Config

Coverage Listener Mode (AUT)

build

--build | -b

SEALIGHTS_BUILD, SL_BUILD

Build identifier (auto-generated if omitted)

Branch name

🔧 Config

Coverage Listener Mode (AUT)

branch

--branch | --br

SEALIGHTS_BRANCH, SL_BRANCH

Git branch for build

Build tags

🔧 Config

Coverage Listener Mode (AUT)

buildTags

--build-tags | --tags

SEALIGHTS_BUILD_TAGS, SL_BUILD_TAGS

Extra Go compiler tags

Build environment list

🔧 Config

Coverage Listener Mode (AUT)

buildEnv

--build-env

SEALIGHTS_BUILD_ENV, SL_BUILD_ENV

Extra env vars for build

Go mod file

🔧 Config

Coverage Listener Mode (AUT)

goModFile

--go-mod-file | --modfile | --mod

SEALIGHTS_GO_MOD_FILE, SL_GO_MOD_FILE

Alternate go.mod location

Proxy URL

🔧⚡ Either

Both

proxyUrl

--proxy-url | --proxy

SEALIGHTS_PROXY_URL, SL_PROXY_URL

HTTP/HTTPS proxy

Collector URL

🔧⚡ Either

Both

collectorUrl

--collector-url | --collector | -c

SEALIGHTS_COLLECTOR_URL, SL_COLLECTOR_URL

Override backend collector

Packages included

🔧 Config

Coverage Listener Mode (AUT)

packagesIncludes

--packages-included | --includes | --include

SEALIGHTS_PACKAGES_INCLUDED, SL_PACKAGES_INCLUDED

Globs of packages to instrument

Packages excluded

🔧 Config

Coverage Listener Mode (AUT)

packagesExcludes

--packages-excluded | --excludes | --exclude

SEALIGHTS_PACKAGES_EXCLUDED, SL_PACKAGES_EXCLUDED

Packages to skip

Log level

🔧⚡ Either

Both

logLevel

--log-level | --log | -l

SEALIGHTS_LOG_LEVEL, SL_LOG_LEVEL

silent | debug | info | warn | error

Light mode

🔧 Config

Coverage Listener Mode (AUT)

lightMode

--light-mode | --light

SEALIGHTS_LIGHT_MODE, SL_LIGHT_MODE

Minimal footprint mode (Lambda)

Disable on init

🔧⚡ Either

Coverage Listener Mode (AUT)

disableSealightsOnInit

--disable-sealights-on-init | --disable-on-init

SEALIGHTS_DISABLE_ON_INIT, SL_DISABLE_ON_INIT

Skip instrumentation at start

Disable token save

🔧 Config

Coverage Listener Mode (AUT)

disableTokenSave

--disable-token-save | --no-token-save

SEALIGHTS_DISABLE_TOKEN_SAVE, SL_DISABLE_TOKEN_SAVE

Don't write token into build.json

Enable Ginkgo

🔧 Config

Test Runner Mode

enableGinkgo

--enable-ginkgo

SEALIGHTS_ENABLE_GINKGO, SL_ENABLE_GINKGO

Instrument Ginkgo test runner

Enable Godog

🔧 Config

Test Runner Mode

enableGodog

--enable-godog

SEALIGHTS_ENABLE_GODOG, SL_ENABLE_GODOG

Instrument Godog test runner

Tests-runner mode

🔧⚡ Either

Test Runner Mode

testsRunner

--tests-runner | --test-runner

SEALIGHTS_TESTS_RUNNER, SL_TESTS_RUNNER

Run as test listener only

Lab ID

🔧⚡ Either

Both

labId

--labid | --lab-id

SEALIGHTS_LAB_ID, SL_LAB_ID

Group related executions

Test stage

🔧⚡ Either

Both

testStage

--test-stage | --teststage

SEALIGHTS_TEST_STAGE, SL_TEST_STAGE

Stage name shown in UI

SCM provider

🔧 Config

Coverage Listener Mode (AUT)

scmProvider

--scm-provider | --scm

SEALIGHTS_SCM_PROVIDER, SL_SCM_PROVIDER

git, github, gitlab, …

SCM version

🔧 Config

Coverage Listener Mode (AUT)

scmVersion

--scm-version | --scm-ver

SEALIGHTS_SCM_VERSION, SL_SCM_VERSION

Tool / API version

SCM base URL

🔧 Config

Coverage Listener Mode (AUT)

scmBaseUrl

--scm-base-url | --scm-url

SEALIGHTS_SCM_BASE_URL, SL_SCM_BASE_URL

VCS server root URL

SCM git directory

🔧 Config

Coverage Listener Mode (AUT)

scmGitDir

--scm-git-dir

SEALIGHTS_SCM_GIT_DIR, SL_SCM_GIT_DIR

Path to .git (monorepos)

A blank “Config File key” means that particular parameter cannot be set inside .slconfig.yaml; 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 slgoagent config and/or slgoagent instrument commands; they can be set later at runtime using environment variables.

  1. These parameters are optional during the config/instrument 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?