amplitude

Documentation

Overview

Package amplitude provides some utility functions for the usage of Amplitude.

Index

• func CheckSetUp()
• func Clean()
• func Flush()
• func FlushForce()
• func GetDeviceID() string
• func GetEventOptions() (options ampli.EventOptions)
• func InitAmplitude()
• func IsDisabled() bool
• func TrackCommand(cmd *cobra.Command, args []string)

Functions

func CheckSetUp

func CheckSetUp()

CheckSetUp shows a warning to the user if the API key is not available.

func Clean

func Clean()

Clean removes the cache file.

func Flush

func Flush()

Flush transmits the queued events if limits are reached.

func FlushForce

func FlushForce()

FlushForce transmits the queued events even if limits are not reached.

func GetDeviceID

func GetDeviceID() string

GetDeviceID returns the unique device id to be used when tracking an event.

func GetEventOptions

func GetEventOptions() (options ampli.EventOptions)

GetEventOptions returns default options to be used when tracking an event.

func InitAmplitude

func InitAmplitude()

InitAmplitude initializes the instrumentation and must be called once before the instrumentation functions can be used. Initialization is currently done before via init() func somewhere while creating the ddevapp. This should be cleaned up. TODO: Make private once clean up has done.

func IsDisabled

func IsDisabled() bool

IsDisabled returns true if instrumentation is disabled or no internet is available.

func TrackCommand

func TrackCommand(cmd *cobra.Command, args []string)

TrackCommand collects and tracks information about the command for instrumentation.