Attach metadata to SQL queries for debugging purposes #624

New Issue

MrUnknownDE · 2026-04-05T16:56:08+02:00

MrUnknownDE commented

2026-04-05 16:56:08 +02:00

Originally created by @jeremystretch on 1/9/2026

NetBox version

v4.5.0

Feature type

New functionality

Proposed functionality

Log certain metadata as comments on SQL queries as they are submitted to the database. This might include:

Request method & URL
Request ID (for correlation of SQL queries)
Authenticated user
HTTP user agent
Application version
Representation of the originating queryset

We might employ the OSS tool sqlcommenter, which has a Django integration delivered via middleware, or implement our own solution.

An example comment from sqlcommenter looks like this:

SELECT ...
FROM "core_objecttype" ...
WHERE ("django_content_type"."app_label" = 'dcim' AND "django_content_type"."model" = 'devicerole')
LIMIT 21
/*controller='dcim-api%3Adevicerole-list',framework='django%3A5.2.9',route='api/dcim/device-roles/%24'*/;
args=('dcim', 'devicerole');
alias=default

We might opt to attach these comments by default, or only when debugging is enabled.

Use case

Such metadata can be extremely helpful in correlating SQL queries with their points of origination within the application, especially when attempting to troubleshoot performance issues.

Database changes

N/A

External dependencies

N/A

*Originally created by @jeremystretch on 1/9/2026* ### NetBox version v4.5.0 ### Feature type New functionality ### Proposed functionality Log certain metadata as comments on SQL queries as they are submitted to the database. This might include: - Request method & URL - Request ID (for correlation of SQL queries) - Authenticated user - HTTP user agent - Application version - Representation of the originating queryset We might employ the OSS tool [sqlcommenter](https://github.com/google/sqlcommenter/tree/master), which has a Django integration delivered via middleware, or implement our own solution. An example comment from sqlcommenter looks like this: ``` SELECT ... FROM "core_objecttype" ... WHERE ("django_content_type"."app_label" = 'dcim' AND "django_content_type"."model" = 'devicerole') LIMIT 21 /*controller='dcim-api%3Adevicerole-list',framework='django%3A5.2.9',route='api/dcim/device-roles/%24'*/; args=('dcim', 'devicerole'); alias=default ``` We might opt to attach these comments by default, or only when debugging is enabled. ### Use case Such metadata can be extremely helpful in correlating SQL queries with their points of origination within the application, especially when attempting to troubleshoot performance issues. ### Database changes N/A ### External dependencies N/A

MrUnknownDE closed this issue

2026-04-05 16:56:08 +02:00

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

No Label netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#624