Skip to content

Commit d6ec68d

Browse files
committed
add docs
1 parent 48f3c04 commit d6ec68d

File tree

2 files changed

+21
-17
lines changed

2 files changed

+21
-17
lines changed

docs/OpenTelemetry.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,24 @@ In cases when metrics events are sent, they will not be viewable outside of infr
1818

1919
### Supported Attributes
2020

21-
| Attribute Name | Type | Enabled by Default | Description |
22-
| ------------------------------ | ------ | ------------------ | --------------------------------------------------------------------------------- |
23-
| `fga-client.request.client_id` | string | Yes | Client ID associated with the request, if any |
24-
| `fga-client.request.method` | string | Yes | FGA method/action that was performed (e.g., Check, ListObjects) in TitleCase |
25-
| `fga-client.request.model_id` | string | Yes | Authorization model ID that was sent as part of the request, if any |
26-
| `fga-client.request.store_id` | string | Yes | Store ID that was sent as part of the request |
27-
| `fga-client.response.model_id` | string | Yes | Authorization model ID that the FGA server used |
28-
| `fga-client.user` | string | No | User associated with the action of the request for check and list users |
29-
| `http.client.request.duration` | int | No | Duration for the SDK to complete the request, in milliseconds |
30-
| `http.host` | string | Yes | Host identifier of the origin the request was sent to |
31-
| `http.request.method` | string | Yes | HTTP method for the request |
32-
| `http.request.resend_count` | int | Yes | Number of retries attempted, if any |
33-
| `http.response.status_code` | int | Yes | Status code of the response (e.g., `200` for success) |
34-
| `http.server.request.duration` | int | No | Time taken by the FGA server to process and evaluate the request, in milliseconds |
35-
| `url.scheme` | string | Yes | HTTP scheme of the request (`http`/`https`) |
36-
| `url.full` | string | Yes | Full URL of the request |
37-
| `user_agent.original` | string | Yes | User Agent used in the query |
21+
| Attribute Name | Type | Enabled by Default | Description |
22+
|---------------------------------------|--------|--------------------|-----------------------------------------------------------------------------------|
23+
| `fga-client.request.client_id` | string | Yes | Client ID associated with the request, if any |
24+
| `fga-client.request.method` | string | Yes | FGA method/action that was performed (e.g., Check, ListObjects) in TitleCase |
25+
| `fga-client.request.model_id` | string | Yes | Authorization model ID that was sent as part of the request, if any |
26+
| `fga-client.request.store_id` | string | Yes | Store ID that was sent as part of the request |
27+
| `fga-client.response.model_id` | string | Yes | Authorization model ID that the FGA server used |
28+
| `fga-client.request.batch_check_size` | int | No | Number of objects in the batch check request |
29+
| `fga-client.user` | string | No | User associated with the action of the request for check and list users |
30+
| `http.client.request.duration` | int | No | Duration for the SDK to complete the request, in milliseconds |
31+
| `http.host` | string | Yes | Host identifier of the origin the request was sent to |
32+
| `http.request.method` | string | Yes | HTTP method for the request |
33+
| `http.request.resend_count` | int | Yes | Number of retries attempted, if any |
34+
| `http.response.status_code` | int | Yes | Status code of the response (e.g., `200` for success) |
35+
| `http.server.request.duration` | int | No | Time taken by the FGA server to process and evaluate the request, in milliseconds |
36+
| `url.scheme` | string | Yes | HTTP scheme of the request (`http`/`https`) |
37+
| `url.full` | string | Yes | Full URL of the request |
38+
| `user_agent.original` | string | Yes | User Agent used in the query |
3839

3940
## Examples
4041

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ public class Attributes {
3838
*/
3939
public static final Attribute FGA_CLIENT_REQUEST_STORE_ID = new Attribute("fga-client.request.store_id");
4040

41+
/**
42+
* Then number of items to check in a batch request, if applicable.
43+
*/
4144
public static final Attribute FGA_CLIENT_REQUEST_BATCH_CHECK_SIZE = new Attribute("fga-client.request.batch_check_size");
4245

4346
/**

0 commit comments

Comments
 (0)