-
Notifications
You must be signed in to change notification settings - Fork 420
Add query logging callbacks and context manager #1043
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
8f8671a
Add query logging callbacks and context manager
dcwatson f64a8ea
Wrap timing in a context manager
dcwatson ab61adf
Merge branch 'master' into query-logging
dcwatson 937890d
More docs, test multiple loggers
dcwatson 107f196
Appease flake8
dcwatson 92baac1
Log query errors, clean up context managers
dcwatson 67dbc42
Fix docs
dcwatson a21d9c5
Renamed LoggedQuery attrs
dcwatson a9c6182
Merge branch 'master' into query-logging
dcwatson 8c29bbd
Merge branch 'master' into query-logging
elprans 3d2924a
Avoid use of logging context when no loggers are configured
elprans 040892d
s/logger/query_logger/, report `BaseException` too
elprans File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
import asyncio | ||
|
||
from asyncpg import _testbase as tb | ||
from asyncpg import exceptions | ||
|
||
|
||
class LogCollector: | ||
def __init__(self): | ||
self.records = [] | ||
|
||
def __call__(self, record): | ||
self.records.append(record) | ||
|
||
|
||
class TestQueryLogging(tb.ConnectedTestCase): | ||
|
||
async def test_logging_context(self): | ||
queries = asyncio.Queue() | ||
|
||
def query_saver(record): | ||
queries.put_nowait(record) | ||
|
||
with self.con.logger(query_saver): | ||
self.assertEqual(len(self.con._query_loggers), 1) | ||
await self.con.execute("SELECT 1") | ||
with self.con.logger(LogCollector()) as log: | ||
self.assertEqual(len(self.con._query_loggers), 2) | ||
await self.con.execute("SELECT 2") | ||
|
||
r1 = await queries.get() | ||
r2 = await queries.get() | ||
self.assertEqual(r1.query, "SELECT 1") | ||
self.assertEqual(r2.query, "SELECT 2") | ||
self.assertEqual(len(log.records), 1) | ||
self.assertEqual(log.records[0].query, "SELECT 2") | ||
self.assertEqual(len(self.con._query_loggers), 0) | ||
|
||
async def test_error_logging(self): | ||
with self.con.logger(LogCollector()) as log: | ||
with self.assertRaises(exceptions.UndefinedColumnError): | ||
await self.con.execute("SELECT x") | ||
|
||
await asyncio.sleep(0) # wait for logging | ||
self.assertEqual(len(log.records), 1) | ||
self.assertEqual( | ||
type(log.records[0].exception), | ||
exceptions.UndefinedColumnError | ||
) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.