Go

RudderStack’s Go SDK allows you to track your customer event data from your Go code. Once enabled, the event requests hit the RudderStack servers. RudderStack then routes the events to the specified destination platforms as configured by you.

You can find this SDK in our GitHub repository.

Installing the RudderStack Go SDK

The RudderStack Go SDK package can be simply installed via the go get command. It is recommended that you use a tool like Godep to avoid issues related to the 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 RudderStack 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,

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 as described below:

For Users who do not use a proxy can make the NoProxySupport to true while initialising Config , this will avoid making calls to the proxy for fetching the total number of nodes in case of multi-node setup

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 associate a user to their actions as well as captures the relevant traits or properties related to that user.

An example 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 users' actions along with their associated properties. Each triggered action is called an 'event'.

An example track call is as shown:

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. It also records the other relevant information about the page that is being viewed.

An example 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 allows you to associate an identified user to a group - either a company, project, or a team. You can also record custom traits or properties associated with that group.

An example 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 allows you to associate one identity with another.

An example alias call is as shown:

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

The alias method parameters are as mentioned below:

Contact Us

To know more about the RudderStack Go SDK, you can contact us. You can also start a conversation on our Slack channel; we will be happy to talk to you.