open-telemetry / open-telemetry/opentelemetry-python-contrib
`opentelemetry-instrumentation-tortoiseorm`: capture `db.query.parameter.<key>`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 1.1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 16
Description
Part of #4787 (global db.query.parameter.<key> tracking issue).
Background
tortoiseorm does not build on the dbapi base. It independently captures
parameters as the non-standard db.statement.parameters blob (a single
stringified value) when capture_parameters=True.
What to do
- Reuse the shared
_set_db_query_parametershelper from
opentelemetry.instrumentation._semconv(added in the dbapi sub-issue). - When
capture_parametersis enabled:- emit
db.statement.parametersonly under the old semconv; - emit
db.query.parameter.<key>under the new semconv via the helper.
- emit
- Key positional parameters by 0-based index and named parameters by name,
depending on what the underlying driver passes through Tortoise. - Do not capture parameters on batch operations (
executemany). - If the package does not yet resolve the database semconv opt-in mode, wire it
up the same way the other database instrumentations do.
Acceptance criteria
- Old semconv:
db.statement.parametersunchanged; nodb.query.parameter.*. - New semconv:
db.query.parameter.<key>emitted; nodb.statement.parameters. database/dup: both present.- Values captured as strings; batch operations do not emit
db.query.parameter.*.
Tests
- Cover old / new / dup modes and the batch case.
- Verify exact attribute names and string value types against the spec.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the TortoiseORM instrumentation and its tests, then read the shared _set_db_query_parameters helper in opentelemetry.instrumentation._semconv and the other database instrumentations' semconv opt-in handling. Add coverage for old, new, and database/dup modes plus executemany, verifying exact parameter attribute names, string values, and the required absence or presence of legacy attributes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- databases
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100