lib

Documentation

Index

• Constants
• Variables
• func GetMetricsPath(route string) string
• func GetOptimisticBucketPath(url string, method string) string
• func GetSnowflakeCreatedAt(snowflake string) (time.Time, error)
• func HashCRC64(data string) uint64
• func IsNumericInput(str string) bool
• func IsSnowflake(str string) bool
• func SetLogger(l *logrus.Logger)
• func StartMetrics()
• type QueueChannel
• type QueueItem
• type RequestQueue
  • func NewRequestQueue(processor func(item *QueueItem) *http.Response, globalLimit uint) *RequestQueue
  • func (q *RequestQueue) Queue(req *http.Request, res *http.ResponseWriter) (string, *http.Response, error)

Constants

const (
	MajorUnknown      = "unk"
	MajorChannels     = "channels"
	MajorGuilds       = "guilds"
	MajorWebhooks     = "webhooks"
	MajorInvites      = "invites"
	MajorInteractions = "interactions"
)

const EpochDiscord = 1420070400000

const QueueChannelBufferSize = 200

QueueChannelBufferSize Defines the size of the request channel buffer for each bucket Realistically, this should be as high as possible to prevent blocking sends While blocking sends aren't a problem in itself, they are unordered, meaning in a high load situation, if this number is too low, it would cause requests to fight to send, which messes up the ordering of requests.

Variables

var (
	ErrorCounter = promauto.NewCounter(prometheus.CounterOpts{
		Name: "nirn_proxy_error",
		Help: "The total number of errors when processing requests",
	})

	RequestSummary = prometheus.NewSummaryVec(prometheus.SummaryOpts{
		Name:       "nirn_proxy_requests",
		Help:       "Request histogram",
		Objectives: map[float64]float64{0.5: 0.05, 0.9: 0.01, 0.99: 0.001},
	}, []string{"method", "status", "route", "clientId"})
)

Functions

func GetMetricsPath

func GetMetricsPath(route string) string

func GetOptimisticBucketPath

func GetOptimisticBucketPath(url string, method string) string

func GetSnowflakeCreatedAt

func GetSnowflakeCreatedAt(snowflake string) (time.Time, error)

func HashCRC64

func HashCRC64(data string) uint64

func IsNumericInput

func IsNumericInput(str string) bool

func IsSnowflake

func IsSnowflake(str string) bool

func SetLogger

func SetLogger(l *logrus.Logger)

func StartMetrics

func StartMetrics()

Types

type QueueChannel

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

type QueueItem

type QueueItem struct {
	Req *http.Request
	Res *http.ResponseWriter
	// contains filtered or unexported fields
}

type RequestQueue

type RequestQueue struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewRequestQueue

func NewRequestQueue(processor func(item *QueueItem) *http.Response, globalLimit uint) *RequestQueue

func (*RequestQueue) Queue

func (q *RequestQueue) Queue(req *http.Request, res *http.ResponseWriter) (string, *http.Response, error)