-
Notifications
You must be signed in to change notification settings - Fork 153
/
CircuitBreakerExample.java
395 lines (346 loc) · 19.5 KB
/
CircuitBreakerExample.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
import com.oracle.bmc.ClientConfiguration;
import com.oracle.bmc.ConfigFileReader;
import com.oracle.bmc.Region;
import com.oracle.bmc.auth.AuthenticationDetailsProvider;
import com.oracle.bmc.auth.ConfigFileAuthenticationDetailsProvider;
import com.oracle.bmc.circuitbreaker.CircuitBreakerConfiguration;
import com.oracle.bmc.circuitbreaker.CircuitBreakerFactory;
import com.oracle.bmc.circuitbreaker.OciCircuitBreaker;
import com.oracle.bmc.circuitbreaker.internal.resilience4j.OciCircuitBreakerImpl;
import com.oracle.bmc.core.ComputeClient;
import com.oracle.bmc.core.requests.ListVnicAttachmentsRequest;
import com.oracle.bmc.identity.IdentityClient;
import com.oracle.bmc.identity.requests.ListRegionsRequest;
import com.oracle.bmc.identity.responses.ListRegionsResponse;
import com.oracle.bmc.model.BmcException;
import com.oracle.bmc.objectstorage.ObjectStorage;
import com.oracle.bmc.objectstorage.ObjectStorageClient;
import com.oracle.bmc.objectstorage.model.BucketSummary;
import com.oracle.bmc.objectstorage.requests.GetNamespaceRequest;
import com.oracle.bmc.objectstorage.requests.ListBucketsRequest;
import com.oracle.bmc.objectstorage.responses.GetNamespaceResponse;
import com.oracle.bmc.objectstorage.responses.ListBucketsResponse;
import com.oracle.bmc.retrier.RetryConfiguration;
import io.github.resilience4j.circuitbreaker.CircuitBreaker;
import io.github.resilience4j.circuitbreaker.CircuitBreakerConfig;
import javax.ws.rs.core.Response;
import java.time.Duration;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
/** A sample to demonstrate how to configure a client using circuit breaker configuration. */
public class CircuitBreakerExample {
public static void main(String[] args) throws Exception {
String configurationFilePath = "~/.oci/config";
String profile = "DEFAULT";
// Configuring the AuthenticationDetailsProvider. It's assuming there is a default OCI
// config file
// "~/.oci/config", and a profile in that config with the name "DEFAULT". Make changes to
// the following
// line if needed and use ConfigFileReader.parse(configurationFilePath, profile);
final ConfigFileReader.ConfigFile configFile = ConfigFileReader.parseDefault();
final AuthenticationDetailsProvider provider =
new ConfigFileAuthenticationDetailsProvider(configFile);
// Circuit breaker setup with custom values
setupCircuitBreakerWithCustomValues(provider);
// Share same circuit breaker with multiple clients
shareCircuitBreakerAmongMultipleClients(provider);
// CircuitBreaker throws exception when open with details
circuitBreakerOpensWithErrorMessageExample(provider);
// CircuitBreaker throws exception with transition logs
circuitBreakerOpensWithTransitionMessages(provider);
}
private static void setupCircuitBreakerWithCustomValues(
AuthenticationDetailsProvider provider) {
// Setup CircuitBreakerConfiguration with custom values
ClientConfiguration configuration =
ClientConfiguration.builder()
.retryConfiguration(RetryConfiguration.builder().build())
.circuitBreakerConfiguration(
CircuitBreakerConfiguration.builder()
.failureRateThreshold(50)
.slowCallRateThreshold(90)
.slowCallDurationThreshold(Duration.ofSeconds(6))
.permittedNumberOfCallsInHalfOpenState(2)
.slidingWindowSize(10)
.minimumNumberOfCalls(4)
.waitDurationInOpenState(Duration.ofSeconds(2))
.recordHttpStatuses(
Collections.unmodifiableSet(
new HashSet<>(
Arrays.asList(
CircuitBreakerConfiguration
.TOO_MANY_REQUESTS,
CircuitBreakerConfiguration
.SERVICE_UNAVAILABLE))))
.build())
.build();
// Create Client using above ClientConfiguration
IdentityClient identityClient =
IdentityClient.builder()
.region(Region.US_PHOENIX_1)
.configuration(configuration)
.build(provider);
System.out.println("Querying for list of regions");
final ListRegionsResponse response =
identityClient.listRegions(ListRegionsRequest.builder().build());
System.out.println("List of regions: " + response.getItems());
identityClient.close();
}
private static void shareCircuitBreakerAmongMultipleClients(
AuthenticationDetailsProvider provider) throws Exception {
CircuitBreakerConfiguration circuitBreakerConfiguration =
CircuitBreakerConfiguration.builder()
.failureRateThreshold(50)
.slowCallRateThreshold(90)
.slowCallDurationThreshold(Duration.ofSeconds(6))
.permittedNumberOfCallsInHalfOpenState(2)
.slidingWindowSize(10)
.minimumNumberOfCalls(4)
.waitDurationInOpenState(Duration.ofSeconds(2))
.recordHttpStatuses(
Collections.unmodifiableSet(
new HashSet<>(
Arrays.asList(
CircuitBreakerConfiguration
.TOO_MANY_REQUESTS,
CircuitBreakerConfiguration
.SERVICE_UNAVAILABLE))))
.build();
OciCircuitBreaker cb = CircuitBreakerFactory.build(circuitBreakerConfiguration, null);
ClientConfiguration clientConfiguration =
ClientConfiguration.builder()
.retryConfiguration(RetryConfiguration.builder().build())
.circuitBreaker(cb)
.build();
// Create Clients using above ClientConfiguration
IdentityClient identityClient =
IdentityClient.builder()
.region(Region.US_PHOENIX_1)
.configuration(clientConfiguration)
.build(provider);
ObjectStorage client =
ObjectStorageClient.builder()
.region(Region.US_PHOENIX_1)
.configuration(clientConfiguration)
.build(provider);
final ListRegionsResponse response =
identityClient.listRegions(ListRegionsRequest.builder().build());
System.out.println("List of regions: " + response.getItems());
GetNamespaceResponse namespaceResponse =
client.getNamespace(GetNamespaceRequest.builder().build());
String namespaceName = namespaceResponse.getValue();
System.out.println("Using namespace: " + namespaceName);
ListBucketsRequest.Builder listBucketsBuilder =
ListBucketsRequest.builder()
.namespaceName(namespaceName)
.compartmentId(provider.getTenantId());
String nextToken = null;
do {
listBucketsBuilder.page(nextToken);
ListBucketsResponse listBucketsResponse =
client.listBuckets(listBucketsBuilder.build());
for (BucketSummary bucket : listBucketsResponse.getItems()) {
System.out.println("Found bucket: " + bucket.getName());
}
nextToken = listBucketsResponse.getOpcNextPage();
} while (nextToken != null);
identityClient.close();
client.close();
}
private static void circuitBreakerOpensWithErrorMessageExample(
AuthenticationDetailsProvider provider) throws Exception {
// Just for this example add one more status code SERVICE_NOTFOUND - 404(compare with
// default circuit breaker setting) as the failure request in circuit breaker.
int SERVICE_NOTFOUND = Response.Status.NOT_FOUND.getStatusCode();
int INVALID_PARAMETER = Response.Status.BAD_REQUEST.getStatusCode();
int MIN_NUM_CALLS = 5;
CircuitBreakerConfiguration circuitBreakerConfiguration =
CircuitBreakerConfiguration.builder()
.failureRateThreshold(50)
.slowCallRateThreshold(90)
.slowCallDurationThreshold(Duration.ofSeconds(6))
.permittedNumberOfCallsInHalfOpenState(2)
.slidingWindowSize(10)
.minimumNumberOfCalls(MIN_NUM_CALLS)
.waitDurationInOpenState(Duration.ofSeconds(2))
.numberOfRecordedHistoryResponses(5)
.recordHttpStatuses(
Collections.unmodifiableSet(
new HashSet<>(
Arrays.asList(
CircuitBreakerConfiguration
.TOO_MANY_REQUESTS,
CircuitBreakerConfiguration
.SERVICE_UNAVAILABLE,
SERVICE_NOTFOUND,
INVALID_PARAMETER))))
.build();
OciCircuitBreaker cb = CircuitBreakerFactory.build(circuitBreakerConfiguration, null);
ClientConfiguration clientConfiguration =
ClientConfiguration.builder()
.retryConfiguration(RetryConfiguration.builder().build())
.circuitBreaker(cb)
.build();
// Create Clients using above ClientConfiguration
ObjectStorage objectStorageClient =
ObjectStorageClient.builder()
.region(Region.US_PHOENIX_1)
.configuration(clientConfiguration)
.build(provider);
ComputeClient computeClient =
ComputeClient.builder()
.region(Region.US_PHOENIX_1)
.configuration(clientConfiguration)
.build(provider);
GetNamespaceResponse namespaceResponse =
objectStorageClient.getNamespace(GetNamespaceRequest.builder().build());
String namespaceName = namespaceResponse.getValue();
// Make the tenancy OCID incorrect to invoke errors
String invalidTenantId = "invalid_tenantId";
ListBucketsRequest.Builder listBucketsBuilder =
ListBucketsRequest.builder()
.namespaceName(namespaceName)
.compartmentId(invalidTenantId);
ListVnicAttachmentsRequest.Builder listVnicAttachmentsRequest =
ListVnicAttachmentsRequest.builder().compartmentId(invalidTenantId);
boolean circuitBreakerOpen = false;
try {
for (int i = 0; i < MIN_NUM_CALLS; i++) {
System.out.println("Circuit Breaker Status - " + cb.getState());
try {
// Alternate client requests to check shared circuitbreaker in action
if (i % 2 == 0) {
computeClient.listVnicAttachments(listVnicAttachmentsRequest.build());
} else {
objectStorageClient.listBuckets(listBucketsBuilder.build());
}
} catch (BmcException e) {
if (circuitBreakerOpen) throw e;
}
if (cb.getState().toString().equals(CircuitBreaker.State.OPEN.toString()))
circuitBreakerOpen = true;
}
} catch (BmcException e) {
e.printStackTrace();
}
objectStorageClient.close();
computeClient.close();
}
private static void circuitBreakerOpensWithTransitionMessages(
AuthenticationDetailsProvider provider) throws Exception {
// Just for this example add one more status code SERVICE_NOTFOUND - 404(compare with
// default circuit breaker setting) as the failure request in circuit breaker.
int SERVICE_NOTFOUND = Response.Status.NOT_FOUND.getStatusCode();
int INVALID_PARAMETER = Response.Status.BAD_REQUEST.getStatusCode();
int MIN_NUM_CALLS = 5;
CircuitBreakerConfiguration circuitBreakerConfiguration =
CircuitBreakerConfiguration.builder()
.failureRateThreshold(50)
.slowCallRateThreshold(90)
.slowCallDurationThreshold(Duration.ofSeconds(6))
.permittedNumberOfCallsInHalfOpenState(2)
.slidingWindowSize(10)
.minimumNumberOfCalls(MIN_NUM_CALLS)
.waitDurationInOpenState(Duration.ofSeconds(2))
.numberOfRecordedHistoryResponses(5)
.recordHttpStatuses(
Collections.unmodifiableSet(
new HashSet<>(
Arrays.asList(
CircuitBreakerConfiguration
.TOO_MANY_REQUESTS,
CircuitBreakerConfiguration
.SERVICE_UNAVAILABLE,
SERVICE_NOTFOUND,
INVALID_PARAMETER))))
.build();
CircuitBreaker r4jCircuitBreaker =
CircuitBreaker.of(
null,
CircuitBreakerConfig.custom()
.enableAutomaticTransitionFromOpenToHalfOpen()
.slidingWindowType(
CircuitBreakerConfig.SlidingWindowType.TIME_BASED)
.failureRateThreshold(
circuitBreakerConfiguration.getFailureRateThreshold())
.slowCallRateThreshold(
circuitBreakerConfiguration.getSlowCallRateThreshold())
.slowCallDurationThreshold(
circuitBreakerConfiguration.getSlowCallDurationThreshold())
.permittedNumberOfCallsInHalfOpenState(
circuitBreakerConfiguration
.getPermittedNumberOfCallsInHalfOpenState())
.slidingWindowSize(
circuitBreakerConfiguration.getSlidingWindowSize())
.minimumNumberOfCalls(
circuitBreakerConfiguration.getMinimumNumberOfCalls())
.writableStackTraceEnabled(
circuitBreakerConfiguration.isWritableStackTraceEnabled())
.waitDurationInOpenState(
circuitBreakerConfiguration.getWaitDurationInOpenState())
.recordExceptions(
circuitBreakerConfiguration
.getRecordExceptions()
.toArray(new Class[0]))
.build());
OciCircuitBreaker cb =
new OciCircuitBreakerImpl(
r4jCircuitBreaker,
circuitBreakerConfiguration.getNumberOfRecordedHistoryResponses());
ClientConfiguration clientConfiguration =
ClientConfiguration.builder()
.retryConfiguration(RetryConfiguration.builder().build())
.circuitBreaker(cb)
.build();
// Create Clients using above ClientConfiguration
ObjectStorage objectStorageClient =
ObjectStorageClient.builder()
.region(Region.US_PHOENIX_1)
.configuration(clientConfiguration)
.build(provider);
ComputeClient computeClient =
ComputeClient.builder()
.region(Region.US_PHOENIX_1)
.configuration(clientConfiguration)
.build(provider);
GetNamespaceResponse namespaceResponse =
objectStorageClient.getNamespace(GetNamespaceRequest.builder().build());
String namespaceName = namespaceResponse.getValue();
// Make the tenancy OCID incorrect to invoke errors
String invalidTenantId = "invalid_tenantId";
ListBucketsRequest.Builder listBucketsBuilder =
ListBucketsRequest.builder()
.namespaceName(namespaceName)
.compartmentId(invalidTenantId);
ListVnicAttachmentsRequest.Builder listVnicAttachmentsRequest =
ListVnicAttachmentsRequest.builder().compartmentId(invalidTenantId);
boolean circuitBreakerOpen = false;
for (int i = 0; i < MIN_NUM_CALLS + 6; i++) {
try {
// Alternate client requests to check shared circuitbreaker in action
if (i == MIN_NUM_CALLS + 2)
listVnicAttachmentsRequest.compartmentId("<compartmentId>");
if (i % 2 == 0 || i >= MIN_NUM_CALLS + 2) {
computeClient.listVnicAttachments(listVnicAttachmentsRequest.build());
} else {
objectStorageClient.listBuckets(listBucketsBuilder.build());
}
} catch (BmcException e) {
if (circuitBreakerOpen) {
e.printStackTrace();
Thread.sleep(2000);
}
}
if (cb.getState().toString().equals(CircuitBreaker.State.OPEN.toString()))
circuitBreakerOpen = true;
else circuitBreakerOpen = false;
}
objectStorageClient.close();
computeClient.close();
}
}