Merge pull request #63 from xhdnoah/master

feat: add otel instrument

CHANGELOG.md

@@ -4,16 +4,20 @@ All notable changes to this project will be documented in this file.
 
 The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
 
+## [1.2.7] - 2024-04-28
+
+- Add MySQLClientInstrumentor used to automatic tracing the requests from mysqlClient, the `instrument()` method should be invoked before `connect()`.
+
 ## [1.2.6] - 2021-12-29
 
 - Update `updated_at` field implicitly when updating with the `only` option.
+
 ```
 some_record.a_field = "updatede a field"
 # updated fields: a_field, updated_at
 some_record.save(only=["a_field"])
 ```
 
-
 ## [1.2.3] - 2021-04-21
 
 - ensure_ascii is provided in JSONCharField to support storing Chinese in non-ascii way

peeweext/__init__.py

@@ -1 +1 @@
-__version__ = '1.2.6'
+__version__ = '1.2.7'

peeweext/flask.py

@@ -1,6 +1,7 @@
 from werkzeug.local import LocalProxy
 from werkzeug.utils import import_string, cached_property
 from playhouse import db_url
+from opentelemetry.instrumentation.mysqlclient import MySQLClientInstrumentor
 
 
 class UninitializedException(Exception):
@@ -20,6 +21,7 @@ def init_app(self, app):
             config.get('model', 'peeweext.model.Model'))
         conn_params = config.get('conn_params', {})
 
+        MySQLClientInstrumentor().instrument()
         # initialize private connection pool
         self._database = db_url.connect(config['db_url'], **conn_params)
 

peeweext/sea.py

@@ -5,6 +5,7 @@
 from playhouse import db_url
 from peewee import DoesNotExist, DataError
 import grpc
+from opentelemetry.instrumentation.mysqlclient import MySQLClientInstrumentor
 
 from .validation import ValidationError
 
@@ -18,6 +19,7 @@ def init_app(self, app):
         self.model_class = import_string(
             config.get('model', 'peeweext.model.Model'))
         conn_params = config.get('conn_params', {})
+        MySQLClientInstrumentor().instrument()
         self.database = db_url.connect(config['db_url'], **conn_params)
         self._try_setup_celery()