release: v0.7.0 (#121)

Author: evansims

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## v0.7.0
+
+### [0.7.0](https://github.com/openfga/python-sdk/compare/v0.6.1...v0.7.0) (2024-08-30)
+
+- 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`
+  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)

example/example1/requirements.txt

@@ -4,7 +4,7 @@ attrs >= 23.1.0
 frozenlist >= 1.4.1
 idna >= 3.6
 multidict >= 6.0.4
-openfga-sdk >= 0.6.1
+openfga-sdk >= 0.7.0
 python-dateutil >= 2.8.2
 urllib3 >= 2.1.0
 yarl >= 1.9.4

example/example1/setup.py

@@ -14,7 +14,7 @@
 
 NAME = "example1"
 VERSION = "0.0.1"
-REQUIRES = ["openfga-sdk >= 0.6.1"]
+REQUIRES = ["openfga-sdk >= 0.7.0"]
 
 setup(
     name=NAME,

openfga_sdk/__init__.py

@@ -10,7 +10,7 @@
    NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
 """
 
-__version__ = "0.6.1"
+__version__ = "0.7.0"
 
 from openfga_sdk.api.open_fga_api import OpenFgaApi
 from openfga_sdk.api_client import ApiClient

openfga_sdk/api_client.py

@@ -36,7 +36,7 @@
 from openfga_sdk.telemetry import Telemetry
 from openfga_sdk.telemetry.attributes import TelemetryAttribute, TelemetryAttributes
 
-DEFAULT_USER_AGENT = "openfga-sdk python/0.6.1"
+DEFAULT_USER_AGENT = "openfga-sdk python/0.7.0"
 
 
 def random_time(loop_count, min_wait_in_ms):

openfga_sdk/configuration.py

@@ -478,7 +478,7 @@ def to_debug_report(self):
             "OS: {env}\n"
             "Python Version: {pyversion}\n"
             "Version of the API: 1.x\n"
-            "SDK Package Version: 0.6.1".format(env=sys.platform, pyversion=sys.version)
+            "SDK Package Version: 0.7.0".format(env=sys.platform, pyversion=sys.version)
         )
 
     def get_host_settings(self):

openfga_sdk/oauth2.py

@@ -83,7 +83,7 @@ async def _obtain_token(self, client):
             {
                 "Accept": "application/json",
                 "Content-Type": "application/x-www-form-urlencoded",
-                "User-Agent": "openfga-sdk (python) 0.6.1",
+                "User-Agent": "openfga-sdk (python) 0.7.0",
             }
         )
 

openfga_sdk/sync/api_client.py

@@ -35,7 +35,7 @@
 from openfga_sdk.telemetry import Telemetry
 from openfga_sdk.telemetry.attributes import TelemetryAttribute, TelemetryAttributes
 
-DEFAULT_USER_AGENT = "openfga-sdk python/0.6.1"
+DEFAULT_USER_AGENT = "openfga-sdk python/0.7.0"
 
 
 def random_time(loop_count, min_wait_in_ms):

openfga_sdk/sync/oauth2.py

@@ -83,7 +83,7 @@ def _obtain_token(self, client):
             {
                 "Accept": "application/json",
                 "Content-Type": "application/x-www-form-urlencoded",
-                "User-Agent": "openfga-sdk (python) 0.6.1",
+                "User-Agent": "openfga-sdk (python) 0.7.0",
             }
         )
 

setup.py

@@ -16,7 +16,7 @@
 from setuptools import find_packages, setup
 
 NAME = "openfga-sdk"
-VERSION = "0.6.1"
+VERSION = "0.7.0"
 REQUIRES = []