New ratelimiting implementation

CONFIG.md

@@ -75,6 +75,13 @@ Default: false
 
 In the future, this will be the only possible behavior.
 
+##### ALLOW_CONCURRENT_REQUESTS
+Allows nirn to perform concurrent requests to Discord endpoints, instead of one at a time per queue. This might have the unintended side effect of a small increase in 429's if Discord updates buckets on the fly.
+
+If you do not care about throughput or do not make a lot of requests to the same endpoint that might take Discord a while to answer, then it would be fine to keep this off.
+
+Default: true
+
 ## Unstable env vars
 Collection of env vars that may be removed at any time, mainly used for Discord introducing new behaviour on their edge api versions
 

Dockerfile

@@ -1,13 +1,17 @@
-FROM golang:alpine as app-builder
+FROM --platform=$BUILDPLATFORM golang:alpine as app-builder
 WORKDIR /go/src/app
 COPY . .
-RUN CGO_ENABLED=0 go install -ldflags '-extldflags "-static"' -tags timetzdata -buildvcs=false
+
+ARG TARGETOS
+ARG TARGETARCH
+
+RUN CGO_ENABLED=0 GOOS=$TARGETOS GOARCH=$TARGETARCH go build -ldflags '-extldflags "-static"' -tags timetzdata -buildvcs=false
 
 FROM scratch
-COPY --from=app-builder /go/bin/nirn-proxy /nirn-proxy
+COPY --from=app-builder /go/src/app/nirn-proxy /nirn-proxy
 # the tls certificates:
 # NB: this pulls directly from the upstream image, which already has ca-certificates:
 COPY --from=alpine:latest /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
 EXPOSE 9000
 EXPOSE 8080
-ENTRYPOINT ["/nirn-proxy"]
+ENTRYPOINT ["/nirn-proxy"]

README.md

@@ -24,26 +24,27 @@ The proxy sits between the client and discord. Instead of pointing to discord.co
 
 Configuration options are
 
