github.com/TykTechnologies/tyk/internal/event

Package

Files: 1. Third party imports: 0. Imports from organisation: 0. Tests: 0. Benchmarks: 0.

Constants

const (
	// QuotaExceeded is the event triggered when quota for a specific key has been exceeded.
	QuotaExceeded	Event	= "QuotaExceeded"
	// AuthFailure is the event triggered when key has failed authentication or has attempted access and was denied.
	AuthFailure	Event	= "AuthFailure"
	// UpstreamOAuthError is the event triggered when an upstream OAuth error occurs.
	UpstreamOAuthError	Event	= "UpstreamOAuthError"
	// KeyExpired is the event triggered when a key has attempted access but is expired.
	KeyExpired	Event	= "KeyExpired"
	// VersionFailure is the event triggered when a key has attempted access to a version it does not have permission to access.
	VersionFailure	Event	= "VersionFailure"
	// OrgQuotaExceeded is the event triggered when a quota for a specific organisation has been exceeded.
	OrgQuotaExceeded	Event	= "OrgQuotaExceeded"
	// OrgRateLimitExceeded is the event triggered when rate limit has been exceeded for a specific organisation.
	OrgRateLimitExceeded	Event	= "OrgRateLimitExceeded"
	// TriggerExceeded is the event triggered on a configured trigger point.
	TriggerExceeded	Event	= "TriggerExceeded"
	// BreakerTriggered is the event triggered when either a BreakerTripped, or a BreakerReset event occurs;
	// a status code in the metadata passed to the event handler will indicate which of these events was triggered.
	BreakerTriggered	Event	= "BreakerTriggered"
	// BreakerTripped is the event triggered when a circuit breaker on a path trips and a service is taken offline.
	BreakerTripped	Event	= "BreakerTripped"
	// BreakerReset is the event triggered when the circuit breaker comes back on-stream
	BreakerReset	Event	= "BreakerReset"
	// HostDown is the event triggered when hostchecker finds a host is down/not available.
	HostDown	Event	= "HostDown"
	// HostUp is the event triggered when hostchecker finds a host is back being available after being offline.
	HostUp	Event	= "HostUp"
	// TokenCreated is the event triggered when a token is created.
	TokenCreated	Event	= "TokenCreated"
	// TokenUpdated is the event triggered when a token is updated.
	TokenUpdated	Event	= "TokenUpdated"
	// TokenDeleted is the event triggered when a token is deleted.
	TokenDeleted	Event	= "TokenDeleted"
)

// Rate limiter events
const (
	// RateLimitExceeded is the event triggered when rate limit has been exceeded for a specific key.
	RateLimitExceeded	Event	= "RatelimitExceeded"

	// RateLimitSmoothingUp is the event triggered when rate limit smoothing increases the currently enforced rate limit.
	RateLimitSmoothingUp	Event	= "RateLimitSmoothingUp"

	// RateLimitSmoothingDown is the event triggered when rate limit smoothing decreases the currently enforced rate limit.
	RateLimitSmoothingDown	Event	= "RateLimitSmoothingDown"
)

const (
	// LogHandler is the HandlerName used in classic API definition for log event handler.
	LogHandler	HandlerName	= "eh_log_handler"
	// WebHookHandler is the HandlerName used in classic API definition for webhook event handler.
	WebHookHandler	HandlerName	= "eh_web_hook_handler"
	// JSVMHandler is the HandlerName used in classic API definition for javascript event handler.
	JSVMHandler	HandlerName	= "eh_dynamic_handler"
	// CoProcessHandler is the HandlerName used in classic API definition for coprocess event handler.
	CoProcessHandler	HandlerName	= "cp_dynamic_handler"
)

const (
	// WebhookKind is the action to be specified in OAS API definition.
	WebhookKind	Kind	= "webhook"
	// JSVMKind represents a custom action to be executed when an event is triggered.
	JSVMKind	Kind	= "custom"
	// LogKind represents a log action to be performed when an event is triggered.
	LogKind	Kind	= "log"
)

const eventContextKey contextKey = "events"

Vars

eventMap contains a map of events to a readable title for the event. The title value should not contain ending punctuation.

var eventMap = map[Event]string{
	RateLimitSmoothingUp:	"Rate limit increased with smoothing",
	RateLimitSmoothingDown:	"Rate limit decreased with smoothing",
}

Types

Event

type Event string

HandlerName

type HandlerName string

Kind

type Kind string

contextKey

type contextKey string

Functions

func Add

func Add(r *http.Request, event Event) {
	ctx := r.Context()

	events := Get(ctx)
	events = append(events, event)

	*r = *(r.WithContext(Set(ctx, events)))
}

func EncodeRequestToEvent

func EncodeRequestToEvent(r *http.Request) string {
	var asBytes bytes.Buffer
	err := r.Write(&asBytes)
	if err != nil {
		return ""
	}

	return base64.StdEncoding.EncodeToString(asBytes.Bytes())
}

func Get

func Get(ctx context.Context) []Event {
	if v, ok := ctx.Value(eventContextKey).([]Event); ok {
		return v
	}
	return nil
}

func Set

func Set(ctx context.Context, events []Event) context.Context {
	return context.WithValue(ctx, eventContextKey, events)
}

func String

func String(e Event) string {
	v, ok := eventMap[e]
	if ok {
		return v
	}
	return string(e)
}

Tests

Files: 1. Third party imports: 1. Imports from organisation: 0. Tests: 2. Benchmarks: 0.

Test functions

TestAddEventToRequest

TestEventToString