This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Introduction Built-in instrumentation modules »

›

Set up the Agent

edit

Set up the Agent

edit

To start reporting your Go application’s performance to Elastic APM, you need to do a few things:

Install the Agent

edit

Within a Go module, install the Elastic APM Go agent package using go get:

go get -u go.elastic.co/apm/v2

Requirements

edit

You can find a list of the supported frameworks and other technologies in the Supported Technologies section.

Instrument Go Source Code

edit

Instrumentation is the process of extending your application’s code to report trace data to Elastic APM. Go applications must be instrumented manually at the source code level. There are two ways to instrument your applications:

Using Built-in instrumentation modules.
Custom instrumentation and Context propagation with the Go Agent API.

Where possible, use the built-in modules to report transactions served by web and RPC frameworks in your application.

Configure the Agent

edit

To simplify development and testing, the agent defaults to sending data to the Elastic APM Server at http://localhost:8200. To send data to an alternative location, you must configure ELASTIC_APM_SERVER_URL. Depending on the configuration of your server, you may also need to set ELASTIC_APM_API_KEY, ELASTIC_APM_SECRET_TOKEN, and ELASTIC_APM_VERIFY_SERVER_CERT. All other variables have usable defaults.

See Configuration to learn about all available options.

« Introduction Built-in instrumentation modules »