-| Variable        | Value                                       | Default |
-|-----------------|---------------------------------------------|---------|
-| LOG_LEVEL       | panic, fatal, error, warn, info, debug, trace | info    |
-| PORT            | number                                      | 8080    |
-| METRICS_PORT    | number                                      | 9000    |
-| ENABLE_METRICS  | boolean                                     | true    |
-| ENABLE_PPROF    | boolean                                     | false   |
-| BUFFER_SIZE     | number                                      | 50      |
-| OUTBOUND_IP     | string                                      | ""      |
-| BIND_IP         | string                                      | 0.0.0.0 |
-| REQUEST_TIMEOUT | number (milliseconds)                       | 5000    |
-| CLUSTER_PORT    | number                                      | 7946    |
-| CLUSTER_MEMBERS | string list (comma separated)               | ""      |
-| CLUSTER_DNS     | string                                      | ""      |
-| MAX_BEARER_COUNT| number                                      | 1024    |
-| DISABLE_HTTP_2  | bool                                        | true    |
-| BOT_RATELIMIT_OVERRIDES | string list (comma separated)       | ""      |
-| DISABLE_GLOBAL_RATELIMIT_DETECTION | boolean                  | false   |
-
-Information on each config var can be found [here](https://github.com/germanoeich/nirn-proxy/blob/main/CONFIG.md)
+| Variable                           | Value                                         | Default |
+|------------------------------------|-----------------------------------------------|---------|
+| LOG_LEVEL                          | panic, fatal, error, warn, info, debug, trace | info    |
+| PORT                               | number                                        | 8080    |
+| METRICS_PORT                       | number                                        | 9000    |
+| ENABLE_METRICS                     | boolean                                       | true    |
+| ENABLE_PPROF                       | boolean                                       | false   |
+| BUFFER_SIZE                        | number                                        | 50      |
+| OUTBOUND_IP                        | string                                        | ""      |
+| BIND_IP                            | string                                        | 0.0.0.0 |
+| REQUEST_TIMEOUT                    | number (milliseconds)                         | 5000    |
+| CLUSTER_PORT                       | number                                        | 7946    |
+| CLUSTER_MEMBERS                    | string list (comma separated)                 | ""      |
+| CLUSTER_DNS                        | string                                        | ""      |
+| MAX_BEARER_COUNT                   | number                                        | 1024    |
+| DISABLE_HTTP_2                     | bool                                          | true    |
+| BOT_RATELIMIT_OVERRIDES            | string list (comma separated)                 | ""      |
+| DISABLE_GLOBAL_RATELIMIT_DETECTION | boolean                                       | false   |
+| ALLOW_CONCURRENT_REQUESTS          | boolean                                       | true    |
+
+Information on each config var can be found [here](CONFIG.md)
 
 .env files are loaded if present
 
@@ -101,14 +102,14 @@ This will vary depending on your usage, how many unique routes you see, etc. For
 
 ### Metrics / Health
 
-| Key                                | Labels                                 | Description                                                |
-|------------------------------------|----------------------------------------|------------------------------------------------------------|
-|nirn_proxy_error                    | none                                   | Counter for errors                                         |
-|nirn_proxy_requests                 | method, status, route, clientId        | Histogram that keeps track of all request metrics          |
-|nirn_proxy_open_connections         | route, method                          | Gauge for open client connections with the proxy           |
-|nirn_proxy_requests_routed_sent     | none                                   | Counter for requests routed to other nodes                 |
-|nirn_proxy_requests_routed_received | none                                   | Counter for requests received from other nodes             |
-|nirn_proxy_requests_routed_error    | none                                   | Counter for requests routed that failed                    |
+| Key                                 | Labels                          | Description                                       |
+|-------------------------------------|---------------------------------|---------------------------------------------------|
+| nirn_proxy_error                    | none                            | Counter for errors                                |
+| nirn_proxy_requests                 | method, status, route, clientId | Histogram that keeps track of all request metrics |
+| nirn_proxy_open_connections         | route, method                   | Gauge for open client connections with the proxy  |
+| nirn_proxy_requests_routed_sent     | none                            | Counter for requests routed to other nodes        |
+| nirn_proxy_requests_routed_received | none                            | Counter for requests received from other nodes    |
+| nirn_proxy_requests_routed_error    | none                            | Counter for requests routed that failed           |
 
 Note: 429s can produce two status: 429 Too Many Requests or 429 Shared. The latter is only produced for requests that return with the x-ratelimit-scope header set to "shared", which means they don't count towards the cloudflare firewall limit and thus should not be used for alerts, etc.
 

go.mod

@@ -1,36 +1,38 @@
 module github.com/germanoeich/nirn-proxy
 
-go 1.18
+go 1.25
 
 require (
-	github.com/Clever/leakybucket v1.2.0
-	github.com/hashicorp/golang-lru v0.5.4
-	github.com/hashicorp/memberlist v0.3.1
-	github.com/joho/godotenv v1.4.0
-	github.com/prometheus/client_golang v1.11.0
-	github.com/sirupsen/logrus v1.8.1
+	github.com/Clever/leakybucket v1.3.0
+	github.com/hashicorp/golang-lru v1.0.2
+	github.com/hashicorp/memberlist v0.5.4
+	github.com/joho/godotenv v1.5.1
+	github.com/prometheus/client_golang v1.23.2
+	github.com/sirupsen/logrus v1.9.3
 )
 
 require (
-	github.com/armon/go-metrics v0.0.0-20180917152333-f0300d1749da // indirect
+	github.com/armon/go-metrics v0.4.1 // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
-	github.com/cespare/xxhash/v2 v2.1.1 // indirect
-	github.com/golang/protobuf v1.4.3 // indirect
-	github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c // indirect
-	github.com/hashicorp/errwrap v1.0.0 // indirect
-	github.com/hashicorp/go-immutable-radix v1.0.0 // indirect
-	github.com/hashicorp/go-msgpack v0.5.3 // indirect
-	github.com/hashicorp/go-multierror v1.0.0 // indirect
-	github.com/hashicorp/go-sockaddr v1.0.0 // indirect
-	github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
-	github.com/miekg/dns v1.1.26 // indirect
-	github.com/prometheus/client_model v0.2.0 // indirect
-	github.com/prometheus/common v0.26.0 // indirect
-	github.com/prometheus/procfs v0.6.0 // indirect
+	github.com/cespare/xxhash/v2 v2.3.0 // indirect
+	github.com/google/btree v1.1.3 // indirect
+	github.com/hashicorp/errwrap v1.1.0 // indirect
+	github.com/hashicorp/go-immutable-radix v1.3.1 // indirect
+	github.com/hashicorp/go-metrics v0.5.4 // indirect
+	github.com/hashicorp/go-msgpack/v2 v2.1.5 // indirect
+	github.com/hashicorp/go-multierror v1.1.1 // indirect
+	github.com/hashicorp/go-sockaddr v1.0.7 // indirect
+	github.com/miekg/dns v1.1.70 // indirect
+	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/prometheus/client_model v0.6.2 // indirect
+	github.com/prometheus/common v0.66.1 // indirect
+	github.com/prometheus/procfs v0.16.1 // indirect
 	github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529 // indirect
-	golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9 // indirect
-	golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4 // indirect
-	golang.org/x/sys v0.0.0-20210603081109-ebe580a85c40 // indirect
-	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
-	google.golang.org/protobuf v1.26.0-rc.1 // indirect
+	go.yaml.in/yaml/v2 v2.4.2 // indirect
+	golang.org/x/mod v0.32.0 // indirect
+	golang.org/x/net v0.49.0 // indirect
+	golang.org/x/sync v0.19.0 // indirect
+	golang.org/x/sys v0.40.0 // indirect
+	golang.org/x/tools v0.41.0 // indirect
+	google.golang.org/protobuf v1.36.8 // indirect
 )