The RudderStack Go SDK lets you track your customer event data from your Go applications and send it to your specified destinations via RudderStack.

Check out the GitHub codebase to get a more hands-on understanding of the SDK.

SDK setup requirements

To set up the RudderStack Go SDK, the following prerequisites must be met:

• You will need to set up a RudderStack account.
• Once signed up, set up a Go source in the dashboard. For more information, see Adding a source. You should then see a Write Key for this source, as shown below:

• You will also need a data plane URL. Follow this section for more information on the data plane URL and where to get it.

Installing the Go SDK

You can install the RudderStack Go SDK via the go get command. We highly recommend that you use a tool like Godep to avoid the issues related to any breaking API changes introduced between major versions of the library.

To install it in the GOPATH, run the following:

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

Using the Go SDK

To use the SDK, run the following code snippet:

Copy
package main

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

func main() {
    // Instantiates a client to use send messages to the Rudder API.
    client := analytics.New(WRITE_KEY, DATA_PLANE_URL)

    // Enqueues a track event that will be sent asynchronously.
    client.Enqueue(analytics.Track{
        UserId: "test-user",
        Event:  "test-snippet",
    })

    // 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"
)

func main() {
    // Instantiates a client to use send messages to the Rudder API.
    client, _ := analytics.NewWithConfig(WRITE_KEY, DATA_PLANE_URL,
        analytics.Config{
            Interval:  30 * time.Second,
            BatchSize: 100,
            Verbose:   true,
        })

    // Enqueues a track event that will be sent asynchronously.
    client.Enqueue(analytics.Track{
        UserId: "test-user",
        Event:  "test-snippet",
    })

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

The Config object parameters are described in the following table:

Users who do not use a proxy should set the NoProxySupport parameter to true while initializing the config.

Copy
// Instantiates a client to use send messages to the Rudder API.
    client, _ := analytics.NewWithConfig(WRITE_KEY, DATA_PLANE_URL,
        analytics.Config{
            Interval:  30 * time.Second,
            BatchSize: 100,
            NoProxySupport:   true,
        })

Identify

The identify call lets you identify a visiting user and capture any related information such as their name, email address, etc.

A sample identify call is as shown:

Copy
client.Enqueue(analytics.Identify{
  UserId: "123",
  Traits: analytics.NewTraits().
    SetName("Name Surname").
    SetEmail("name@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: "123",
  Event:  "Signed Up",
  Properties: analytics.NewProperties().
    Set("plan", "Free"),
})

The track method parameters are as described below:

Page

The page call allows you to record the page views on your website along with the other relevant information about the viewed 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:

Group

The group call lets you associate an identified user to a group - either a company, project or a team and record any custom traits or properties associated with that group.

A sample group call is as shown:

Copy
client.Enqueue(analytics.Group{
  UserId:  "12345",
  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.

A sample alias call is as shown:

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

The alias method parameters are as mentioned below:

Contact us

For queries on any of the sections covered in this guide, you can contact us or start a conversation in our Slack community.