Skip to content

Commit ee378c9

Browse files
authored
Doc improvement for database tracer (#11)
1 parent 647deea commit ee378c9

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,8 @@ See the documentation for more information:
285285
* [`trace_sql_database_request`](https://dynatrace.github.io/OneAgent-SDK-for-Python/docs/sdkref.html#oneagent.sdk.SDK.trace_sql_database_request)
286286
* [`DatabaseRequestTracer`](https://dynatrace.github.io/OneAgent-SDK-for-Python/docs/sdkref.html#oneagent.sdk.tracers.DatabaseRequestTracer)
287287

288+
Please note that SQL database traces are only created if they occur within some other SDK trace (e.g. incoming remote call).
289+
288290
<a name="incoming-web-requests"></a>
289291
### Incoming web requests
290292

src/oneagent/sdk/__init__.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,10 @@ def create_web_application_info(
136136
def trace_sql_database_request(self, database, sql):
137137
'''Create a tracer for the given database info and SQL statement.
138138
139+
.. note::
140+
Please note that SQL database traces are only created if they occur
141+
within some other SDK trace (e.g. incoming remote call).
142+
139143
:param DbInfoHandle database: Database information (see
140144
:meth:`create_database_info`).
141145
:param str sql: The SQL statement to trace.

0 commit comments

Comments
 (0)