dashboard

Documentation

Index

• Constants
• func NewHistoryError(recordType RecordType, historyFile string) error
• type ApiHistoryItem
• type ApiSpec
• type BaseResourceSpec
• type Bucket
• type BucketSpec
• type Dashboard
  • func New(noBrowser bool, localCloud *cloud.LocalCloud, project *project.Project) (*Dashboard, error)
  • func (d *Dashboard) DeleteHistoryRecord(recordType RecordType) error
  • func (d *Dashboard) GetDashboardUrl() string
  • func (d *Dashboard) ReadAllHistoryRecords() (*HistoryEvents, error)
  • func (d *Dashboard) Start() error
• type DashboardResponse
• type HistoryEvent
  • func ReadHistoryRecords[T HistoryItem](projectDir string, recordType RecordType) ([]*HistoryEvent[T], error)
• type HistoryEvents
• type HistoryItem
• type HttpProxySpec
• type KeyValueSpec
• type NotifierSpec
• type Param
• type PolicyResource
• type PolicySpec
• type QueueSpec
• type RecordType
• type RequestHistory
• type ResponseHistory
• type SQLDatabaseSpec
• type ScheduleHistoryItem
• type ScheduleSpec
• type ServiceSpec
• type SubscriberSpec
• type TopicHistoryItem
• type TopicSpec
• type WebsocketSpec

Constants

const AddRecordTopic = "history:addrecord"

Functions

func NewHistoryError

func NewHistoryError(recordType RecordType, historyFile string) error

Types

type ApiHistoryItem

type ApiHistoryItem struct {
	Api      string           `json:"api"`
	Request  *RequestHistory  `json:"request"`
	Response *ResponseHistory `json:"response"`
}

type ApiSpec

type ApiSpec struct {
	*BaseResourceSpec

	OpenApiSpec *openapi3.T `json:"spec"`
}

type BaseResourceSpec

type BaseResourceSpec struct {
	Name string `json:"name"`
	// TODO: Remove this field
	RequestingServices []string `json:"requestingServices"`
}

type Bucket

type Bucket struct {
	Name         string     `json:"name,omitempty"`
	CreationDate *time.Time `json:"creationDate,omitempty"`
}

type BucketSpec

type BucketSpec struct {
	*BaseResourceSpec
}

type Dashboard

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

func New

func New(noBrowser bool, localCloud *cloud.LocalCloud, project *project.Project) (*Dashboard, error)

func (*Dashboard) DeleteHistoryRecord

func (d *Dashboard) DeleteHistoryRecord(recordType RecordType) error

func (*Dashboard) GetDashboardUrl

func (d *Dashboard) GetDashboardUrl() string

func (*Dashboard) ReadAllHistoryRecords

func (d *Dashboard) ReadAllHistoryRecords() (*HistoryEvents, error)

func (*Dashboard) Start

func (d *Dashboard) Start() error

type DashboardResponse

type DashboardResponse struct {
	Apis          []ApiSpec          `json:"apis"`
	Buckets       []*BucketSpec      `json:"buckets"`
	Schedules     []ScheduleSpec     `json:"schedules"`
	Topics        []*TopicSpec       `json:"topics"`
	Websockets    []WebsocketSpec    `json:"websockets"`
	Subscriptions []*SubscriberSpec  `json:"subscriptions"`
	Notifications []*NotifierSpec    `json:"notifications"`
	Stores        []*KeyValueSpec    `json:"stores"`
	SQLDatabases  []*SQLDatabaseSpec `json:"sqlDatabases"`
	Queues        []*QueueSpec       `json:"queues"`
	HttpProxies   []*HttpProxySpec   `json:"httpProxies"`

	Services []*ServiceSpec `json:"services"`

	Policies            map[string]PolicySpec `json:"policies"`
	ProjectName         string                `json:"projectName"`
	ApiAddresses        map[string]string     `json:"apiAddresses"`
	WebsocketAddresses  map[string]string     `json:"websocketAddresses"`
	HttpWorkerAddresses map[string]string     `json:"httpWorkerAddresses"`
	TriggerAddress      string                `json:"triggerAddress"`
	StorageAddress      string                `json:"storageAddress"`
	CurrentVersion      string                `json:"currentVersion"`
	LatestVersion       string                `json:"latestVersion"`
	Connected           bool                  `json:"connected"`
}

