add docs

openfga · Feb 6, 2025 · d6ec68d · d6ec68d
1 parent 48f3c04
commit d6ec68d
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 17 deletions.
diff --git a/docs/OpenTelemetry.md b/docs/OpenTelemetry.md
@@ -18,23 +18,24 @@ 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.client.request.duration` | int    | No                 | Duration for the SDK to complete the request, in milliseconds                     |
-| `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)                             |
-| `http.server.request.duration` | int    | No                 | Time taken by the FGA server to process and evaluate the request, in milliseconds |
-| `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.response.model_id`        | string | Yes                | Authorization model ID that the FGA server used                                   |
+| `fga-client.request.batch_check_size` | int    | No                 | Number of objects in the batch check request                                      |
+| `fga-client.user`                     | string | No                 | User associated with the action of the request for check and list users           |
+| `http.client.request.duration`        | int    | No                 | Duration for the SDK to complete the request, in milliseconds                     |
+| `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)                             |
+| `http.server.request.duration`        | int    | No                 | Time taken by the FGA server to process and evaluate the request, in milliseconds |
+| `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
 

diff --git a/src/main/java/dev/openfga/sdk/telemetry/Attributes.java b/src/main/java/dev/openfga/sdk/telemetry/Attributes.java
@@ -38,6 +38,9 @@ public class Attributes {
      */
     public static final Attribute FGA_CLIENT_REQUEST_STORE_ID = new Attribute("fga-client.request.store_id");
 
+    /**
+     * Then 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");
 
     /**
-Original file line number
+Diff line change
@@ Expand Up / @@ -38,6 +38,9 @@ public class Attributes { @@
          */
         public static final Attribute FGA_CLIENT_REQUEST_STORE_ID = new Attribute("fga-client.request.store_id");
+        /**
+         * Then 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");
         /**
@@ Expand Down @@