|
55 | 55 | Configuration |
56 | 56 | ------------- |
57 | 57 |
|
58 | | -SQLCOMMENTER |
| 58 | +SQLCommenter |
59 | 59 | ************ |
60 | | -sqlcommenter is supported by several database client framework/ORM-specific |
| 60 | +sqlcommenter is supported by several Python database client framework/ORM-specific |
61 | 61 | instrumentors. See their respective docs for how to opt into this feature at |
62 | 62 | `instrumentation`_. There is no need to opt in at the DB-API level unless setting up |
63 | 63 | its integration directly. |
|
67 | 67 | If using DB-API instrumentation directly, you can optionally enable sqlcommenter which |
68 | 68 | enriches the query with contextual information. Queries made after setting up |
69 | 69 | trace integration with sqlcommenter enabled will have configurable key-value pairs |
70 | | -appended to them, e.g. ``"select * from auth_users; /*metrics=value*/"``. This |
| 70 | +appended to them, e.g. ``"select * from auth_users; /*traceparent=00-01234567-abcd-01*/"``. This |
71 | 71 | supports context propagation between database client and server when database log |
72 | 72 | records are enabled. For more information, see: |
73 | 73 |
|
|
91 | 91 | ) |
92 | 92 |
|
93 | 93 |
|
94 | | -SQLCommenter Configurations |
95 | | -*************************** |
96 | | -sqlcommenter is supported by several database client framework/ORM-specific |
| 94 | +SQLComment customization |
| 95 | +************************ |
| 96 | +sqlcommenter is supported by several Python database client framework/ORM-specific |
97 | 97 | instrumentors. See their respective docs for how to configure this feature at |
98 | 98 | `instrumentation`_. There is no need to configure at the DB-API level unless setting up |
99 | 99 | its integration directly. |
|
129 | 129 | Available commenter options |
130 | 130 | ########################### |
131 | 131 |
|
132 | | -The following options can be configured through ``commenter_options``: |
| 132 | +The following sqlcomment key-values can be opted out of through ``commenter_options``: |
133 | 133 |
|
134 | 134 | +---------------------------+-----------------------------------------------------------+---------------------------------------------------------------------------+ |
135 | 135 | | Commenter Option | Description | Example | |
|
0 commit comments