RudderStack's Go SDK lets you track and send the events from your Go applications to the specified destinations.

SDK setup requirements

1. Sign up to RudderStack Cloud.
2. Set up a Go source in your dashboard. You should be able to see a write key for this source, as shown:

You will also need a data plane URL. Refer to the Dashboard Overview guide for more information on the data plane URL and where to find it.

Installing the Go SDK

To install the Go SDK in the GOPATH, run the following command:

Copy
go get github.com/rudderlabs/analytics-go

Initializing the SDK

Run the following code snippet to initialize the Go SDK:

Copy
package main

import (
    "github.com/rudderlabs/analytics-go/v4"
)

func main() {
    // Instantiates a client to use send messages to the RudderStack API.
    
    // Use your write key in the below placeholder:
    
    client := analytics.New(<WRITE_KEY>, <DATA_PLANE_URL>)

    // Enqueues a track event that will be sent asynchronously.
    client.Enqueue(analytics.Track{
        UserId: "1hKOmRA4GRlm",
        Event:  "Test Event",
    })

    // Flushes any queued messages and closes the client.
    client.Close()
}

Alternatively, you can run the following snippet:

Copy
package main

import (
    "github.com/rudderlabs/analytics-go/v4"
)

func main() {
    // Instantiates a client to use send messages to the RudderStack API.
    
    // Enter your write key in the below placeholder:
    
    client, _ := analytics.NewWithConfig(WRITE_KEY,
        analytics.Config{
            DataPlaneUrl: DATA_PLANE_URL,
            Interval:     30 * time.Second,
            BatchSize:    100,
            Verbose:      true,
            Gzip:         0,  // Enables Gzip compression - set to 1 to disable Gzip.
        })

    // Enqueues a track event that will be sent asynchronously.
    
    client.Enqueue(analytics.Track{
        UserId: "1hKOmRA4GRlm",
        Event:  "Test Event",
    })

    // Flushes any queued messages and closes the client.
    
    client.Close()
}

Migrating to SDK v4

To migrate to the Go SDK v4.0.0, set the data plane URL in Config (as seen in the above section) instead of passing it as an argument.

SDK initialization options

The RudderStack Go SDK provides the following initialization options:

Gzipping requests

The Go SDK automatically gzips requests. However, you can disable this by setting the Gzip parameter to 1 while initializing the SDK, as shown:

Copy
client, _ := analytics.NewWithConfig(WRITE_KEY,
        analytics.Config{
            DataPlaneUrl: DATA_PLANE_URL,
            Interval:     30 * time.Second,
            BatchSize:    100,
            Verbose:      true,
            Gzip:         1   // Disables Gzip compression
        })

Sending events

Identify

The identify call lets you identify a visiting user and associate them to their actions. It also lets you record the traits about them like their name, email address, etc.

A sample identify call made using the Go SDK is shown below:

Copy
client.Enqueue(analytics.Identify{
  UserId: "1hKOmRA4GRlm",
  Traits: analytics.NewTraits().
    SetName("Alex Keener").
    SetEmail("alex@example.com").
    Set("plan", "Free").
    Set("manager", 12),
})

The identify method parameters are as described below:

Track

The track call lets you record the user actions along with their associated properties. Each user action is called an event.

A sample track call is shown below:

Copy
client.Enqueue(analytics.Track{
  UserId: "1hKOmRA4GRlm",
  Event:  "Signed Up",
  Properties: analytics.NewProperties().
    Set("plan", "Free"),
})

The track method parameters are as described below:

Page

The page call lets you record the page views on your application along with the other relevant information about the page.

A sample page call is as shown:

Copy
client.Enqueue(analytics.Page{
  UserId: "12345",
  Name:   "Pizza",
  Properties: analytics.NewProperties().
    SetURL("https://dominos.com"),
})

The page method parameters are as described below:

Screen

The screen call is the mobile equivalent of the page call. It lets you record the screen views on your mobile app along with other relevant information about the screen.

A sample screen call is as shown:

Copy
client.Enqueue(analytics.Screen{
  UserId: "1hKOmRA4GRlm",
  Name:   "Pizza",
  Properties: analytics.NewProperties().
    SetURL("https://dominos.com"),
})

The screen method parameters are as described below:

Group

The group call lets you link an identified user with a group, such as a company, organization, or an account. It also lets you record any custom traits or properties associated with that group.

A sample group call made using the Go SDK is shown below:

Copy
client.Enqueue(analytics.Group{
  UserId:  "1hKOmRA4GRlm",
  GroupId: "1",
  Traits: map[string]interface{}{
    "name": "Company",
    "description": "Facebook",
  },
})

The group method parameters are as follows:

Alias

The alias call lets you merge different identities of a known user. It is an advanced method that lets you change the tracked user's ID explicitly. You can use alias for managing the user's identity in some of the downstream destinations.

A sample alias call is as shown:

Copy
client.Enqueue(analytics.Alias{
  PreviousId: "12345",
  UserId:     "1hKOmRA4GRlm",
})

The alias method parameters are as mentioned below: