APM Insight Go agent installation
Learn how to install the Site24x7 APM Insight Go Agent for monitoring Golang applications.
Use case
Consider you have a Golang-based retail application (go_retail) that powers the following ports:
- Port 8483: Internal API for inventory and pricing.
- Port 8484: Public-facing checkout or payment gateway.
This application is mission-critical—any slowdown or downtime on these ports directly impacts customers’ ability to browse, place orders, or complete payments, leading to revenue loss.
By installing Site24x7’s Go agent, and tracking metrics like Server Response Time, Request Throughput, Apdex, and SQL/Redis query, slow transactions issues can be detected early ensuring optimal performance, quick troubleshooting, and uninterrupted user experience.
Prerequisites
Before setting up monitoring for your Go application, ensure the following:
- Make sure your Go application (e.g., go_retail) is running.
- The required ports are open and available to be monitored (e.g., 8483 and 8484)
- Verify if you have your Site24x7 license key.
- Install Site24x7 APMDataExporter using the below command:
wget -O InstallDataExporter.sh https://staticdownloads.site24x7.com/apminsight/S247DataExporter/linux/InstallDataExporter.sh
sudo -E sh InstallDataExporter.sh -license.key
- Download the apm-insight-go-agent-install.sh script using the below command and, ensure the script has execute permissions:
wget https://staticdownloads.site24x7.com/apminsight/agents/golang/linux/amd64/apm-insight-go-agent-install.sh -O apm-insight-go-agent-install.sh
chmod +x apm-insight-go-agent-install.sh
Step 1: Verify running Go applications and ports
First, confirm your Go application is running and listening on the intended ports:
sudo lsof -i -nP | grep -i go_
Validate if the output is similar to:
go_retail 722628 user-001 7u IPv4 4619876 0t0 TCP *:50051 (LISTEN)
go_retail 722628 user-001 9u IPv4 4616579 0t0 TCP *:8483 (LISTEN)
go_retail 722628 user-001 10u IPv4 4616580 0t0 TCP *:8484 (LISTEN)
Step 2: Run the installation command
The command will be:
sudo ./apm-insight-go-agent-install.sh -i -license_key=-apps="Retail_Application=go_retail:8484,8483;"
Install the Go agent
Execute the following command to install the agent:
sudo ./apm-insight-go-agent-install.sh -i -license_key=license_key-apps=app_definitions
Parameter details:
| Option | Description |
|---|---|
| -h | Display the help message |
| -i | Install the agent (required) |
| -license_key | Your Site24x7 APM Insight license key (required) |
| -apps | Defines Go applications to monitor (required). Format explained below. |
Define applications with -apps
In the installation command shown in the Install the Go agent section, the -apps parameter requires a list of Go applications to monitor. Define this list with the process names and ports using the format below.
<app_name>=<process_name>:<port1>[,<port2>];<app_name2>=<process_name2>:<port3>
Details:
- app_name: Display name for the app in Site24x7
- process_name: Exact process name
- port: Port(s) used by the application (multiple ports separated by commas)
- Separate multiple applications with semicolons
Example:
-apps="my_go_app=my_process:8087;go_retail_app=go_retail:8088,8089"
Supported metrics
The Go agent monitors the following metrics for your application:
| Metric | Description |
|---|---|
| Application Server Response Time | Detailed component-level breakdown of server response times |
| Apdex | User satisfaction score based on response times |
| Request Throughput | Number of requests processed per minute |
| Top 5 Transactions by Avg. Response Time | Transactions with the highest average response time |
| Web Transactions | Includes count, Apdex, and average response time |
| Service Map | Visual map with component-level split-up |
| MySQL queries | Query execution details and response time |
| Redis queries | Query execution details and response time |
Basic configuration profiles
| Configuration option | Description |
|---|---|
| Capture Database SQL Queries | Collects executed SQL queries |
| Obfuscate SQL Parameters | Hides sensitive SQL parameter values |
| Stacktrace Threshold for SQLs in Transaction Trace | Sets minimum execution time for stacktrace capture |
| Display Instance Port Number | Shows instance port in Site24x7 console |
| Enable Down Alert | Sends alerts if the instance is down |
| Suppress Instance Alerts | Suppresses alerts for selected instances |
| Normalize DB Operation Names | Groups similar DB operations |
| Logging Level | Adjust logging verbosity |
| Skip URL extensions | Exclude tracking of static resources |
| Skip transactions | Exclude specific transactions from monitoring |
| Exclude grouping in transaction name | Prevents transaction name aggregation |
Web transactions configuration
| Configuration option | Description |
|---|---|
| Apdex threshold | Defines threshold for Apdex calculation |
| Sampling factor | Controls the percentage of transactions sampled |
| Enable transaction tracing | Captures detailed transaction traces |
| Transaction trace threshold | Minimum response time for trace capture |
| Track HTTP error codes | List of error codes to monitor |
| Ignore HTTP error codes | List of error codes to skip |
| Capture HTTP bytes | Enable/disable capture of HTTP payload sizes |
Next steps
After installation, your Go applications will start reporting performance data to the Site24x7 console under APM > Applications.