type HistoryEvent

type HistoryEvent[Event HistoryItem] struct {
	Time       int64      `json:"time,omitempty"`
	Event      Event      `json:"event"`
	RecordType RecordType `json:"-"`
}

func ReadHistoryRecords

func ReadHistoryRecords[T HistoryItem](projectDir string, recordType RecordType) ([]*HistoryEvent[T], error)

type HistoryEvents

type HistoryEvents struct {
	ScheduleHistory []*HistoryEvent[ScheduleHistoryItem] `json:"schedules"`
	TopicHistory    []*HistoryEvent[TopicHistoryItem]    `json:"topics"`
	ApiHistory      []*HistoryEvent[ApiHistoryItem]      `json:"apis"`
}

type HistoryItem

type HistoryItem interface {
	ApiHistoryItem | TopicHistoryItem | ScheduleHistoryItem | any
}

type HttpProxySpec

type HttpProxySpec struct {
	*BaseResourceSpec

	Target string `json:"target"`
}

type KeyValueSpec

type KeyValueSpec struct {
	*BaseResourceSpec
}

type NotifierSpec

type NotifierSpec struct {
	Bucket string `json:"bucket"`
	Target string `json:"target"`
}

type Param

type Param struct {
	Key   string `json:"key,omitempty"`
	Value string `json:"value,omitempty"`
}

type PolicyResource

type PolicyResource struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

type PolicySpec

type PolicySpec struct {
	*BaseResourceSpec

	Principals []PolicyResource `json:"principals"`
	Actions    []string         `json:"actions"`
	Resources  []PolicyResource `json:"resources"`
}

type QueueSpec

type QueueSpec struct {
	*BaseResourceSpec
}

type RecordType

type RecordType string

const (
	API      RecordType = "apis"
	TOPIC    RecordType = "topics"
	SCHEDULE RecordType = "schedules"
)

type RequestHistory

type RequestHistory struct {
	Method      string              `json:"method"`
	Path        string              `json:"path"`
	QueryParams []Param             `json:"queryParams"`
	PathParams  []Param             `json:"pathParams"`
	Body        []byte              `json:"body"`
	Headers     map[string][]string `json:"headers"`
}

Only log what is required from req/resp to avoid massive log files

type ResponseHistory

type ResponseHistory struct {
	Data    interface{}         `json:"data"`
	Status  int32               `json:"status"`
	Size    int                 `json:"size"`
	Time    int64               `json:"time"`
	Headers map[string][]string `json:"headers"`
}

type SQLDatabaseSpec

type SQLDatabaseSpec struct {
	*BaseResourceSpec
}

type ScheduleHistoryItem

type ScheduleHistoryItem struct {
	Name    string `json:"name,omitempty"`
	Success bool   `json:"success,omitempty"`
}

type ScheduleSpec

type ScheduleSpec struct {
	*BaseResourceSpec

	Expression string `json:"expression,omitempty"`
	Rate       string `json:"rate,omitempty"`
	Target     string `json:"target,omitempty"`
}

type ServiceSpec

type ServiceSpec struct {
	*BaseResourceSpec

	FilePath string `json:"filePath"`
}

type SubscriberSpec

type SubscriberSpec struct {
	Topic  string `json:"topic"`
	Target string `json:"target"`
}

type TopicHistoryItem

type TopicHistoryItem struct {
	Name    string `json:"name,omitempty"`
	Delay   int    `json:"delay,omitempty"`
	Payload string `json:"payload,omitempty"`
	Success bool   `json:"success,omitempty"`
}

type TopicSpec

type TopicSpec struct {
	*BaseResourceSpec
}

type WebsocketSpec

type WebsocketSpec struct {
	*BaseResourceSpec

	Targets map[string]string `json:"targets,omitempty"`
}