openstack/devstack
Code Issues Proposed changes

Fix NotImplementedError in dbcounter on SQLA 2.x

Browse Source 
This patch fixes a NotImplementedError raised in the dbcounter plugin when using SQLAlchemy 2.x. The plugin signature has changed and now requires an "update_url" method as part of the plugin[1].
This patch also updates the do_incr() explicit SQL string to use a TextClause and the new requirement for named bound parameters[2].

Closes-Bug: #2009521

[1] https://docs.sqlalchemy.org/en/20/changelog/migration_14.html#changes-to-createengineplugin
[2] https://docs.sqlalchemy.org/en/20/changelog/migration_20.html#execute-method-more-strict-execution-options-are-more-prominent

Change-Id: Ie5484597057a3306757cc46b657446ad61ac2098
This commit is contained in:
Michael Johnson 2023-03-06 18:47:03 +00:00
parent ab8e51eb49
commit f834f9adaf
2 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
releasenotes/notes/Fix-dbcounter-NotImplementedError-on-SQLAlchemy-2-21bb6dcdf3ce4225.yaml Normal file
View File

@ -0,0 +1,5 @@
---
fixes:
- |
Fixes a NotImplementedError when using the dbcounter SQLAlchemy plugin on
SQLAlchemy 2.x.

11
tools/dbcounter/dbcounter.py
View File

@ -40,6 +40,9 @@ class LogCursorEventsPlugin(CreateEnginePlugin):
self.queue = queue.Queue() self.queue = queue.Queue()
self.thread = None self.thread = None
def update_url(self, url):
return url.difference_update_query(["dbcounter"])
def engine_created(self, engine): def engine_created(self, engine):
"""Hook the engine creation process. """Hook the engine creation process.
@ -77,12 +80,12 @@ class LogCursorEventsPlugin(CreateEnginePlugin):
def do_incr(self, db, op, count): def do_incr(self, db, op, count):
"""Increment the counter for (db,op) by count.""" """Increment the counter for (db,op) by count."""
query = ('INSERT INTO queries (db, op, count) ' query = sqlalchemy.text('INSERT INTO queries (db, op, count) '
' VALUES (%s, %s, %s) ' ' VALUES (:db, :op, :count) '
' ON DUPLICATE KEY UPDATE count=count+%s') ' ON DUPLICATE KEY UPDATE count=count+:count')
try: try:
with self.engine.begin() as conn: with self.engine.begin() as conn:
r = conn.execute(query, (db, op, count, count)) r = conn.execute(query, {'db': db, 'op': op, 'count': count})
except Exception as e: except Exception as e:
LOG.error('Failed to account for access to database %r: %s', LOG.error('Failed to account for access to database %r: %s',
db, e) db, e)