dashboard

Documentation

Index

• func DeleteHistoryRecord(stackName string, recordType RecordType) error
• func NewHistoryError(recordType RecordType, historyFile string) error
• func WriteHistoryRecord(stackName string, recordType RecordType, historyRecord *HistoryRecord) error
• type Api
• type ApiHistoryItem
• type Bucket
• type Dashboard
  • func New(p *project.Project, envMap map[string]string) (*Dashboard, error)
  • func (d *Dashboard) AddBucket(name string)
  • func (d *Dashboard) Refresh(opts *RefreshOptions) error
  • func (d *Dashboard) Serve(sp storage.StorageService) (*int, error)
• type DashboardResponse
• type EventHistoryItem
• type History
  • func ReadAllHistoryRecords(stackName string) (*History, error)
• type HistoryRecord
  • func ReadHistoryRecords(stackName string, recordType RecordType) ([]*HistoryRecord, error)
• type Param
• type RecordType
• type RefreshOptions
• type RequestHistory
• type ResponseHistory
• type TriggerType

Functions

func DeleteHistoryRecord

func DeleteHistoryRecord(stackName string, recordType RecordType) error

func NewHistoryError

func NewHistoryError(recordType RecordType, historyFile string) error

func WriteHistoryRecord

func WriteHistoryRecord(stackName string, recordType RecordType, historyRecord *HistoryRecord) error

Types

type Api

type Api struct {
	Name    string                 `json:"name,omitempty"`
	OpenApi map[string]interface{} `json:"spec,omitempty"` // not sure which spec version yet
}

type ApiHistoryItem

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

type Bucket

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

type Dashboard

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

func New

func New(p *project.Project, envMap map[string]string) (*Dashboard, error)

func (*Dashboard) AddBucket

func (d *Dashboard) AddBucket(name string)

func (*Dashboard) Refresh

func (d *Dashboard) Refresh(opts *RefreshOptions) error

func (*Dashboard) Serve

func (d *Dashboard) Serve(sp storage.StorageService) (*int, error)

type DashboardResponse

type DashboardResponse struct {
	Apis                []*openapi3.T                    `json:"apis,omitempty"`
	Buckets             []string                         `json:"buckets,omitempty"`
	Schedules           []*codeconfig.TopicResult        `json:"schedules,omitempty"`
	Topics              []*codeconfig.TopicResult        `json:"topics,omitempty"`
	ProjectName         string                           `json:"projectName,omitempty"`
	ApiAddresses        map[string]string                `json:"apiAddresses,omitempty"`
	TriggerAddress      string                           `json:"triggerAddress,omitempty"`
	StorageAddress      string                           `json:"storageAddress,omitempty"`
	BucketNotifications []*codeconfig.BucketNotification `json:"bucketNotifications,omitempty"`
}

type EventHistoryItem

type EventHistoryItem struct {
	Event   *codeconfig.TopicResult `json:"event,omitempty"`
	Payload string                  `json:"payload,omitempty"`
}

type History

type History struct {
	ScheduleHistory []*HistoryRecord `json:"scheduleHistory,omitempty"`
	TopicHistory    []*HistoryRecord `json:"topicHistory,omitempty"`
	ApiHistory      []*HistoryRecord `json:"apiHistory,omitempty"`
}

func ReadAllHistoryRecords

func ReadAllHistoryRecords(stackName string) (*History, error)

type HistoryRecord

type HistoryRecord struct {
	Time    int64 `json:"time,omitempty"`
	Success bool  `json:"success,omitempty"`
	EventHistoryItem
	ApiHistoryItem
}

func ReadHistoryRecords

func ReadHistoryRecords(stackName string, recordType RecordType) ([]*HistoryRecord, error)

type Param

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

type RecordType

type RecordType string

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

type RefreshOptions

type RefreshOptions struct {
	Pool            pool.WorkerPool
	TriggerAddress  string
	StorageAddress  string
	ApiAddresses    map[string]string
	ServiceListener net.Listener
}

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 TriggerType

type TriggerType string