Fixes #2295: Add documentation to indicate that the procedures are no…

…t detected by MemoryTracker (#2296)
neo4j-contrib · Nov 20, 2021 · ec190e4 · ec190e4
1 parent 41d093e
commit ec190e4
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/docs/asciidoc/modules/ROOT/index.adoc b/docs/asciidoc/modules/ROOT/index.adoc
diff --git a/docs/asciidoc/modules/ROOT/nav.adoc b/docs/asciidoc/modules/ROOT/nav.adoc
@@ -18,6 +18,8 @@ include::partial$generated-documentation/nav.adoc[]
 
 * xref::config/index.adoc[]
 
+* xref::general-considerations/index.adoc[]
+
 * xref::import/index.adoc[]
     ** xref::import/web-apis.adoc[]
     ** xref::import/load-json.adoc[]

diff --git a/docs/asciidoc/modules/ROOT/pages/general-considerations/index.adoc b/docs/asciidoc/modules/ROOT/pages/general-considerations/index.adoc
@@ -0,0 +1,13 @@
+[[general-considerations]]
+= General considerations
+:description: This chapter describes a list of information to consider using the APOC library.
+
+To use the APOC library it's necessary to consider the following issues.
+
+.Memory tracker
+
+The APOC procedures (and in general, the Neo4j procedures), currently are not detected by Neo4j Memory Tracker.
+This means that, for example, the xref::overview/apoc.path/apoc.path.expand.adoc[apoc.path.expand] procedure 
+doesn't stop if `dbms.memory.transaction.database_max_size` is reached, 
+and we cannot use the `call dbms.listTransactions() yield currentQuery, estimatedUsedHeapMemory` to monitor the memory usage of the query. 
+Therefore, please use the procedure carefully to avoid Java Heap space errors.