analytics

Documentation

Overview

package analytics no longer provides any functionality. It is kept for backwards compatibility.

Index

• Constants
• func IsInvalidConfig(err error) bool
• func IsValidation(err error) bool
• type Analytics
  • func New(config Config) (*Analytics, error)
  • func (a *Analytics) Report(ctx context.Context, e Event) (Event, error)
• type AppID
  • func (a AppID) IsValid() bool
• type Config
• type Event
  • func (e *Event) CollectionName() string
• type Reporter

Constants

const (
	AppIDHappa = iota
)

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

func IsValidation

func IsValidation(err error) bool

IsValidation asserts validationError.

Types

type Analytics

type Analytics struct {
	// contains filtered or unexported fields
}

func New

func New(config Config) (*Analytics, error)

func (*Analytics) Report

func (a *Analytics) Report(ctx context.Context, e Event) (Event, error)

type AppID

type AppID string

func (AppID) IsValid

func (a AppID) IsValid() bool

type Config

type Config struct {
	Log *zap.SugaredLogger

	CredentialsJSON string
	Environment     string
}

type Event

type Event struct {
	AppID                AppID                  `firestore:"app_id"`
	SessionID            string                 `firestore:"session_id"`
	PayloadType          string                 `firestore:"payload_type"`
	PayloadSchemaVersion int                    `firestore:"payload_schema_version"`
	Payload              map[string]interface{} `firestore:"payload"`
	URI                  string                 `firestore:"uri_path"`
	Timestamp            time.Time              `firestore:"timestamp"`
	InstallationID       string                 `firestore:"installation_id"`
	EnvironmentClass     string                 `firestore:"env_class"`
}

func (*Event) CollectionName

func (e *Event) CollectionName() string

CollectionName creates a firestore collection name based on the year, month, and environment type (stable, testing).

type Reporter

type Reporter interface {
	Report(ctx context.Context, event Event) (Event, error)
}