appmetrics

Documentation

Index

• Variables
• type AppMetric
• type AppMetricEventType
• type AppMetricValidationError
• type Database
  • func NewDB(db *sql.DB) *Database
  • func (db Database) Close() error
  • func (db *Database) GetAppMetrics(limit int, offset int) (page Page, err error)
  • func (db *Database) SaveAppMetrics(appMetrics []AppMetric, sessionID string) (err error)
  • func (db *Database) ValidateAppMetrics(appMetrics []AppMetric) (err error)
• type Page

Variables

var EventSchemaMap = map[AppMetricEventType]interface{}{
	NavigateTo:         NavigateToCofxSchema,
	ScreensOnWillFocus: NavigateToCofxSchema,
}

EventSchemaMap Every event should have a schema attached

var NavigateToCofxSchema = map[string]interface{}{
	"type": "object",
	"properties": map[string]interface{}{
		"view_id": map[string]interface{}{
			"type":      "string",
			"maxLength": 32,
		},
		"params": map[string]interface{}{
			"type": "object",
			"properties": map[string]interface{}{
				"screen": map[string]interface{}{
					"type":      "string",
					"maxLength": 32,
				},
			},
			"additionalProperties": false,
			"required":             []string{"screen"},
		},
	},
	"additionalProperties": false,
	"required":             []string{"view_id", "params"},
}

Types

type AppMetric

type AppMetric struct {
	Event      AppMetricEventType `json:"event"`
	Value      json.RawMessage    `json:"value"`
	AppVersion string             `json:"app_version"`
	OS         string             `json:"os"`
	SessionID  string             `json:"session_id"`
	CreatedAt  string             `json:"created_at"`
}

Value is `json.RawMessage` so we can send any json shape, including strings Validation is handled using JSON schemas defined in validators.go, instead of Golang structs

type AppMetricEventType

type AppMetricEventType string

const (
	// status-react navigation events
	NavigateTo         AppMetricEventType = "navigate-to"
	ScreensOnWillFocus AppMetricEventType = "screens/on-will-focus"
)

type AppMetricValidationError

type AppMetricValidationError struct {
	Metric AppMetric
	Errors []gojsonschema.ResultError
}

type Database

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

Database sql wrapper for operations with browser objects.

func NewDB

func NewDB(db *sql.DB) *Database

func (Database) Close

func (db Database) Close() error

Close closes database.

func (*Database) GetAppMetrics

func (db *Database) GetAppMetrics(limit int, offset int) (page Page, err error)

func (*Database) SaveAppMetrics

func (db *Database) SaveAppMetrics(appMetrics []AppMetric, sessionID string) (err error)

func (*Database) ValidateAppMetrics

func (db *Database) ValidateAppMetrics(appMetrics []AppMetric) (err error)

type Page

type Page struct {
	AppMetrics []AppMetric
	TotalCount int
}