For the complete documentation index, see llms.txt. This page is also available as Markdown.

Go Agent

This section provides comprehensive documentation for the Traceable Go Agent, enabling you to secure and monitor your Go applications with minimal configuration.

Overview

The Traceable Go Agent provides deep visibility and security for your Go applications by instrumenting your code to monitor API traffic, detect threats, and provide detailed insights into your application's behavior.

Getting Started

Prerequisites

  • Check the repo's go.mod for the minimum supported Go version. Since we are dependent on opentelemetry-go, it dictates the minimum version.

  • OSes supported: all linux OSes including Debian, CentOS, RHEL, Amazon Linux 2 and Alpine.

  • Go modules enabled

  • Network connectivity to Traceable Platform Agent(TPA)

  • Traceable's Go agent is an SDK based Go package. Installing the Go agent requires some code change in the application where you wish to inject the Go agent. Make sure that you have reasonable knowledge of Go language.

Supported Frameworks

We support the following frameworks in our golang agent.

Server

  • net/http

  • gin-gonic/gin

  • google.golang.org/grpc

  • gorilla/mux

Client

  • net/http

  • google.golang.org/grpc

  • database/sql

  • jackc/pgx

Installation and Configuration

Installation

Configuration

Troubleshooting

Troubleshooting guide is available here.

Common Issues

  1. Agent not capturing traffic

    • Verify the agent is properly initialized

    • Check network connectivity to Traceable Platform

    • Verify your service name and environment are set correctly

  2. Performance impact

    • Adjust sampling rate if needed

    • Disable request/response body capture for high-traffic endpoints

    • Monitor memory and CPU usage

  3. Connection issues

    • Verify network connectivity

    • Check firewall rules

    • Verify TLS configuration

Last updated

Was this helpful?