Default SQLite3 cursor is not instrumented

[Kludex]

Describe your environment

OS: (e.g, Ubuntu)
Python version: (e.g., Python 3.8.10)
Package version: (e.g., 0.46.0)

What happened?

The default sqlite3.Cursor is not instrumented.

Steps to Reproduce

import sqlite3

from opentelemetry.instrumentation.sqlite3 import SQLite3Instrumentor

import logfire

logfire.configure()

SQLite3Instrumentor().instrument()

cnx = sqlite3.connect(':memory:')
cnx.execute('CREATE TABLE test (testField INTEGER)')
cnx.close()

Expected Result

I would expect a span to be created for the table creation.

Actual Result

The span was not created.

Instead, if you do...

import sqlite3

from opentelemetry.instrumentation.sqlite3 import SQLite3Instrumentor

import logfire

logfire.configure()

SQLite3Instrumentor().instrument()

cnx = sqlite3.connect(':memory:')
cursor = cnx.cursor()
cursor.execute('CREATE TABLE test (testField INTEGER)')
cursor.close()
cnx.close()

Additional context

The documentation should be updated... The code there doesn't run as is...

https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/sqlite3/sqlite3.html

It should create the table first!

Would you like to implement a fix?

None

PRs

• Update sqlite3 instrumentor doc about explicit cursors #3088
• Todo: implement wrap of connection.execute

[Kludex]

This happens because the implementation of execute is in C: https://github.com/python/cpython/blob/c91ccbe4ac0ec15c503521f539b3528db85871b4/Modules/_sqlite/connection.c#L1803-L1824

[tammy-baylis-swi]

I think it might be from DB-API integration's TracedCursorProxy wrapping cursor.execute, but TraceConnectionProxy doesn't wrap connection.execute.

It could be a non-trivial fix for the latter to be added directly to DB-API integration, or to a subclass in the sqlite3 instrumentor (latter possibly requiring more subclasses/overrides to work). But anyone is welcome to give it a try 🙂

I've created a small docs update PR to encourage use of explicit cursors (cursor.execute) to make sure tracing is supported: #3088

I've also appended a "PRs" section to OP to prevent automated issue closing if multiple PRs.

[Kludex]

@xrmx Can you reopen this issue? Explaining why this is an issue doesn't solve the issue...

[Kludex]

It could be a non-trivial fix for the latter to be added directly to DB-API integration [...]

That would be wrong anyway. This specific for sqlite3. The other database packages don't support calling execute or the cursor methods from the Connection object.

[tammy-baylis-swi]

This specific for sqlite3.

Then one could try to subclass the connection proxy in the sqlite3 instrumentor as I had also suggested in [...]. 🙂