admin

Documentation

Index

• func StartWebServer(data *Data) error
• type Auth
• type Data
• type Hasher
• type LogProvider
• type OneKeyRetriever
• type PrValidator
• type ProjectConfigValidator
  • func NewProjectConfigValidator(projects string) (*ProjectConfigValidator, error)
  • func (pv *ProjectConfigValidator) Check(pr string) bool
  • func (pv *ProjectConfigValidator) Projects() []string
• type UsageReseter
• type UsageRestorer

Functions

func StartWebServer

func StartWebServer(data *Data) error

StartWebServer starts the HTTP service and listens for the admin requests

Types

type Auth

type Auth interface {
	ValidateToken(ctx context.Context, token string) (model.User, error)
}

type Data

type Data struct {
	Port         int
	OneKeyGetter OneKeyRetriever
	LogProvider  LogProvider
	// logProvider       LogProvider
	UsageRestorer    UsageRestorer
	UsageReseter     UsageReseter
	ProjectValidator PrValidator
	Auth             echo.MiddlewareFunc
	Hasher           Hasher

	CmsData *cms.Data
}

Data is service operation data

type Hasher

type Hasher interface {
	HashKey(key string) string
}

type LogProvider

type LogProvider interface {
	GetLogs(ctx context.Context, user *model.User, keyID string) ([]*adminapi.Log, error)
	ListLogs(ctx context.Context, project string, to time.Time) ([]*adminapi.Log, error)
	DeleteLogs(ctx context.Context, project string, to time.Time) (int, error)
}

LogRetriever retrieves one list from db

type OneKeyRetriever

type OneKeyRetriever interface {
	Get(ctx context.Context, user *model.User, id string) (*adminapi.Key, error)
}

type PrValidator

type PrValidator interface {
	Check(string) bool
	Projects() []string
}

PrValidator validates if project is available

type ProjectConfigValidator

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

ProjectConfigValidator loads available projects from config

func NewProjectConfigValidator

func NewProjectConfigValidator(projects string) (*ProjectConfigValidator, error)

NewProjectConfigValidator creates project validator, reads available projects from config

func (*ProjectConfigValidator) Check

func (pv *ProjectConfigValidator) Check(pr string) bool

Check tests if project is available

func (*ProjectConfigValidator) Projects

func (pv *ProjectConfigValidator) Projects() []string

Projects returns all supported projects

type UsageReseter

type UsageReseter interface {
	Reset(ctx context.Context, project string, since time.Time, limit float64) error
}

UsageReseter resets montly usage

type UsageRestorer

type UsageRestorer interface {
	RestoreUsage(ctx context.Context, project string, manual bool, request string, errorMsg string) error

} // OneKeyRetriever retrieves one list from db

UsageRestorer restores key usage by requestID