databeat

README

go-databeat

Go databeat client

Documentation

Index

• Variables
• func CountryCodeFromRequest(r *http.Request) string
• func DeviceFromUserAgent(userAgent string) *proto.Device
• func EventTypes(eventTypesMap ...map[string]uint32) []string
• func GenSessionID() string
• func ProxyHandler(databeatHost string) func(next http.Handler) http.Handler
• func String(s string) *string
• func StructToProps(v any) (map[string]string, map[string]float64, map[string]interface{}, error)
• func TimeNow() *time.Time
• type Databeat
  • func NewDatabeatClient(host, authKey string, logger logger.Logger, opts ...Options) (*Databeat, error)
  • func (t *Databeat) Flush(ctx context.Context) error
  • func (t *Databeat) IsRunning() bool
  • func (t *Databeat) Options() Options
  • func (t *Databeat) Reset()
  • func (t *Databeat) Run(ctx context.Context) error
  • func (t *Databeat) Stats() Stats
  • func (t *Databeat) Stop()
  • func (t *Databeat) Track(events ...*Event)
  • func (t *Databeat) TrackEvent(from From, trackEvents ...Event)
  • func (t *Databeat) TrackRaw(events ...*RawEvent)
  • func (t *Databeat) TrackUserEvent(r *http.Request, userID string, userEvents ...Event)
• type Device
  • func ServerDevice() *Device
• type Event
• type From
• type Ident
  • func GenUserID(userID string, privacyOptions PrivacyOptions) (string, Ident)
  • func GenUserIDFromRequest(r *http.Request, userID string, privacyOptions PrivacyOptions) (string, Ident)
  • func UserID(userID string, privacyOptions PrivacyOptions, r ...*http.Request) (string, Ident)
• type Options
• type PrivacyOptions
• type Props
  • func (p Props) ToEventProps() (map[string]string, map[string]float64, map[string]interface{})
• type RawEvent
• type Stats
• type ToEventProps

Variables

var DefaultOptions = Options{
	Privacy:             DefaultPrivacyOptions,
	AssertEventTypes:    []string{},
	FlushBatchSize:      100,
	FlushInterval:       2000 * time.Millisecond,
	FlushTimeout:        30 * time.Second,
	FlushConcurrency:    10,
	MaxQueueSize:        10_000,
	SetServerClientProp: false,
	HTTPClient:          &http.Client{},
}

var DefaultPrivacyOptions = PrivacyOptions{
	UserIDHash: true, UserAgentSalt: false, ExtraSalt: "",
}

Functions

func CountryCodeFromRequest

func CountryCodeFromRequest(r *http.Request) string

func DeviceFromUserAgent

func DeviceFromUserAgent(userAgent string) *proto.Device

func EventTypes

func EventTypes(eventTypesMap ...map[string]uint32) []string

func GenSessionID

func GenSessionID() string

func ProxyHandler

func ProxyHandler(databeatHost string) func(next http.Handler) http.Handler

ProxyHandler routes requests from /rpc/Databeat/* to the remote Databeat server.

func String

func String(s string) *string

func StructToProps

func StructToProps(v any) (map[string]string, map[string]float64, map[string]interface{}, error)

func TimeNow

func TimeNow() *time.Time

Types

type Databeat

type Databeat struct {
	Client  proto.Databeat
	Enabled bool
	// contains filtered or unexported fields
}

func NewDatabeatClient

func NewDatabeatClient(host, authKey string, logger logger.Logger, opts ...Options) (*Databeat, error)

func (*Databeat) Flush

func (t *Databeat) Flush(ctx context.Context) error

func (*Databeat) IsRunning

func (t *Databeat) IsRunning() bool

func (*Databeat) Options

func (t *Databeat) Options() Options

func (*Databeat) Reset

func (t *Databeat) Reset()

func (*Databeat) Run

func (t *Databeat) Run(ctx context.Context) error

func (*Databeat) Stats

func (t *Databeat) Stats() Stats

func (*Databeat) Stop

func (t *Databeat) Stop()

func (*Databeat) Track

func (t *Databeat) Track(events ...*Event)

Track is a low-level track function where you control the full payload. The method TrackUserEvent calls Track as well.

func (*Databeat) TrackEvent

func (t *Databeat) TrackEvent(from From, trackEvents ...Event)

func (*Databeat) TrackRaw

func (t *Databeat) TrackRaw(events ...*RawEvent)

func (*Databeat) TrackUserEvent

func (t *Databeat) TrackUserEvent(r *http.Request, userID string, userEvents ...Event)

TrackUserEvent will track the event associated to a particular user. We use the http request `r` for User-Agent and IP information. Note that `r` is optional, and you can pass `nil` as the argument, but it will be unable to offer device and country information.

type Device

type Device = proto.Device

func ServerDevice

func ServerDevice() *Device

type Event

type Event = proto.Event

type From

type From struct {
	UserID          string
	UserHTTPRequest *http.Request
	ProjectID       uint64
}

type Ident

type Ident uint8

const (
	IDENT_ANON Ident = iota
	IDENT_PRIVATE
	IDENT_USER
	IDENT_SERVICE
)

func GenUserID

func GenUserID(userID string, privacyOptions PrivacyOptions) (string, Ident)

func GenUserIDFromRequest

func GenUserIDFromRequest(r *http.Request, userID string, privacyOptions PrivacyOptions) (string, Ident)

func UserID

func UserID(userID string, privacyOptions PrivacyOptions, r ...*http.Request) (string, Ident)

type Options

type Options struct {
	Privacy             PrivacyOptions
	AssertEventTypes    []string
	FlushBatchSize      int
	FlushInterval       time.Duration
	FlushTimeout        time.Duration
	FlushConcurrency    int
	MaxQueueSize        int
	SetServerClientProp bool
	HTTPClient          *http.Client
}

type PrivacyOptions

type PrivacyOptions struct {
	UserIDHash    bool
	UserAgentSalt bool
	ExtraSalt     string
}

type Props

type Props map[string]interface{}

Props is a sugar type to make it easier to track props

func (Props) ToEventProps

func (p Props) ToEventProps() (map[string]string, map[string]float64, map[string]interface{})

type RawEvent

type RawEvent = proto.RawEvent

type Stats

type Stats struct {
	NumEvents uint64
	NumFails  uint64
}

type ToEventProps

type ToEventProps interface {
	ToEventProps() (map[string]string, map[string]float64, map[string]interface{})
}