quota

Documentation

Index

• Variables
• type Context
  • func FromContext(ctx context.Context, targetToSrv *TargetToSrv) Context
• type Item
• type Map
  • func (m *Map) Get(tag Tag) (int64, bool)
  • func (m *Map) Iter() <-chan Item
  • func (m *Map) Merge(l2 *Map)
  • func (m *Map) Scopes() (map[Scope]struct{}, error)
  • func (m *Map) Services() (map[TargetSrv]struct{}, error)
  • func (m *Map) Set(tag Tag, limit int64)
  • func (m *Map) Targets() (map[Target]struct{}, error)
• type NewUsageReporter
• type Quota
• type QuotaDTO
  • func (dto QuotaDTO) Tag() (Tag, error)
• type Scope
  • func (s Scope) Validate() error
• type ScopeParameters
• type Service
• type Tag
  • func NewTag(srv TargetSrv, t Target, scope Scope) (Tag, error)
  • func (t Tag) GetScope() (Scope, error)
  • func (t Tag) GetSrv() (TargetSrv, error)
  • func (t Tag) GetTarget() (Target, error)
• type Target
• type TargetSrv
• type TargetToSrv
  • func NewTargetToSrv() *TargetToSrv
  • func (m *TargetToSrv) Get(target Target) (TargetSrv, bool)
  • func (m *TargetToSrv) Set(target Target, srv TargetSrv)
• type UpdateQuotaCmd
• type UsageReporterFunc

Variables

var ErrBadRequest = errutil.BadRequest("quota.bad-request")

var ErrDisabled = errutil.Forbidden("quota.disabled", errutil.WithPublicMessage("Quotas not enabled"))

var ErrFailedToGetScope = errutil.Internal("quota.failed-get-scope")

var ErrInvalidScope = errutil.BadRequest("quota.invalid-scope")

var ErrInvalidTagFormat = errutil.Internal("quota.invalid-invalid-tag-format")

var ErrInvalidTarget = errutil.Internal("quota.invalid-target-table")

var ErrInvalidTargetSrv = errutil.BadRequest("quota.invalid-target")

var ErrTargetSrvConflict = errutil.BadRequest("quota.target-srv-conflict")

var ErrUsageFoundForTarget = errutil.NotFound("quota.missing-target-usage")

Types

type Context

type Context struct {
	context.Context
	TargetToSrv *TargetToSrv
}

func FromContext

func FromContext(ctx context.Context, targetToSrv *TargetToSrv) Context

type Item

type Item struct {
	Tag   Tag
	Value int64
}

type Map

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

func (*Map) Get

func (m *Map) Get(tag Tag) (int64, bool)

func (*Map) Iter

func (m *Map) Iter() <-chan Item

func (*Map) Merge

func (m *Map) Merge(l2 *Map)

func (*Map) Scopes

func (m *Map) Scopes() (map[Scope]struct{}, error)

func (*Map) Services

func (m *Map) Services() (map[TargetSrv]struct{}, error)

func (*Map) Set

func (m *Map) Set(tag Tag, limit int64)

func (*Map) Targets

func (m *Map) Targets() (map[Target]struct{}, error)

type NewUsageReporter

type NewUsageReporter struct {
	TargetSrv     TargetSrv
	DefaultLimits *Map
	Reporter      UsageReporterFunc
}

type Quota

type Quota struct {
	Id      int64
	OrgId   int64
	UserId  int64
	Target  string
	Limit   int64
	Created time.Time
	Updated time.Time
}

type QuotaDTO

type QuotaDTO struct {
	OrgId   int64  `json:"org_id,omitempty"`
	UserId  int64  `json:"user_id,omitempty"`
	Target  string `json:"target"`
	Limit   int64  `json:"limit"`
	Used    int64  `json:"used"`
	Service string `json:"-"`
	Scope   string `json:"-"`
}

func (QuotaDTO) Tag

func (dto QuotaDTO) Tag() (Tag, error)

type Scope

type Scope string

const (
	GlobalScope Scope = "global"
	OrgScope    Scope = "org"
	UserScope   Scope = "user"
)

func (Scope) Validate

func (s Scope) Validate() error

type ScopeParameters

type ScopeParameters struct {
	OrgID  int64
	UserID int64
}

type Service

type Service interface {
	// GetQuotasByScope returns the quota for the specific scope (global, organization, user)
	// If the scope is organization, the ID is expected to be the organisation ID.
	// If the scope is user, the id is expected to be the user ID.
	GetQuotasByScope(ctx context.Context, scope Scope, ID int64) ([]QuotaDTO, error)
	// Update overrides the quota for a specific scope (global, organization, user).
	// If the cmd.OrgID is set, then the organization quota are updated.
	// If the cmd.UseID is set, then the user quota are updated.
	Update(ctx context.Context, cmd *UpdateQuotaCmd) error
	// QuotaReached is called by the quota middleware for applying quota enforcement to API handlers
	QuotaReached(c *contextmodel.ReqContext, targetSrv TargetSrv) (bool, error)
	// CheckQuotaReached checks if the quota limitations have been reached for a specific service
	CheckQuotaReached(ctx context.Context, targetSrv TargetSrv, scopeParams *ScopeParameters) (bool, error)
	// DeleteQuotaForUser deletes custom quota limitations for the user
	DeleteQuotaForUser(ctx context.Context, userID int64) error

	// RegisterQuotaReporter registers a service UsageReporterFunc, targets and their default limits
	RegisterQuotaReporter(e *NewUsageReporter) error
}

type Tag

type Tag string

Tag is a string with the format <srv>:<target>:<scope>

func NewTag

func NewTag(srv TargetSrv, t Target, scope Scope) (Tag, error)

func (Tag) GetScope

func (t Tag) GetScope() (Scope, error)

func (Tag) GetSrv

func (t Tag) GetSrv() (TargetSrv, error)

func (Tag) GetTarget

func (t Tag) GetTarget() (Target, error)

type Target

type Target string

type TargetSrv

type TargetSrv string

type TargetToSrv

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

func NewTargetToSrv

func NewTargetToSrv() *TargetToSrv

func (*TargetToSrv) Get

func (m *TargetToSrv) Get(target Target) (TargetSrv, bool)

func (*TargetToSrv) Set

func (m *TargetToSrv) Set(target Target, srv TargetSrv)

type UpdateQuotaCmd

type UpdateQuotaCmd struct {
	Target string `json:"target"`
	Limit  int64  `json:"limit"`
	OrgID  int64  `json:"-"`
	UserID int64  `json:"-"`
}

type UsageReporterFunc

type UsageReporterFunc func(ctx context.Context, scopeParams *ScopeParameters) (*Map, error)