Quickstart: Add Go Agent to AUT

Quickstart: Adding the Go Agent to an Application

This page is meant as a quick reference only. You can find important details for each of these steps at Steps for Instrumenting an Application (AUT) with SeaLights Go Agent

1

Download the Agent

See: Downloading The Go Agent

2

Go Agent Configuration and BSID Generation

Base Command: ./slgoagent config [options]

Example Configurations:

CLI

Example 1: All parameters as CLI flags

./slgoagent config \
  --token="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  --app-name="shopping-cart-service" \
  --branch="feature-checkout" \
  --build="v1.2.3-build-456" \
  --lab-id="shoppingcart.dev.qa-blue"

Environment variables

Example 2: Using environment variables

export SEALIGHTS_APP_NAME="shopping-cart-service"
export SEALIGHTS_BRANCH="feature-checkout"
export SEALIGHTS_BUILD="v1.2.3-build-456"
export SEALIGHTS_LAB_ID="shoppingcart.dev.qa-blue"

./slgoagent config

Configuration file

Example 3: Using configuration file

Create .slconfig.yaml in your project root:

appName: "shopping-cart-service"
branch: "feature-checkout"
build: "v1.2.3-build-456"
labId: "shoppingcart.dev.qa-blue"

Then run:

./slgoagent config --token="./sltoken-local.txt"

3

Scan and Instrument the Application Code

Base Command: ./slgoagent scan

This command does not typically need additional parameters passed with it. Use ./slgoagent scan --help for details.

Run Unit Tests (Optional)

This is the point in the flow at which Unit Tests should be run, using your normal test commands. The Go Agent will automatically track coverage of Unit Tests. Note that this applies *only* to unit tests. Other test stages must be tracked using a SeaLights Agent or by opening a Manual Test Stage with SeaLights.

4

Deploy the Instrumented Application Code

Deploy the instrumented application code into your test environment.