Skip to content

Commit b5251de

Browse files
jimmyjamesjimmyjames
committed
fix: share single Telemetry instance per SDK client (#209)
Instead of creating new Telemetry, Metrics, and OpenTelemetry instruments for every HTTP request, share a single Telemetry instance per SDK client. This avoids wasted allocation, fragmented OTel instrument instances, and repeated GlobalOpenTelemetry meter lookups. Also fixes thread-safety bugs that become relevant once the instance is shared across concurrent async requests: - Telemetry.metrics(): volatile field + double-checked locking - Metrics counters/histograms: HashMap → ConcurrentHashMap with computeIfAbsent All existing public constructors are preserved for backward compatibility. Closes #209
1 parent d4b4f73 commit b5251de

10 files changed

Lines changed: 183 additions & 81 deletions

File tree

‎src/main/java/dev/openfga/sdk/api/OpenFgaApi.java‎

Lines changed: 41 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,14 @@ public OpenFgaApi(Configuration configuration) throws FgaInvalidParameterExcepti
7777
}
7878

7979
public OpenFgaApi(Configuration configuration, ApiClient apiClient) throws FgaInvalidParameterException {
80+
this(configuration, apiClient, new Telemetry(configuration));
81+
}
82+
83+
public OpenFgaApi(Configuration configuration, ApiClient apiClient, Telemetry telemetry)
84+
throws FgaInvalidParameterException {
8085
this.apiClient = apiClient;
8186
this.configuration = configuration;
82-
this.telemetry = new Telemetry(this.configuration);
87+
this.telemetry = telemetry;
8388

8489
if (configuration.getCredentials().getCredentialsMethod() == CredentialsMethod.CLIENT_CREDENTIALS) {
8590
this.oAuth2Client = new OAuth2Client(configuration, apiClient);
@@ -146,7 +151,8 @@ private CompletableFuture<ApiResponse<BatchCheckResponse>> batchCheck(
146151

147152
try {
148153
HttpRequest request = buildHttpRequest("POST", path, body, configuration);
149-
return new HttpRequestAttempt<>(request, "batchCheck", BatchCheckResponse.class, apiClient, configuration)
154+
return new HttpRequestAttempt<>(
155+
request, "batchCheck", BatchCheckResponse.class, apiClient, configuration, telemetry)
150156
.addTelemetryAttributes(telemetryAttributes)
151157
.attemptHttpRequest();
152158
} catch (ApiException e) {
@@ -202,7 +208,7 @@ private CompletableFuture<ApiResponse<CheckResponse>> check(
202208

203209
try {
204210
HttpRequest request = buildHttpRequest("POST", path, body, configuration);
205-
return new HttpRequestAttempt<>(request, "check", CheckResponse.class, apiClient, configuration)
211+
return new HttpRequestAttempt<>(request, "check", CheckResponse.class, apiClient, configuration, telemetry)
206212
.addTelemetryAttributes(telemetryAttributes)
207213
.attemptHttpRequest();
208214
} catch (ApiException e) {
@@ -252,7 +258,8 @@ private CompletableFuture<ApiResponse<CreateStoreResponse>> createStore(
252258

253259
try {
254260
HttpRequest request = buildHttpRequest("POST", path, body, configuration);
255-
return new HttpRequestAttempt<>(request, "createStore", CreateStoreResponse.class, apiClient, configuration)
261+
return new HttpRequestAttempt<>(
262+
request, "createStore", CreateStoreResponse.class, apiClient, configuration, telemetry)
256263
.addTelemetryAttributes(telemetryAttributes)
257264
.attemptHttpRequest();
258265
} catch (ApiException e) {
@@ -301,7 +308,7 @@ private CompletableFuture<ApiResponse<Void>> deleteStore(String storeId, Configu
301308

302309
try {
303310
HttpRequest request = buildHttpRequest("DELETE", path, configuration);
304-
return new HttpRequestAttempt<>(request, "deleteStore", Void.class, apiClient, configuration)
311+
return new HttpRequestAttempt<>(request, "deleteStore", Void.class, apiClient, configuration, telemetry)
305312
.addTelemetryAttributes(telemetryAttributes)
306313
.attemptHttpRequest();
307314
} catch (ApiException e) {
@@ -357,7 +364,8 @@ private CompletableFuture<ApiResponse<ExpandResponse>> expand(
357364

358365
try {
359366
HttpRequest request = buildHttpRequest("POST", path, body, configuration);
360-
return new HttpRequestAttempt<>(request, "expand", ExpandResponse.class, apiClient, configuration)
367+
return new HttpRequestAttempt<>(
368+
request, "expand", ExpandResponse.class, apiClient, configuration, telemetry)
361369
.addTelemetryAttributes(telemetryAttributes)
362370
.attemptHttpRequest();
363371
} catch (ApiException e) {
@@ -407,7 +415,8 @@ private CompletableFuture<ApiResponse<GetStoreResponse>> getStore(String storeId
407415

408416
try {
409417
HttpRequest request = buildHttpRequest("GET", path, configuration);
410-
return new HttpRequestAttempt<>(request, "getStore", GetStoreResponse.class, apiClient, configuration)
418+
return new HttpRequestAttempt<>(
419+
request, "getStore", GetStoreResponse.class, apiClient, configuration, telemetry)
411420
.addTelemetryAttributes(telemetryAttributes)
412421
.attemptHttpRequest();
413422
} catch (ApiException e) {
@@ -463,7 +472,8 @@ private CompletableFuture<ApiResponse<ListObjectsResponse>> listObjects(
463472

464473
try {
465474
HttpRequest request = buildHttpRequest("POST", path, body, configuration);
466-
return new HttpRequestAttempt<>(request, "listObjects", ListObjectsResponse.class, apiClient, configuration)
475+
return new HttpRequestAttempt<>(
476+
request, "listObjects", ListObjectsResponse.class, apiClient, configuration, telemetry)
467477
.addTelemetryAttributes(telemetryAttributes)
468478
.attemptHttpRequest();
469479
} catch (ApiException e) {
@@ -516,7 +526,8 @@ private CompletableFuture<ApiResponse<ListStoresResponse>> listStores(
516526

517527
try {
518528
HttpRequest request = buildHttpRequest("GET", path, configuration);
519-
return new HttpRequestAttempt<>(request, "listStores", ListStoresResponse.class, apiClient, configuration)
529+
return new HttpRequestAttempt<>(
530+
request, "listStores", ListStoresResponse.class, apiClient, configuration, telemetry)
520531
.addTelemetryAttributes(telemetryAttributes)
521532
.attemptHttpRequest();
522533
} catch (ApiException e) {
@@ -572,7 +583,8 @@ private CompletableFuture<ApiResponse<ListUsersResponse>> listUsers(
572583

573584
try {
574585
HttpRequest request = buildHttpRequest("POST", path, body, configuration);
575-
return new HttpRequestAttempt<>(request, "listUsers", ListUsersResponse.class, apiClient, configuration)
586+
return new HttpRequestAttempt<>(
587+
request, "listUsers", ListUsersResponse.class, apiClient, configuration, telemetry)
576588
.addTelemetryAttributes(telemetryAttributes)
577589
.attemptHttpRequest();
578590
} catch (ApiException e) {
@@ -628,7 +640,7 @@ private CompletableFuture<ApiResponse<ReadResponse>> read(
628640

629641
try {
630642
HttpRequest request = buildHttpRequest("POST", path, body, configuration);
631-
return new HttpRequestAttempt<>(request, "read", ReadResponse.class, apiClient, configuration)
643+
return new HttpRequestAttempt<>(request, "read", ReadResponse.class, apiClient, configuration, telemetry)
632644
.addTelemetryAttributes(telemetryAttributes)
633645
.attemptHttpRequest();
634646
} catch (ApiException e) {
@@ -687,7 +699,12 @@ private CompletableFuture<ApiResponse<ReadAssertionsResponse>> readAssertions(
687699
try {
688700
HttpRequest request = buildHttpRequest("GET", path, configuration);
689701
return new HttpRequestAttempt<>(
690-
request, "readAssertions", ReadAssertionsResponse.class, apiClient, configuration)
702+
request,
703+
"readAssertions",
704+
ReadAssertionsResponse.class,
705+
apiClient,
706+
configuration,
707+
telemetry)
691708
.addTelemetryAttributes(telemetryAttributes)
692709
.attemptHttpRequest();
693710
} catch (ApiException e) {
@@ -749,7 +766,8 @@ private CompletableFuture<ApiResponse<ReadAuthorizationModelResponse>> readAutho
749766
"readAuthorizationModel",
750767
ReadAuthorizationModelResponse.class,
751768
apiClient,
752-
configuration)
769+
configuration,
770+
telemetry)
753771
.addTelemetryAttributes(telemetryAttributes)
754772
.attemptHttpRequest();
755773
} catch (ApiException e) {
@@ -813,7 +831,8 @@ private CompletableFuture<ApiResponse<ReadAuthorizationModelsResponse>> readAuth
813831
"readAuthorizationModels",
814832
ReadAuthorizationModelsResponse.class,
815833
apiClient,
816-
configuration)
834+
configuration,
835+
telemetry)
817836
.addTelemetryAttributes(telemetryAttributes)
818837
.attemptHttpRequest();
819838
} catch (ApiException e) {
@@ -899,7 +918,8 @@ private CompletableFuture<ApiResponse<ReadChangesResponse>> readChanges(
899918

900919
try {
901920
HttpRequest request = buildHttpRequest("GET", path, configuration);
902-
return new HttpRequestAttempt<>(request, "readChanges", ReadChangesResponse.class, apiClient, configuration)
921+
return new HttpRequestAttempt<>(
922+
request, "readChanges", ReadChangesResponse.class, apiClient, configuration, telemetry)
903923
.addTelemetryAttributes(telemetryAttributes)
904924
.attemptHttpRequest();
905925
} catch (ApiException e) {
@@ -961,7 +981,8 @@ private CompletableFuture<ApiResponse<StreamResultOfStreamedListObjectsResponse>
961981
"streamedListObjects",
962982
StreamResultOfStreamedListObjectsResponse.class,
963983
apiClient,
964-
configuration)
984+
configuration,
985+
telemetry)
965986
.addTelemetryAttributes(telemetryAttributes)
966987
.attemptHttpRequest();
967988
} catch (ApiException e) {
@@ -1016,7 +1037,7 @@ private CompletableFuture<ApiResponse<Object>> write(String storeId, WriteReques
10161037

10171038
try {
10181039
HttpRequest request = buildHttpRequest("POST", path, body, configuration);
1019-
return new HttpRequestAttempt<>(request, "write", Object.class, apiClient, configuration)
1040+
return new HttpRequestAttempt<>(request, "write", Object.class, apiClient, configuration, telemetry)
10201041
.addTelemetryAttributes(telemetryAttributes)
10211042
.attemptHttpRequest();
10221043
} catch (ApiException e) {
@@ -1083,7 +1104,7 @@ private CompletableFuture<ApiResponse<Void>> writeAssertions(
10831104

10841105
try {
10851106
HttpRequest request = buildHttpRequest("PUT", path, body, configuration);
1086-
return new HttpRequestAttempt<>(request, "writeAssertions", Void.class, apiClient, configuration)
1107+
return new HttpRequestAttempt<>(request, "writeAssertions", Void.class, apiClient, configuration, telemetry)
10871108
.addTelemetryAttributes(telemetryAttributes)
10881109
.attemptHttpRequest();
10891110
} catch (ApiException e) {
@@ -1145,7 +1166,8 @@ private CompletableFuture<ApiResponse<WriteAuthorizationModelResponse>> writeAut
11451166
"writeAuthorizationModel",
11461167
WriteAuthorizationModelResponse.class,
11471168
apiClient,
1148-
configuration)
1169+
configuration,
1170+
telemetry)
11491171
.addTelemetryAttributes(telemetryAttributes)
11501172
.attemptHttpRequest();
11511173
} catch (ApiException e) {

‎src/main/java/dev/openfga/sdk/api/auth/OAuth2Client.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@ private CompletableFuture<CredentialsFlowResponse> exchangeToken()
7878
ApiClient.formRequestBuilder("POST", "", this.authRequest.buildFormRequestBody(), config);
7979
HttpRequest request = requestBuilder.build();
8080

81-
return new HttpRequestAttempt<>(request, "exchangeToken", CredentialsFlowResponse.class, apiClient, config)
81+
return new HttpRequestAttempt<>(
82+
request, "exchangeToken", CredentialsFlowResponse.class, apiClient, config, telemetry)
8283
.attemptHttpRequest()
8384
.thenApply(ApiResponse::getData);
8485
}

‎src/main/java/dev/openfga/sdk/api/client/ApiExecutor.java‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import dev.openfga.sdk.api.configuration.Configuration;
44
import dev.openfga.sdk.errors.ApiException;
55
import dev.openfga.sdk.errors.FgaInvalidParameterException;
6+
import dev.openfga.sdk.telemetry.Telemetry;
67
import java.io.IOException;
78
import java.net.http.HttpRequest;
89
import java.util.Map;
@@ -29,6 +30,7 @@
2930
public class ApiExecutor {
3031
private final ApiClient apiClient;
3132
private final Configuration configuration;
33+
private final Telemetry telemetry;
3234

3335
/**
3436
* Constructs an ApiExecutor instance. Typically called via {@link OpenFgaClient#apiExecutor()}.
@@ -37,14 +39,29 @@ public class ApiExecutor {
3739
* @param configuration Client configuration
3840
*/
3941
public ApiExecutor(ApiClient apiClient, Configuration configuration) {
42+
this(apiClient, configuration, new Telemetry(configuration));
43+
}
44+
45+
/**
46+
* Constructs an ApiExecutor instance. Typically called via {@link OpenFgaClient#apiExecutor()}.
47+
*
48+
* @param apiClient API client for HTTP operations
49+
* @param configuration Client configuration
50+
* @param telemetry Telemetry instance for collecting metrics
51+
*/
52+
public ApiExecutor(ApiClient apiClient, Configuration configuration, Telemetry telemetry) {
4053
if (apiClient == null) {
4154
throw new IllegalArgumentException("ApiClient cannot be null");
4255
}
4356
if (configuration == null) {
4457
throw new IllegalArgumentException("Configuration cannot be null");
4558
}
59+
if (telemetry == null) {
60+
throw new IllegalArgumentException("Telemetry cannot be null");
61+
}
4662
this.apiClient = apiClient;
4763
this.configuration = configuration;
64+
this.telemetry = telemetry;
4865
}
4966

5067
/**
@@ -87,7 +104,7 @@ public <T> CompletableFuture<ApiResponse<T>> send(ApiExecutorRequestBuilder requ
87104

88105
String methodName = "apiExecutor:" + requestBuilder.getMethod() + ":" + requestBuilder.getPath();
89106

90-
return new HttpRequestAttempt<>(httpRequest, methodName, responseType, apiClient, configuration)
107+
return new HttpRequestAttempt<>(httpRequest, methodName, responseType, apiClient, configuration, telemetry)
91108
.attemptHttpRequest();
92109

93110
} catch (IOException e) {

‎src/main/java/dev/openfga/sdk/api/client/HttpRequestAttempt.java‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,27 @@ public class HttpRequestAttempt<T> {
3737
public HttpRequestAttempt(
3838
HttpRequest request, String name, Class<T> clazz, ApiClient apiClient, Configuration configuration)
3939
throws FgaInvalidParameterException {
40+
this(request, name, clazz, apiClient, configuration, new Telemetry(configuration));
41+
}
42+
43+
public HttpRequestAttempt(
44+
HttpRequest request,
45+
String name,
46+
Class<T> clazz,
47+
ApiClient apiClient,
48+
Configuration configuration,
49+
Telemetry telemetry)
50+
throws FgaInvalidParameterException {
4051
assertParamExists(configuration.getMaxRetries(), "maxRetries", "Configuration");
52+
if (telemetry == null) {
53+
throw new IllegalArgumentException("Telemetry cannot be null");
54+
}
4155
this.apiClient = apiClient;
4256
this.configuration = configuration;
4357
this.name = name;
4458
this.request = request;
4559
this.clazz = clazz;
46-
this.telemetry = new Telemetry(configuration);
60+
this.telemetry = telemetry;
4761
this.telemetryAttributes = new HashMap<>();
4862
}
4963

‎src/main/java/dev/openfga/sdk/api/client/OpenFgaClient.java‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
import dev.openfga.sdk.api.model.*;
1010
import dev.openfga.sdk.constants.FgaConstants;
1111
import dev.openfga.sdk.errors.*;
12+
import dev.openfga.sdk.telemetry.Telemetry;
1213
import java.util.ArrayList;
1314
import java.util.HashMap;
1415
import java.util.List;
@@ -22,6 +23,7 @@
2223

2324
public class OpenFgaClient {
2425
private final ApiClient apiClient;
26+
private Telemetry telemetry;
2527
private ClientConfiguration configuration;
2628
private OpenFgaApi api;
2729

@@ -32,7 +34,8 @@ public OpenFgaClient(ClientConfiguration configuration) throws FgaInvalidParamet
3234
public OpenFgaClient(ClientConfiguration configuration, ApiClient apiClient) throws FgaInvalidParameterException {
3335
this.apiClient = apiClient;
3436
this.configuration = configuration;
35-
this.api = new OpenFgaApi(configuration, apiClient);
37+
this.telemetry = new Telemetry(configuration);
38+
this.api = new OpenFgaApi(configuration, apiClient, telemetry);
3639
}
3740

3841
/* ***********
@@ -63,7 +66,7 @@ public OpenFgaApi getApi() {
6366
* @return ApiExecutor instance
6467
*/
6568
public ApiExecutor apiExecutor() {
66-
return new ApiExecutor(this.apiClient, this.configuration);
69+
return new ApiExecutor(this.apiClient, this.configuration, this.telemetry);
6770
}
6871

6972
public void setStoreId(String storeId) {
@@ -76,7 +79,8 @@ public void setAuthorizationModelId(String authorizationModelId) {
7679

7780
public void setConfiguration(ClientConfiguration configuration) throws FgaInvalidParameterException {
7881
this.configuration = configuration;
79-
this.api = new OpenFgaApi(configuration, apiClient);
82+
this.telemetry = new Telemetry(configuration);
83+
this.api = new OpenFgaApi(configuration, apiClient, telemetry);
8084
}
8185

8286
/* ********

‎src/main/java/dev/openfga/sdk/telemetry/Metrics.java‎

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
import io.opentelemetry.api.metrics.DoubleHistogram;
77
import io.opentelemetry.api.metrics.LongCounter;
88
import io.opentelemetry.api.metrics.Meter;
9-
import java.util.HashMap;
109
import java.util.Map;
10+
import java.util.concurrent.ConcurrentHashMap;
1111

1212
/**
1313
* The Metrics class provides methods for creating and publishing metrics using OpenTelemetry.
@@ -24,8 +24,8 @@ public Metrics() {
2424

2525
public Metrics(Configuration configuration) {
2626
this.meter = GlobalOpenTelemetry.get().getMeterProvider().get("openfga-sdk");
27-
this.counters = new HashMap<>();
28-
this.histograms = new HashMap<>();
27+
this.counters = new ConcurrentHashMap<>();
28+
this.histograms = new ConcurrentHashMap<>();
2929
this.configuration = configuration;
3030
if (this.configuration.getTelemetryConfiguration() == null) {
3131
this.configuration.telemetryConfiguration(new TelemetryConfiguration());
@@ -55,15 +55,9 @@ public LongCounter getCounter(Counter counter, Long value, Map<Attribute, String
5555
|| !configuration.getTelemetryConfiguration().metrics().containsKey(counter)) {
5656
return null;
5757
}
58-
if (!counters.containsKey(counter.getName())) {
59-
counters.put(
60-
counter.getName(),
61-
meter.counterBuilder(counter.getName())
62-
.setDescription(counter.getDescription())
63-
.build());
64-
}
65-
66-
LongCounter counterInstance = counters.get(counter.getName());
58+
LongCounter counterInstance = counters.computeIfAbsent(counter.getName(), name -> meter.counterBuilder(name)
59+
.setDescription(counter.getDescription())
60+
.build());
6761

6862
if (value != null) {
6963
counterInstance.add(value, Attributes.prepare(attributes, counter, configuration));
@@ -87,16 +81,11 @@ public DoubleHistogram getHistogram(Histogram histogram, Double value, Map<Attri
8781
return null;
8882
}
8983

90-
if (!histograms.containsKey(histogram.getName())) {
91-
histograms.put(
92-
histogram.getName(),
93-
meter.histogramBuilder(histogram.getName())
94-
.setDescription(histogram.getDescription())
95-
.setUnit(histogram.getUnit())
96-
.build());
97-
}
98-
99-
DoubleHistogram histogramInstance = histograms.get(histogram.getName());
84+
DoubleHistogram histogramInstance =
85+
histograms.computeIfAbsent(histogram.getName(), name -> meter.histogramBuilder(name)
86+
.setDescription(histogram.getDescription())
87+
.setUnit(histogram.getUnit())
88+
.build());
10089

10190
if (value != null) {
10291
histogramInstance.record(value, Attributes.prepare(attributes, histogram, configuration));

0 commit comments

Comments
 (0)