Skip to content

Commit 772495b

Browse files
Adjust wording
1 parent 893ed45 commit 772495b

File tree

1 file changed

+7
-7
lines changed
  • instrumentation/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi

1 file changed

+7
-7
lines changed

instrumentation/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@
5555
Configuration
5656
-------------
5757
58-
SQLCOMMENTER
58+
SQLCommenter
5959
************
60-
sqlcommenter is supported by several database client framework/ORM-specific
60+
sqlcommenter is supported by several Python database client framework/ORM-specific
6161
instrumentors. See their respective docs for how to opt into this feature at
6262
`instrumentation`_. There is no need to opt in at the DB-API level unless setting up
6363
its integration directly.
@@ -67,7 +67,7 @@
6767
If using DB-API instrumentation directly, you can optionally enable sqlcommenter which
6868
enriches the query with contextual information. Queries made after setting up
6969
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
7171
supports context propagation between database client and server when database log
7272
records are enabled. For more information, see:
7373
@@ -91,9 +91,9 @@
9191
)
9292
9393
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
9797
instrumentors. See their respective docs for how to configure this feature at
9898
`instrumentation`_. There is no need to configure at the DB-API level unless setting up
9999
its integration directly.
@@ -129,7 +129,7 @@
129129
Available commenter options
130130
###########################
131131
132-
The following options can be configured through ``commenter_options``:
132+
The following sqlcomment key-values can be opted out of through ``commenter_options``:
133133
134134
+---------------------------+-----------------------------------------------------------+---------------------------------------------------------------------------+
135135
| Commenter Option | Description | Example |

0 commit comments

Comments
 (0)