Skip to content

Commit 0756066

Browse files
Document logProgress configuration parameter
Co-authored-by: Ioannis Panagiotas <ioannis.panagiotas@neotechnology.com>
1 parent 58d80ec commit 0756066

File tree

3 files changed

+6
-0
lines changed

3 files changed

+6
-0
lines changed

doc/modules/ROOT/pages/common-usage/running-algos.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,3 +130,7 @@ The Default is `concurrency`
130130
[[common-configuration-jobid]]
131131
jobId - String::
132132
An id for the job to be started can be provided in order for it to be more easily tracked with eg. GDS's xref:common-usage/logging.adoc[logging capabilities].
133+
134+
[[common-configuration-logProgress]]
135+
logProgress - Boolean::
136+
Configuration parameter that allows to turn `off/on` percentage logging while running procedure. It is `on` by default
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
| xref:common-usage/running-algos.adoc#common-configuration-concurrency[concurrency] | Integer | 4 | yes | The number of concurrent threads used for running the algorithm.
22
| xref:common-usage/running-algos.adoc#common-configuration-jobid[jobId] | String | Generated internally | yes | An ID that can be provided to more easily track the algorithm's progress.
3+
| xref:common-usage/running-algos.adoc#common-configuration-logProgress[logProgress] | Boolean | true | yes | If disabled the progress percentage will not be logged.

doc/modules/ROOT/partials/algorithms/common-configuration/common-configuration.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@
44
| Name | Type | Default | Optional | Description
55
| xref:common-usage/running-algos.adoc#common-configuration-concurrency[concurrency] | Integer | 4 | yes | The number of concurrent threads used for running the algorithm. Also provides the default value for 'readConcurrency' and 'writeConcurrency'.
66
| xref:common-usage/running-algos.adoc#common-configuration-write-concurrency[writeConcurrency] | Integer | value of 'concurrency' | yes | The number of concurrent threads used for writing the result (applicable in WRITE mode).
7+
| xref:common-usage/running-algos.adoc#common-configuration-logProgress[logProgress] | Boolean | true | yes | If disabled the progress percentage will not be logged.
78
|===

0 commit comments

Comments
 (0)