リトライとタイムアウトの設定
一時的な障害に対する自動リトライを設定し、長時間実行されるリクエストがリソースを占有し続けないようタイムアウトを設定します。
「リトライとタイムアウトの設定」はCoddyKit上の無料API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)レッスンです。 これはレッスン2/4です。 下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。 これはAPI Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)コースには全4レッスンが含まれています。
このレッスンの一部はまだ翻訳されておらず、英語で表示されています。
Build Resilient Gateways
In microservices, services can fail or become slow. To keep our applications running smoothly, we need to build resilience.
- Resilience means your system can recover from failures and continue to function.
- Spring Cloud Gateway provides tools to make your API Gateway more resilient.
- Two key strategies for resilience are Timeouts and Retries.
Preventing Slow Responses with Timeouts
A timeout is a limit on how long an operation is allowed to take. If the operation doesn't complete within that time, it's automatically stopped.
- Timeouts prevent requests from hanging indefinitely.
- They free up resources (like network connections and threads) that would otherwise be tied up by a slow or unresponsive service.
- In a gateway, timeouts ensure that a slow backend service doesn't slow down the entire gateway or other requests.
Configuring Read Timeouts
Spring Cloud Gateway allows you to configure specific timeouts for routes. The ReadTimeout filter is commonly used to limit how long the gateway waits for a response from the backend service after the connection is established.
- This timeout is applied per route.
- It helps prevent a single slow backend from impacting the gateway's overall performance.
- The value is typically set in milliseconds.
Read Timeout Configuration Example
Here's how you can configure a ReadTimeout for a specific route in your application.yml. This example sets a 5-second read timeout for requests to /service-a/**:
Remember, this is part of your Spring Boot application's configuration.
spring:
cloud:
gateway:
routes:
- id: service_a_route
uri: http://localhost:8081
predicates:
- Path=/service-a/**
filters:
- ReadTimeout=5000Handling Transient Failures with Retries
Retries involve automatically re-sending a request that has failed, hoping it will succeed on a subsequent attempt.
- They are ideal for transient failures: temporary issues like network glitches or a brief service restart.
- Retries should be used cautiously, especially for non-idempotent operations (actions that produce different results if performed multiple times).
- Spring Cloud Gateway can be configured to automatically retry requests to backend services.
The Retry GatewayFilter
Spring Cloud Gateway provides a Retry filter to enable automatic retries for failed requests. You can configure various aspects of the retry logic:
retries: The maximum number of retry attempts.statuses: HTTP status codes that should trigger a retry (e.g.,503for Service Unavailable).methods: HTTP methods that can be retried (e.g.,GET,PUT).
Retry Configuration Example
Let's configure a Retry filter. This example retries requests up to 3 times if the backend returns a 5XX error or a 404, specifically for GET requests to /service-b/**:
spring:
cloud:
gateway:
routes:
- id: service_b_route
uri: http://localhost:8082
predicates:
- Path=/service-b/**
filters:
- name: Retry
args:
retries: 3
statuses:
- SERVER_ERROR
- NOT_FOUND
methods:
- GETSimple Retry Logic Demo
While Spring Cloud Gateway handles retries via configuration, the core concept involves looping until success or max attempts. Here's a basic Java program demonstrating a retry loop:
public class RetryDemo {
private static int attempt = 0;
public static boolean simulateBackendCall() {
System.out.println("Attempt " + (++attempt));
return attempt < 3; // Fails for first 2 attempts
}
public static void main(String[] args) {
int maxRetries = 2;
for (int i = 0; i <= maxRetries; i++) {
if (!simulateBackendCall()) {
System.out.println("Success!");
return;
}
System.out.println("Failed. Retrying...");
try { Thread.sleep(100); } catch (InterruptedException e) {}
}
System.out.println("Max retries reached. Operation failed.");
}
}Combining Timeouts & Retries
Timeouts and retries often work together:
- A timeout can trigger a retry if the request doesn't complete within the specified time.
- If a request times out, the gateway might then attempt a retry, hoping the next attempt will be faster or the service will respond.
- It's crucial to configure these carefully to avoid endless loops or excessive delays. For example, a retry might happen *after* a read timeout, or a global timeout could encompass all retries.
Best Practices for Resilience
When implementing timeouts and retries, consider these best practices:
- Idempotency: Only retry idempotent operations (e.g., GET, PUT) unless you have specific logic to handle non-idempotent ones (e.g., POST).
- Exponential Backoff: Introduce increasing delays between retries to avoid overwhelming a struggling service.
- Circuit Breakers: Combine with circuit breakers (covered in Lesson 10.1) to stop retrying services that are clearly down.
- Monitoring: Monitor retry counts and timeouts to identify persistently problematic services.
Quick Check on Gateway Resilience
You're configuring a Spring Cloud Gateway route for a backend service that sometimes experiences brief network hiccups, resulting in a 503 Service Unavailable error. You want the gateway to automatically try the request again a few times before giving up. Which filter and configuration would best achieve this?
Recap: Timeouts & Retries
We've explored how Timeouts and Retries are fundamental for building resilient API Gateways with Spring Cloud Gateway.
- Timeouts prevent requests from hanging, freeing up resources.
- The
ReadTimeoutfilter configures the wait time for backend responses. - Retries automatically re-send requests for transient failures.
- The
Retryfilter allows fine-grained control over retry attempts, statuses, and HTTP methods. - Combining these with best practices helps create robust microservice architectures.
よくある質問
「リトライとタイムアウトの設定」レッスンは無料ですか？
はい。「リトライとタイムアウトの設定」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し（組み込みコードエディタと24時間対応のAIチューター）、API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)コースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)コースには全4レッスンが含まれています。
「リトライとタイムアウトの設定」で何を学びますか？
一時的な障害に対する自動リトライを設定し、長時間実行されるリクエストがリソースを占有し続けないようタイムアウトを設定します。 ブラウザで直接実行するハンズオンコードでAPI Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)を演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。
API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)を始めるのに経験は必要ですか？
事前経験は必要ありません。CoddyKitのAPI Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)は初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。 これはレッスン2/4です。
「リトライとタイムアウトの設定」レッスンにはどのくらい時間がかかりますか？
ほとんどのCoddyKitレッスンは約5～10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。
このAPI Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)レッスンでコードを書いて実行できますか？
はい。すべてのAPI Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)レッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。