github.com/Rookout/GoSDK@v0.1.48/README.md (about)

     1  # Rookout Go SDK
     2  [Rookout](https://rookout.com)'s Go SDK is a Go module that supports on the fly debugging and data extraction from Go applications in production. 
     3  
     4  ## Compatibility
     5  Go versions 1.15 and higher are supported. 
     6  
     7  Linux (including Alpine) and Mac operating systems are supported. 
     8  
     9  ## Installation
    10  
    11  Add the Rookout SDK by running: 
    12  ```bash
    13  go get -d github.com/Rookout/GoSDK
    14  ```
    15  
    16  ## Usage
    17  
    18  Import Rookout in the file containing your `main` package:
    19  ```go
    20  import (
    21      rookout "github.com/Rookout/GoSDK"
    22  )
    23  ```
    24  
    25  Call `rookout.Start` as early as possible in your `main` function: 
    26  ```go
    27  rookout.Start(rookout.RookOptions{token=[Your Rookout Token]})
    28  ```
    29  
    30  For the best experience, build your application with extra debug info:
    31  ```bash
    32  go build -gcflags="all=-dwarflocationlists=true"
    33  ```
    34  
    35  ## Additional Information
    36  
    37  For more info see the complete setup guide [in our docs](https://docs.rookout.com/docs/go-setup/).