traefik/docs/content/middlewares/http/retry.md

78 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

---
title: "Traefik HTTP Retry Documentation"
description: "Configure Traefik Proxy's HTTP Retry middleware, so you can retry requests to a backend server until it succeeds. Read the technical documentation."
---
2019-04-08 15:14:08 +00:00
# Retry
Retrying until it Succeeds
{: .subtitle }
2019-09-10 12:40:05 +00:00
<!--
TODO: add schema
-->
2021-02-11 13:34:04 +00:00
The Retry middleware reissues requests a given number of times to a backend server if that server does not reply.
As soon as the server answers, the middleware stops retrying, regardless of the response status.
The Retry middleware has an optional configuration to enable an exponential backoff.
2019-04-08 15:14:08 +00:00
## Configuration Examples
2023-05-10 13:28:05 +00:00
```yaml tab="Docker & Swarm"
2021-02-11 13:34:04 +00:00
# Retry 4 times with exponential backoff
2019-04-08 15:14:08 +00:00
labels:
2019-09-23 15:00:06 +00:00
- "traefik.http.middlewares.test-retry.retry.attempts=4"
- "traefik.http.middlewares.test-retry.retry.initialinterval=100ms"
```
2019-04-08 15:14:08 +00:00
```yaml tab="Kubernetes"
2021-02-11 13:34:04 +00:00
# Retry 4 times with exponential backoff
2023-03-20 14:38:08 +00:00
apiVersion: traefik.io/v1alpha1
2019-04-08 15:14:08 +00:00
kind: Middleware
metadata:
name: test-retry
spec:
retry:
attempts: 4
initialInterval: 100ms
2019-04-08 15:14:08 +00:00
```
2019-10-15 15:34:08 +00:00
```yaml tab="Consul Catalog"
2021-02-11 13:34:04 +00:00
# Retry 4 times with exponential backoff
2019-10-15 15:34:08 +00:00
- "traefik.http.middlewares.test-retry.retry.attempts=4"
- "traefik.http.middlewares.test-retry.retry.initialinterval=100ms"
2019-10-15 15:34:08 +00:00
```
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2021-02-11 13:34:04 +00:00
# Retry 4 times with exponential backoff
2019-07-22 07:58:04 +00:00
http:
middlewares:
test-retry:
retry:
attempts: 4
initialInterval: 100ms
2019-07-22 07:58:04 +00:00
```
```toml tab="File (TOML)"
# Retry 4 times with exponential backoff
[http.middlewares]
[http.middlewares.test-retry.retry]
attempts = 4
initialInterval = "100ms"
```
2019-04-08 15:14:08 +00:00
## Configuration Options
### `attempts`
2019-04-08 15:14:08 +00:00
_mandatory_
2019-09-23 15:00:06 +00:00
The `attempts` option defines how many times the request should be retried.
### `initialInterval`
2021-02-11 13:34:04 +00:00
The `initialInterval` option defines the first wait time in the exponential backoff series. The maximum interval is
calculated as twice the `initialInterval`. If unspecified, requests will be retried immediately.
The value of initialInterval should be provided in seconds or as a valid duration format, see [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration).