Skip to content

Commit 1a7e2a4

Browse files
Table instead of numbered list commenter options
1 parent 6160090 commit 1a7e2a4

File tree

1 file changed

+17
-20
lines changed
  • instrumentation/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi

1 file changed

+17
-20
lines changed

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

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -131,26 +131,23 @@
131131
132132
The following options can be configured through ``commenter_options``:
133133
134-
#. ``db_driver`` - Database driver name with version.
135-
Example: ``mysql.connector=2.2.9``
136-
137-
#. ``dbapi_threadsafety`` - DB-API's threadsafety value.
138-
Example: ``dbapi_threadsafety=2``
139-
140-
#. ``dbapi_level`` - DB-API's API level.
141-
Example: ``dbapi_level=2.0``
142-
143-
#. ``driver_paramstyle`` - DB-API's paramstyle for SQL statement parameters.
144-
Example: ``driver_paramstyle='pyformat'``
145-
146-
#. ``libpq_version`` - PostgreSQL's libpq version (checked for PostgreSQL only).
147-
Example: ``libpq_version=140001``
148-
149-
#. ``mysql_client_version`` - MySQL client version (checked for MySQL only).
150-
Example: ``mysql_client_version='123'``
151-
152-
#. ``opentelemetry_values`` - OpenTelemetry context values.
153-
Example: ``traceparent='00-03afa25236b8cd948fa853d67038ac79-405ff022e8247c46-01'``
134+
+---------------------------+-----------------------------------------------------------+---------------------------------------------------------------------------+
135+
| Commenter Option | Description | Example |
136+
+===========================+===========================================================+===========================================================================+
137+
| ``db_driver`` | Database driver name with version. | ``mysql.connector=2.2.9`` |
138+
+---------------------------+-----------------------------------------------------------+---------------------------------------------------------------------------+
139+
| ``dbapi_threadsafety`` | DB-API's threadsafety value. | ``dbapi_threadsafety=2`` |
140+
+---------------------------+-----------------------------------------------------------+---------------------------------------------------------------------------+
141+
| ``dbapi_level`` | DB-API's API level. | ``dbapi_level=2.0`` |
142+
+---------------------------+-----------------------------------------------------------+---------------------------------------------------------------------------+
143+
| ``driver_paramstyle`` | DB-API's paramstyle for SQL statement parameters. | ``driver_paramstyle='pyformat'`` |
144+
+---------------------------+-----------------------------------------------------------+---------------------------------------------------------------------------+
145+
| ``libpq_version`` | PostgreSQL's libpq version (checked for PostgreSQL only). | ``libpq_version=140001`` |
146+
+---------------------------+-----------------------------------------------------------+---------------------------------------------------------------------------+
147+
| ``mysql_client_version`` | MySQL client version (checked for MySQL only). | ``mysql_client_version='123'`` |
148+
+---------------------------+-----------------------------------------------------------+---------------------------------------------------------------------------+
149+
| ``opentelemetry_values`` | OpenTelemetry context as traceparent at time of query. | ``traceparent='00-03afa25236b8cd948fa853d67038ac79-405ff022e8247c46-01'`` |
150+
+---------------------------+-----------------------------------------------------------+---------------------------------------------------------------------------+
154151
155152
API
156153
---

0 commit comments

Comments
 (0)