tokencache

Documentation

Index

• Variables
• type Cache
  • func New(base token.Token, expiry time.Duration) *Cache
  • func (c *Cache) GetKey(ctx context.Context, keyName string) (token.Key, error)
• type Metrics
  • func (m Metrics) GetKey(ctx context.Context, keyName string) (key token.Key, err error)
  • func (m Metrics) Ping(ctx context.Context) (err error)
• type RateLimited
  • func NewLimiter(base token.Token, limit float64, burst int) *RateLimited
  • func (r *RateLimited) GetKey(ctx context.Context, keyName string) (token.Key, error)

Variables

var (
	MetricOperations = promauto.NewHistogramVec(
		prometheus.HistogramOpts{
			Name:    "token_operation_seconds",
			Help:    "A histogram of latencies for token operations",
			Buckets: buckets,
		},
		[]string{"token", "op"},
	)
	MetricResponses = promauto.NewCounterVec(
		prometheus.CounterOpts{
			Name: "token_responses",
			Help: "Response codes from token operations",
		},
		[]string{"token", "op", "code"},
	)
)

Types

type Cache

type Cache struct {
	token.Token
	// contains filtered or unexported fields
}

Cache keys fetched from an underlying token

func New

func New(base token.Token, expiry time.Duration) *Cache

func (*Cache) GetKey

func (c *Cache) GetKey(ctx context.Context, keyName string) (token.Key, error)

type Metrics

type Metrics struct {
	token.Token
}

Metrics wraps a token and updates metrics when methods are called

func (Metrics) GetKey

func (m Metrics) GetKey(ctx context.Context, keyName string) (key token.Key, err error)

func (Metrics) Ping

func (m Metrics) Ping(ctx context.Context) (err error)

type RateLimited

type RateLimited struct {
	token.Token
	// contains filtered or unexported fields
}

func NewLimiter

func NewLimiter(base token.Token, limit float64, burst int) *RateLimited

func (*RateLimited) GetKey

func (r *RateLimited) GetKey(ctx context.Context, keyName string) (token.Key, error)