feat: add batch check telemetry attribute (#143)

* feat: add batch check attribute

* add docs

* fix docs typo

* lint fix

* add test for batch check telemetry is off by default

* docs formatting cleanup

Author: jimmyjames

docs/OpenTelemetry.md

@@ -18,21 +18,22 @@ In cases when metrics events are sent, they will not be viewable outside of infr
 
 ### Supported Attributes
 
-| Attribute Name                 | Type   | Enabled by Default | Description                                                                       |
-| ------------------------------ | ------ | ------------------ | --------------------------------------------------------------------------------- |
-| `fga-client.request.client_id` | string | Yes                | Client ID associated with the request, if any                                     |
-| `fga-client.request.method`    | string | Yes                | FGA method/action that was performed (e.g., Check, ListObjects) in TitleCase      |
-| `fga-client.request.model_id`  | string | Yes                | Authorization model ID that was sent as part of the request, if any               |
-| `fga-client.request.store_id`  | string | Yes                | Store ID that was sent as part of the request                                     |
-| `fga-client.response.model_id` | string | Yes                | Authorization model ID that the FGA server used                                   |
-| `fga-client.user`              | string | No                 | User associated with the action of the request for check and list users           |
-| `http.host`                    | string | Yes                | Host identifier of the origin the request was sent to                             |
-| `http.request.method`          | string | Yes                | HTTP method for the request                                                       |
-| `http.request.resend_count`    | int    | Yes                | Number of retries attempted, if any                                               |
-| `http.response.status_code`    | int    | Yes                | Status code of the response (e.g., `200` for success)                             |
-| `url.scheme`                   | string | Yes                | HTTP scheme of the request (`http`/`https`)                                       |
-| `url.full`                     | string | Yes                | Full URL of the request                                                           |
-| `user_agent.original`          | string | Yes                | User Agent used in the query                                                      |
+| Attribute Name                        | Type   | Enabled by Default | Description                                                                  |
+|---------------------------------------|--------|--------------------|------------------------------------------------------------------------------|
+| `fga-client.request.client_id`        | string | Yes                | Client ID associated with the request, if any                                |
+| `fga-client.request.method`           | string | Yes                | FGA method/action that was performed (e.g., Check, ListObjects) in TitleCase |
+| `fga-client.request.model_id`         | string | Yes                | Authorization model ID that was sent as part of the request, if any          |
+| `fga-client.request.store_id`         | string | Yes                | Store ID that was sent as part of the request                                |
+| `fga-client.request.batch_check_size` | int    | No                 | Number of objects in the batch check request                                 |
+| `fga-client.response.model_id`        | string | Yes                | Authorization model ID that the FGA server used                              |
+| `fga-client.user`                     | string | No                 | User associated with the action of the request for check and list users      |
+| `http.host`                           | string | Yes                | Host identifier of the origin the request was sent to                        |
+| `http.request.method`                 | string | Yes                | HTTP method for the request                                                  |
+| `http.request.resend_count`           | int    | Yes                | Number of retries attempted, if any                                          |
+| `http.response.status_code`           | int    | Yes                | Status code of the response (e.g., `200` for success)                        |
+| `url.scheme`                          | string | Yes                | HTTP scheme of the request (`http`/`https`)                                  |
+| `url.full`                            | string | Yes                | Full URL of the request                                                      |
+| `user_agent.original`                 | string | Yes                | User Agent used in the query                                                 |
 
 ## Examples
 
@@ -176,4 +177,4 @@ public class Example {
         otel = openTelemetry;
     }
 }
-```
+```

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

@@ -1149,6 +1149,16 @@ private Map<Attribute, String> buildTelemetryAttributes(Map<String, Object> attr
                             Attributes.FGA_CLIENT_REQUEST_MODEL_ID, writeRequest.getAuthorizationModelId());
                 }
             }
+
+            if (body instanceof BatchCheckRequest) {
+                BatchCheckRequest batchCheckRequest = (BatchCheckRequest) body;
+
+                if (batchCheckRequest.getChecks() != null) {
+                    telemetryAttributes.put(
+                            Attributes.FGA_CLIENT_REQUEST_BATCH_CHECK_SIZE,
+                            String.valueOf(batchCheckRequest.getChecks().size()));
+                }
+            }
         }
 
         return telemetryAttributes;

src/main/java/dev/openfga/sdk/telemetry/Attributes.java

@@ -38,6 +38,12 @@ public class Attributes {
      */
     public static final Attribute FGA_CLIENT_REQUEST_STORE_ID = new Attribute("fga-client.request.store_id");
 
+    /**
+     * The number of items to check in a batch request, if applicable.
+     */
+    public static final Attribute FGA_CLIENT_REQUEST_BATCH_CHECK_SIZE =
+            new Attribute("fga-client.request.batch_check_size");
+
     /**
      * The authorization model ID used by the server when evaluating the request, if applicable.
      */

src/test/java/dev/openfga/sdk/api/configuration/TelemetryConfigurationTest.java

@@ -87,6 +87,9 @@ void testDefaultMetrics() {
         assertTrue(
                 defaultAttributes.containsKey(Attributes.USER_AGENT),
                 "The default attributes map should contain the USER_AGENT attribute.");
+        assertFalse(
+                defaultAttributes.containsKey(Attributes.FGA_CLIENT_REQUEST_BATCH_CHECK_SIZE),
+                "The default attribute map should not contain the FGA_CLIENT_REQUEST_BATCH_CHECK_SIZE attribute.");
 
         defaultAttributes = metrics.get(Histograms.QUERY_DURATION);
         assertNotNull(defaultAttributes, "The default attributes map should not be null.");
@@ -124,6 +127,9 @@ void testDefaultMetrics() {
         assertTrue(
                 defaultAttributes.containsKey(Attributes.USER_AGENT),
                 "The default attributes map should contain the USER_AGENT attribute.");
+        assertFalse(
+                defaultAttributes.containsKey(Attributes.FGA_CLIENT_REQUEST_BATCH_CHECK_SIZE),
+                "The default attribute map should not contain the FGA_CLIENT_REQUEST_BATCH_CHECK_SIZE attribute.");
     }
 
     @Test