fix(telemetry): fixes for telemetry attributes and metrics tracking

- Improved client request duration handling.
- Fixed attribute filtering issue in some configurations.
- Updated `ClientConfiguration` to include telemetry configuration (like `Configuration`.)
- Enhanced tests to validate new telemetry attributes and ensure correct duration calculations.

Author: Evan Sims

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## [Unreleased](https://github.com/openfga/python-sdk/compare/v0.9.1...HEAD)
 
+- fix: fixes for telemetry attributes and metrics tracking (#176)
+
 ## v0.9.1
 
 ### [0.9.1](https://github.com/openfga/python-sdk/compare/v0.9.0...v0.9.1) (2025-01-23)
@@ -78,16 +80,19 @@ Please note that if you use third-party OpenTelemetry tooling to visualize the a
 - feat: enhancements to OpenTelemetry support (#120)
 
 Note this introduces some breaking changes to our metrics:
+
 1. `fga-client.request.method` is now in TitleCase to match the naming conventions in the Protos, e.g. `Check`, `ListObjects`, etc..
 2. Due to possible high costs for attributes with high cardinality, we are no longer including the following attributes by default:
-  * `fga-client.user`
-  * `http.client.request.duration`
-  * `http.server.request.duration`
+
+- `fga-client.user`
+- `http.client.request.duration`
+- `http.server.request.duration`
   We added configuration options to allow you to set which specific metrics and attributes you care about in case the defaults don't work for your use-case
 
 ## v0.6.1
 
 ### [0.6.1](https://github.com/openfga/python-sdk/compare/v0.6.0...v0.6.1) (2024-07-31)
+
 - feat: add support for specifying consistency when evaluating or reading (#129)
   Note: To use this feature, you need to be running OpenFGA v1.5.7+ with the experimental flag
   `enable-consistency-params` enabled. See the [v1.5.7 release notes](https://github.com/openfga/openfga/releases/tag/v1.5.7) for details.
@@ -155,21 +160,22 @@ You will have to modify some parts of your code, but we hope this will be to the
 and so the Pointer-to-String conversion is no longer needed.
 
 Some of the changes to expect:
+
 - The following request interfaces changed:
-    - `CheckRequest`: the `TupleKey` field is now of interface `CheckRequestTupleKey`, you can also now pass in `Context`
-    - `ExpandRequest`: the `TupleKey` field is now of interface `ExpandRequestTupleKey`
-    - `ReadRequest`: the `TupleKey` field is now of interface `ReadRequestTupleKey`
-    - `WriteRequest`: now takes `WriteRequestWrites` and `WriteRequestDeletes`, the latter of which accepts `TupleKeyWithoutCondition`
-    - And more
+  - `CheckRequest`: the `TupleKey` field is now of interface `CheckRequestTupleKey`, you can also now pass in `Context`
+  - `ExpandRequest`: the `TupleKey` field is now of interface `ExpandRequestTupleKey`
+  - `ReadRequest`: the `TupleKey` field is now of interface `ReadRequestTupleKey`
+  - `WriteRequest`: now takes `WriteRequestWrites` and `WriteRequestDeletes`, the latter of which accepts `TupleKeyWithoutCondition`
+  - And more
 - The following interfaces had fields that were optional are are now required:
-    - `CreateStoreResponse`
-    - `GetStoreResponse`
-    - `ListStoresResponse`
-    - `ListObjectsResponse`
-    - `ReadChangesResponse`
-    - `ReadResponse`
-    - `AuthorizationModel`
-    - And more
+  - `CreateStoreResponse`
+  - `GetStoreResponse`
+  - `ListStoresResponse`
+  - `ListObjectsResponse`
+  - `ReadChangesResponse`
+  - `ReadResponse`
+  - `AuthorizationModel`
+  - And more
 
 Take a look at the changes in models in https://github.com/openfga/python-sdk/commit/9ed1f70d64db71451de2eb26e330bbd511625c5c and https://github.com/openfga/python-sdk/pull/59/files for more.
 
@@ -182,31 +188,36 @@ Note: `v0.3.4` has been re-released as `v0.4.0` due to breaking changes
 ## v0.3.3
 
 ### [0.3.3](https://github.com/openfga/python-sdk/compare/v0.3.2...v0.3.3) (2024-01-02)
+
 - fix: correct type hints for list_relations
 - fix: handle empty TupleKey in read
 - chore: add example project
 
 ## v0.3.2
 
 ### [0.3.2](https://github.com/openfga/python-sdk/compare/v0.3.1...v0.3.2) (2023-12-15)
+
 - feat: allow passing ssl certs to client configuration
 - feat: setup openfga_sdk.help for bug info
 
 ## v0.3.1
 
 ### [0.3.1](https://github.com/openfga/python-sdk/compare/v0.3.0...v0.3.1) (2023-12-01)
+
 - chore(deps): reduce min urllib3 to 1.25.11, add dependabot & bump deps
 
 ## v0.3.0
 
 ### [0.3.0](https://github.com/openfga/python-sdk/compare/v0.2.1...v0.3.0) (2023-11-02)
+
 - feat(client): introduce synchronous OpenFgaClient (https://github.com/openfga/python-sdk/commit/c92b436543e263f2c1af6af15f1c4fda1c9dad21)
 - refactor(config): extract oauth2 from credentials, removing logic from credentials configuration (https://github.com/openfga/python-sdk/commit/f91d14b25f86dd3f2e4d48229bb53cc7d9b20f1b)
 - feat(client): performance improvements to batch_check (https://github.com/openfga/python-sdk/commit/d8f2d429d2c279c0e56d5ef2a6172df8bfadd82b)
 
 ## v0.2.1
 
 ### [0.2.1](https://github.com/openfga/python-sdk/compare/v0.2.0...v0.2.1) (2023-09-05)
+
 - fix(client): fix a crash when calling check with contextual tuples (https://github.com/openfga/python-sdk/commit/dded83f9a75dc1f01c1cfbd8385a25654129f78f)
 - chore(docs): update README and fix a few typos (https://github.com/openfga/python-sdk/pull/21, https://github.com/openfga/python-sdk/pull/31, https://github.com/openfga/python-sdk/pull/32, https://github.com/openfga/python-sdk/pull/33, https://github.com/openfga/python-sdk/pull/34, https://github.com/openfga/python-sdk/pull/37)
 
@@ -215,6 +226,7 @@ Note: `v0.3.4` has been re-released as `v0.4.0` due to breaking changes
 ### [0.2.0](https://github.com/openfga/python-sdk/compare/v0.1.1...v0.2.0) (2023-05-25)
 
 Changes:
+
 - [BREAKING] feat!: `schema_version` is now required when calling `write_authorization_model`
 - [BREAKING] chore!: drop support for python < 3.10
 - feat(client): add OpenFgaClient wrapper see [docs](https://github.com/openfga/python-sdk/tree/main#readme), see the `v0.1.1` docs for [the OpenFgaApi docs](https://github.com/openfga/python-sdk/tree/v0.1.1#readme)
@@ -238,18 +250,20 @@ Changes:
 Updated to include support for [OpenFGA 0.3.0](https://github.com/openfga/openfga/releases/tag/v0.3.0)
 
 Changes:
+
 - [BREAKING] feat(list-objects)!: response has been changed to include the object type
-    e.g. response that was `{"object_ids":["roadmap"]}`, will now be `{"objects":["document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"]}`
+  e.g. response that was `{"object_ids":["roadmap"]}`, will now be `{"objects":["document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"]}`
 
 Fixes:
-- fix(models): update interfaces that had incorrectly optional fields to make them required
 
+- fix(models): update interfaces that had incorrectly optional fields to make them required
 
 ## v0.0.1
 
 ### [0.0.1](https://github.com/openfga/python-sdk/releases/tag/v0.0.1) (2022-08-31)
 
 Initial OpenFGA Python SDK release
+
 - Support for [OpenFGA](https://github.com/openfga/openfga) API
   - CRUD stores
   - Create, read & list authorization models

openfga_sdk/api_client.py

@@ -292,6 +292,7 @@ async def __call_api(
                         response=e.body.decode("utf-8"),
                         credentials=self.configuration.credentials,
                         attributes=_telemetry_attributes,
+                        start=start,
                     )
 
                     self._telemetry.metrics.request(
@@ -323,6 +324,7 @@ async def __call_api(
                     response=e,
                     credentials=self.configuration.credentials,
                     attributes=_telemetry_attributes,
+                    start=start,
                 )
 
                 self._telemetry.metrics.request(
@@ -349,6 +351,7 @@ async def __call_api(
                 response=response_data,
                 credentials=self.configuration.credentials,
                 attributes=_telemetry_attributes,
+                start=start,
             )
 
             self._telemetry.metrics.request(

openfga_sdk/client/configuration.py

@@ -12,6 +12,14 @@
 
 from openfga_sdk.configuration import Configuration
 from openfga_sdk.exceptions import FgaValidationException
+from openfga_sdk.telemetry.attributes import TelemetryAttribute
+from openfga_sdk.telemetry.configuration import (
+    TelemetryConfigurationType,
+    TelemetryMetricConfiguration,
+    TelemetryMetricsConfiguration,
+)
+from openfga_sdk.telemetry.counters import TelemetryCounter
+from openfga_sdk.telemetry.histograms import TelemetryHistogram
 from openfga_sdk.validation import is_well_formed_ulid_string
 
 
@@ -31,6 +39,20 @@ def __init__(
         ssl_ca_cert=None,
         api_url=None,  # TODO: restructure when removing api_scheme/api_host
         timeout_millisec: int | None = None,
+        telemetry: (
+            dict[
+                TelemetryConfigurationType | str,
+                TelemetryMetricsConfiguration
+                | dict[
+                    TelemetryHistogram | TelemetryCounter | str,
+                    TelemetryMetricConfiguration
+                    | dict[TelemetryAttribute | str, bool]
+                    | None,
+                ]
+                | None,
+            ]
+            | None
+        ) = None,
     ):
         super().__init__(
             api_scheme,
@@ -41,6 +63,7 @@ def __init__(
             ssl_ca_cert=ssl_ca_cert,
             api_url=api_url,
             timeout_millisec=timeout_millisec,
+            telemetry=telemetry,
         )
         self._authorization_model_id = authorization_model_id
 

openfga_sdk/sync/api_client.py

@@ -292,6 +292,7 @@ def __call_api(
                         response=e.body.decode("utf-8"),
                         credentials=self.configuration.credentials,
                         attributes=_telemetry_attributes,
+                        start=start,
                     )
 
                     self._telemetry.metrics.request(
@@ -323,6 +324,7 @@ def __call_api(
                     response=e,
                     credentials=self.configuration.credentials,
                     attributes=_telemetry_attributes,
+                    start=start,
                 )
 
                 self._telemetry.metrics.request(
@@ -349,6 +351,7 @@ def __call_api(
                 response=response_data,
                 credentials=self.configuration.credentials,
                 attributes=_telemetry_attributes,
+                start=start,
             )
 
             self._telemetry.metrics.request(

openfga_sdk/telemetry/attributes.py

@@ -287,6 +287,7 @@ def fromResponse(
         ) = None,
         credentials: Credentials | None = None,
         attributes: dict[TelemetryAttribute, str | bool | int | float] | None = None,
+        start: float | None = None,
     ) -> dict[TelemetryAttribute, str | bool | int | float]:
         response_model_id = None
         response_query_duration = None
@@ -295,6 +296,11 @@ def fromResponse(
         if attributes is not None:
             _attributes = attributes
 
+        if start is not None and start > 0:
+            _attributes[TelemetryAttributes.http_client_request_duration] = int(
+                (time.time() - start) * 1000
+            )
+
         if isinstance(response, ApiException):
             if response.status is not None:
                 _attributes[TelemetryAttributes.http_response_status_code] = int(

openfga_sdk/telemetry/metrics.py

@@ -19,6 +19,7 @@
 from openfga_sdk.telemetry.configuration import (
     TelemetryConfiguration,
     TelemetryMetricConfiguration,
+    TelemetryMetricsConfiguration,
     isMetricEnabled,
 )
 from openfga_sdk.telemetry.counters import TelemetryCounter, TelemetryCounters
@@ -90,7 +91,7 @@ def request(
 
             if (
                 isinstance(configuration, TelemetryConfiguration)
-                and isinstance(configuration.metrics, TelemetryMetricConfiguration)
+                and isinstance(configuration.metrics, TelemetryMetricsConfiguration)
                 and isinstance(
                     configuration.metrics.fga_client_request,
                     TelemetryMetricConfiguration,
@@ -127,7 +128,7 @@ def credentialsRequest(
 
             if (
                 isinstance(configuration, TelemetryConfiguration)
-                and isinstance(configuration.metrics, TelemetryMetricConfiguration)
+                and isinstance(configuration.metrics, TelemetryMetricsConfiguration)
                 and isinstance(
                     configuration.metrics.fga_client_credentials_request,
                     TelemetryMetricConfiguration,
@@ -178,7 +179,7 @@ def requestDuration(
 
                 if (
                     isinstance(configuration, TelemetryConfiguration)
-                    and isinstance(configuration.metrics, TelemetryMetricConfiguration)
+                    and type(configuration.metrics) is TelemetryMetricsConfiguration
                     and isinstance(
                         configuration.metrics.fga_client_request_duration,
                         TelemetryMetricConfiguration,

test/rest_test.py

@@ -339,7 +339,9 @@ async def test_stream_exception_in_chunks():
 
     class FakeContent:
         async def iter_chunks(self):
-            raise ValueError("Boom!")
+            if True:  # This ensures the coroutine is actually created and awaited
+                raise ValueError("Boom!")
+            yield (b"", None)  # This line is never reached
 
     mock_response = MagicMock()
     mock_response.status = 200
@@ -357,8 +359,11 @@ async def iter_chunks(self):
     client.close = AsyncMock()
 
     results = []
-    async for item in client.stream("GET", "http://example.com"):
-        results.append(item)
+    try:
+        async for item in client.stream("GET", "http://example.com"):
+            results.append(item)
+    except ValueError:
+        pass
 
     assert results == []
     client.handle_response_exception.assert_awaited_once()

test/telemetry/attributes_test.py

@@ -123,6 +123,7 @@ def test_from_request_without_optional_params(telemetry_attributes):
 
 
 def test_from_response_with_http_response(telemetry_attributes):
+    start_time = time.time() - 5
     response = MagicMock(spec=HTTPResponse)
     response.status = 200
     response.getheader.side_effect = lambda header: {
@@ -135,16 +136,21 @@ def test_from_response_with_http_response(telemetry_attributes):
         configuration=CredentialConfiguration(client_id="client_123"),
     )
     attributes = telemetry_attributes.fromResponse(
-        response=response, credentials=credentials
+        response=response,
+        credentials=credentials,
+        start=start_time,
     )
 
     assert attributes[TelemetryAttributes.http_response_status_code] == 200
     assert attributes[TelemetryAttributes.fga_client_response_model_id] == "model_123"
     assert attributes[TelemetryAttributes.http_server_request_duration] == "50"
     assert attributes[TelemetryAttributes.fga_client_request_client_id] == "client_123"
+    assert TelemetryAttributes.http_client_request_duration in attributes
+    assert attributes[TelemetryAttributes.http_client_request_duration] > 0
 
 
 def test_from_response_with_rest_response(telemetry_attributes):
+    start_time = time.time() - 5
     response = MagicMock(spec=RESTResponse)
     response.status = 404
     response.headers = {
@@ -159,13 +165,17 @@ def test_from_response_with_rest_response(telemetry_attributes):
         configuration=CredentialConfiguration(client_id="client_456"),
     )
     attributes = telemetry_attributes.fromResponse(
-        response=response, credentials=credentials
+        response=response,
+        credentials=credentials,
+        start=start_time,
     )
 
     assert attributes[TelemetryAttributes.http_response_status_code] == 404
     assert attributes[TelemetryAttributes.fga_client_response_model_id] == "model_404"
     assert attributes[TelemetryAttributes.http_server_request_duration] == "100"
     assert attributes[TelemetryAttributes.fga_client_request_client_id] == "client_456"
+    assert TelemetryAttributes.http_client_request_duration in attributes
+    assert attributes[TelemetryAttributes.http_client_request_duration] > 0
 
 
 def test_from_body_with_batch_check(telemetry_attributes):