github.com/waldiirawan/apm-agent-go/v2@v2.2.2/docs/set-up.asciidoc (about)

     1  [[getting-started]]
     2  == Set up the Agent
     3  
     4  To start reporting your Go application's performance to Elastic APM, you need to do a few things:
     5  
     6  1. <<installation>>.
     7  2. <<instrumenting-source>>.
     8  3. <<configure-setup>>.
     9  
    10  [float]
    11  [[installation]]
    12  == Install the Agent
    13  
    14  Install the Elastic APM Go agent package using `go get`:
    15  
    16  [source,bash]
    17  ----
    18  go get -u github.com/waldiirawan/apm-agent-go/v2
    19  ----
    20  
    21  [float]
    22  === Requirements
    23  
    24  The Go agent is tested with Go 1.8+ on Linux, Windows, and MacOS.
    25  
    26  [float]
    27  [[instrumenting-source]]
    28  == Instrument Go Source Code
    29  
    30  Instrumentation is the process of extending your application's code to report trace data to Elastic APM.
    31  Go applications must be instrumented manually at the source code level.
    32  There are two ways to instrument your applications:
    33  
    34  * Using <<builtin-modules>>.
    35  * <<custom-instrumentation>> and <<custom-instrumentation-propagation>> with the Go Agent API.
    36  
    37  Where possible, use the built-in modules to report transactions served by web and RPC frameworks in your application.
    38  
    39  [float]
    40  [[configure-setup]]
    41  == Configure the Agent
    42  
    43  include::./configuration.asciidoc[tag=setup-config]
    44  
    45  See <<configuration>> to learn about all available options.
    46  
    47  include::./instrumenting.asciidoc[]
    48  include::./custom-instrumentation.asciidoc[]
    49  include::./context-propagation.asciidoc[]