Application Real-Time Monitoring Service:Monitor a Go application deployed in a DevOps Flow pipeline

Download instgo

Download instgo for your OS and architecture from the region where your environment resides. Store it in a directory with write permissions, because instgo downloads dependencies during compilation.

If your build machine can access Object Storage Service (OSS) over the Internet, you can directly use the public endpoint of the China (Hangzhou) region to download instgo.

The download URL follows this pattern:

# Public endpoint
http://arms-apm-<region-id>.oss-<region-id>.aliyuncs.com/instgo/instgo-<os>-<arch>

# VPC endpoint
http://arms-apm-<region-id>.oss-<region-id>-internal.aliyuncs.com/instgo/instgo-<os>-<arch>

Replace the placeholders with actual values:

For Windows, the binary filename is instgo-windows-amd64.exe.

Example: Download instgo for Linux AMD64 from the China (Hangzhou) region:

wget "http://arms-apm-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/instgo/instgo-linux-amd64" -O instgo

Supported OS and architecture combinations: Linux (AMD64, ARM64), macOS (AMD64, ARM64), Windows (AMD64).

Grant execute permissions

On Linux or macOS, make the binary executable:

chmod +x instgo

On Windows, no additional permissions are needed.

Configure the license key

Set the license key and region before building. The --dev=false flag configures instgo for production use:

./instgo set --licenseKey=<your-license-key> --regionId=<your-region-id> --dev=false

Replace the placeholders with actual values:

Build with instgo

Prefix your existing go build command with instgo:

./instgo go build -o myapp .

The output binary (myapp in this example) contains the embedded ARMS agent and is ready for deployment.

Build the container image

Use the instrumented binary to build a container image. The following multi-stage Dockerfile integrates instgo into the build:

FROM golang:1.21 AS build
WORKDIR /app

# Copy dependency files first for better layer caching
COPY go.mod go.sum ./
RUN go mod download

# Copy source code
COPY . .

# Download and set up instgo (China (Hangzhou) region, Linux AMD64)
RUN wget "http://arms-apm-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/instgo/instgo-linux-amd64" -O instgo \
    && chmod +x instgo \
    && ./instgo set --licenseKey=<your-license-key> --regionId=<your-region-id> --dev=false

# Build with ARMS instrumentation
RUN ./instgo go build -o myapp .

# Runtime stage
FROM debian:bookworm-slim
COPY --from=build /app/myapp /usr/local/bin/
ENTRYPOINT ["/usr/local/bin/myapp"]

Replace <your-license-key> and <your-region-id> with your actual values. Adjust the instgo download URL if your build environment uses a different region or architecture.

Deploy to an ACK cluster

1. Log on to the ACK console. In the left-side navigation pane, click Clusters.

2. Select the resource group and region of your cluster, then click the cluster name.

3. In the left-side navigation pane, choose Workloads > Deployments, StatefulSets, or DaemonSets depending on your workload type.

4. Find the target application. In the Actions column, click the more icon () and select Edit YAML. To monitor a new Go application, click Create from YAML on the Deployments page instead.

5. Add the following labels under spec.template.metadata:

      labels:
        aliyun.com/app-language: golang    # Required. Identifies a Go application.
        armsPilotAutoEnable: 'on'          # Required. Enables ARMS monitoring.
        armsPilotCreateAppName: "<your-deployment-name>"  # Required. Replace with your Deployment name.

   

6. Save the YAML and wait for the pods to restart.

Deploy to an ECS instance

Before running the instrumented binary, export the following environment variables:

export ARMS_ENABLE=true
export ARMS_APP_NAME=<your-app-name>         # Application name shown in the ARMS console
export ARMS_REGION_ID=<your-region-id>       # Region ID, for example, cn-hangzhou
export ARMS_LICENSE_KEY=<your-license-key>   # License key from Prerequisites

./myapp

The following table describes each variable: