DOC-391 | Release notes for AQL graph traversal tracing (arangodb#1323)

Simran-B · nerpaula · web-flow · commit 192c921de184 · 2023-04-12T15:22:58.000+08:00
* Release notes for AQL graph traversal tracing

* Feedback

---------

Co-authored-by: Paula Mihu &lt;97217318+nerpaula@users.noreply.github.com&gt;
diff --git a/3.11/release-notes-api-changes311.md b/3.11/release-notes-api-changes311.md
@@ -57,6 +57,12 @@ value of `0` as the `numberOfShards`. They now return the actual number of
 shards. This value can be higher than the configured `numberOfShards` value of
 the graph due to internally used hidden collections.
 
+#### Log API
+
+Setting the log level for the `graphs` log topic to `TRACE` now logs detailed
+information about AQL graph traversals and (shortest) path searches.
+Some new log messages are also logged for the `DEBUG` level.
+
 ### Privilege changes
 
 
diff --git a/3.11/release-notes-new-features311.md b/3.11/release-notes-new-features311.md
@@ -233,3 +233,21 @@ You can configure the feature via the following new startup options:
   Note that an auto-flush is only executed if the number of live WAL files
   exceeds the configured threshold and the last auto-flush is longer ago than
   the configured auto-flush check interval. This avoids too frequent auto-flushes.
+
+## Miscellaneous changes
+
+### Trace logs for graph traversals and path searches
+
+Detailed information is now logged if you run AQL graph traversals
+or (shortest) path searches with AQL and set the
+log level to `TRACE` for the `graphs` log topic. This information is fairly
+low-level but can help to understand correctness and performance issues with
+traversal queries. There are also some new log messages for the `DEBUG` level.
+
+To enable tracing for traversals and path searches at startup, you can set
+`--log.level graphs=trace`.
+
+To enable or disable it at runtime, you can call the
+[`PUT /_admin/log/level`](http/monitoring.html#modify-and-return-the-current-server-log-level)
+endpoint of the HTTP API and set the log level using a request body like
+`{"graphs":"TRACE"}`.
