budget

Documentation

Overview

Package budget holds each gateway key to the limits its owner set (#585): the tokens or estimated cost it may use in a window. While a key has a limit, it stays on.

It is the limiter of the gateway's budget point (P3 of docs/subsystems/plugin-runtime.md): Apply serves internal/budget's, and the point fails closed: a request of a key held to a limit is not sent while no limiter serves it. What a key has used is the core's, read from the usage records, so the Settings page, `magpie keys` and /v1/magpie/limit tell it either way.

Index

• func InUse() (int, error)

Functions

func InUse

func InUse() (int, error)

InUse counts the gateway keys held to a limit; caller-keys.json that can't be read is not known, so it stays on.