Skip to main content

Buffering

Diagram showing how buffering works.

The buffering middleware limits the size of requests that can be forwarded to services.

With buffering, Traefik Hub reads the entire request into memory (possibly buffering large requests into disk), and rejects requests that are over a specified size limit.

This can help services avoid large amounts of data (multipart/form-data for example), and can minimize the time spent sending data to a Service.


Configuration Options

maxRequestBodyBytes

FieldDescriptionDefaultRequired
maxRequestBodyBytesThe maxRequestBodyBytes option configures the maximum allowed body size for the request (in bytes).
If the request exceeds the allowed size, it is not forwarded to the Service, and the client gets a 413 (Request Entity Too Large) response.
0No
apiVersion: traefik.io/v1alpha1
kind: Middleware
metadata:
name: limit
spec:
buffering:
maxRequestBodyBytes: 2000000

memRequestBodyBytes

FieldDescriptionDefaultRequired
memRequestBodyBytesYou can configure a threshold (in bytes) from which the request will be buffered on disk instead of in memory with the memRequestBodyBytes option.1048576No
apiVersion: traefik.io/v1alpha1
kind: Middleware
metadata:
name: limit
spec:
buffering:
memRequestBodyBytes: 2000000

maxResponseBodyBytes

FieldDescriptionDefaultRequired
maxResponseBodyBytesThe maxResponseBodyBytes option configures the maximum allowed response size from the Service (in bytes).
If the response exceeds the allowed size, it is not forwarded to the client. The client gets a 500 (Internal Server Error) response instead.
0No
apiVersion: traefik.io/v1alpha1
kind: Middleware
metadata:
name: limit
spec:
buffering:
maxResponseBodyBytes: 2000000

memResponseBodyBytes

FieldDescriptionDefaultRequired
memResponseBodyBytesYou can configure a threshold (in bytes) from which the response will be buffered on disk instead of in memory with the memResponseBodyBytes option.1048576No
apiVersion: traefik.io/v1alpha1
kind: Middleware
metadata:
name: limit
spec:
buffering:
memResponseBodyBytes: 2000000

retryExpression

FieldDescriptionDefaultRequired
retryExpressionYou can have the buffering middleware replay the request using retryExpression.""No
Retry once in the case of a network error
apiVersion: traefik.io/v1alpha1
kind: Middleware
metadata:
name: limit
spec:
buffering:
retryExpression: "IsNetworkError() && Attempts() < 2"

The retry expression is defined as a logical combination of the functions below with the operators AND (&&) and OR (||).
At least one function is required:

  • Attempts() number of attempts (the first one counts).
  • ResponseCode() response code of the Service.
  • IsNetworkError() whether the response code is related to networking error.