Skip to content

Commit 32d71a2

Browse files
committed
Add jobId note to logging docs
1 parent c60d8a2 commit 32d71a2

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

doc/asciidoc/common-usage/logging.adoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ Second, if the `jobId` parameter is set it will show a detailed view for the giv
3838
The detailed view will produce a row for each step or task that job will perform during execution.
3939
It will also show how tasks are structured as a tree and print progress for each individual task.
4040

41+
4142
[[logging-progress-logging-syntax]]
4243
=== Syntax
4344

@@ -63,7 +64,7 @@ YIELD
6364
|===
6465

6566
.Results
66-
[opts="header",cols="1m,1,6"]
67+
[opts="header",cols="2m,1,6"]
6768
|===
6869
| Name | Type | Description
6970
| jobId | String | A generated identifier of the running task.
@@ -75,6 +76,13 @@ YIELD
7576
| elapsedTime | Duration | The duration from `timeStarted` to now.
7677
|===
7778

79+
[NOTE]
80+
====
81+
Some kinds of jobs that typically take while to run, like graph projections and running algorithms, takes an optional `jobId` in their configuration parameter maps.
82+
This can make tracking them easier as they will then be listed under the provided `jobId` in the `gds.beta.listProgress` results.
83+
For algorithms, see <<common-configuration-jobid, the `jobId` parameter documentation>> for more on this.
84+
====
85+
7886

7987
[[logging-progress-logging-examples]]
8088
=== Examples
@@ -97,6 +105,7 @@ YIELD
97105
| "d21bb4ca-e1e9-4a31-a487-42ac8c9c1a0d" | "Node2Vec" | "42%"
98106
|===
99107

108+
100109
[[logging-user-warnings]]
101110
[.alpha]
102111
== User Log
@@ -105,6 +114,7 @@ Hints and warnings can also be tracked through the GDS library and be accessed v
105114
The GDS library keeps track for each user their 100 most recent tasks that have generated hints or warnings and stores them in memory.
106115
When a user calls procedure `gds.alpha.userLog`, their respective list of generated hints and warnings is returned.
107116

117+
108118
[[userlog-syntax]]
109119
=== Syntax
110120

@@ -127,6 +137,7 @@ YIELD
127137
| message | String | A hint or warning associated with the task.
128138
|===
129139

140+
130141
[[userlog-examples]]
131142
=== Examples
132143

0 commit comments

Comments
 (0)