Document admin mode for gds.beta.listProgress

Author: FlorentinD

doc-test-tools/src/main/java/org/neo4j/gds/doc/syntax/SyntaxMode.java

@@ -58,6 +58,8 @@ public enum SyntaxMode {
     PIPELINE_LIST("pipeline-list-syntax"),
     PIPELINE_EXISTS("pipeline-exists-syntax"),
     PIPELINE_DROP("pipeline-drop-syntax"),
+    LIST_PROGRESS("listProgress-syntax"),
+    USER_LOG("userlog-syntax", false),
     SYSTEM_MONITOR("system-monitor-syntax", false),
     SYS_INFO("debug-sysinfo-syntax", false),
     WRITE_NODE_LABEL("include-with-write-node-label", false),;

doc-test/src/test/java/org/neo4j/gds/doc/syntax/LoggingSyntaxTest.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds.doc.syntax;
+
+import java.util.List;
+
+class LoggingSyntaxTest extends SyntaxTestBase {
+
+    @Override
+    protected Iterable<SyntaxModeMeta> syntaxModes() {
+        return List.of(
+            SyntaxModeMeta.of(SyntaxMode.LIST_PROGRESS),
+            SyntaxModeMeta.of(SyntaxMode.USER_LOG)
+        );
+    }
+
+    @Override
+    protected String adocFile() {
+        return "pages/common-usage/logging.adoc";
+    }
+}

doc/modules/ROOT/pages/common-usage/logging.adoc

@@ -37,15 +37,22 @@ Second, if the `jobId` parameter is set it will show a detailed view for the giv
 The detailed view will produce a row for each step or task that job will perform during execution.
 It will also show how tasks are structured as a tree and print progress for each individual task.
 
+[NOTE]
+====
+For administrator users, this procedure will also list the running tasks from other users.
+====
 
 [[logging-progress-logging-syntax]]
 === Syntax
 
+[.listProgress-syntax]
+--
 .Getting the progress of tasks:
 [source, cypher, role=noplay]
 ----
 CALL gds.beta.listProgress(jobId: String)
 YIELD
+  username,
   jobId,
   taskName,
   progress,
@@ -66,6 +73,7 @@ YIELD
 [opts="header",cols="2m,1,6"]
 |===
 | Name          | Type      | Description
+| username      | String    | The user who started the running task.
 | jobId         | String    | A generated identifier of the running task.
 | taskName      | String    | The name of the running task, i.e. `Node2Vec`.
 | progress      | String    | The progress of the job shown as a percentage value.
@@ -74,6 +82,7 @@ YIELD
 | timeStarted   | LocalTime | The local wall clock time when the task has been started.
 | elapsedTime   | Duration  | The duration from `timeStarted` to now.
 |===
+--
 
 [NOTE]
 ====
@@ -119,6 +128,8 @@ When a user calls procedure `gds.alpha.userLog`, their respective list of genera
 [[userlog-syntax]]
 === Syntax
 
+[.userlog-syntax]
+--
 .Getting the hints and warnings for a user:
 [source,cypher,role=noplay]
 ----
@@ -137,6 +148,7 @@ YIELD
 |timeStarted      | LocalTime      | The local wall clock time when the task has been started.
 | message      | String    | A hint or warning associated with the task.
 |===
+--
 
 
 [[userlog-examples]]