From 1d25c471dc6756ec8df6079f3d389c1034590627 Mon Sep 17 00:00:00 2001 From: John Cardinal Date: Tue, 14 Dec 2021 17:08:55 +0000 Subject: [PATCH] --- .../ops-config-report-render-browser-path.md | 11 ++++++++++- ...ps-config-report-rendering-max-instances.md | 9 +++++++++ .../ops-config-report-rendering-timeout.md | 18 ++++++++++++------ .../docs/ops-config-set-superuser-pw.md | 10 ++++++++-- docs/8.0/ayanova/docs/ops-config-use-urls.md | 9 +++++++++ 5 files changed, 48 insertions(+), 9 deletions(-) diff --git a/docs/8.0/ayanova/docs/ops-config-report-render-browser-path.md b/docs/8.0/ayanova/docs/ops-config-report-render-browser-path.md index 9197c00a..40dc7f0b 100644 --- a/docs/8.0/ayanova/docs/ops-config-report-render-browser-path.md +++ b/docs/8.0/ayanova/docs/ops-config-report-render-browser-path.md @@ -4,7 +4,7 @@ This optional setting sets the _full_ path to the Chromium web browser executabl If not set, AyaNova will attempt to automatically download a copy of Chromium to a `.local-chromium` folder under the AyaNova executable folder on first report rendering. -This setting is typically only required for Linux Server operating systems. +This setting is typically not required to be set. ## Default @@ -18,6 +18,15 @@ AyaNova expects the report rendering browser path to be provided by a config.jso The value specified should be a string containing a fully qualified file path to the Chromium browser. +Example config.json entry + +```json +{ + ...other properties... + "AYANOVA_REPORT_RENDER_BROWSER_PATH": "/usr/bin/chromium-browser" +} +``` + Example command line parameter `ayanova.exe --AYANOVA_REPORT_RENDER_BROWSER_PATH="/usr/bin/chromium-browser"` ) diff --git a/docs/8.0/ayanova/docs/ops-config-report-rendering-max-instances.md b/docs/8.0/ayanova/docs/ops-config-report-rendering-max-instances.md index 4751cf87..f69954d0 100644 --- a/docs/8.0/ayanova/docs/ops-config-report-rendering-max-instances.md +++ b/docs/8.0/ayanova/docs/ops-config-report-rendering-max-instances.md @@ -38,6 +38,15 @@ AyaNova expects this value to be provided by a config.json property, environment The value specified should be a string specifying the value as an integer, for example: `5` +Example config.json entry + +```json +{ + ...other properties... + "AYANOVA_REPORT_RENDERING_MAX_INSTANCES": "5" +} +``` + Example command line parameter `ayanova.exe --AYANOVA_REPORT_RENDERING_MAX_INSTANCES="5` diff --git a/docs/8.0/ayanova/docs/ops-config-report-rendering-timeout.md b/docs/8.0/ayanova/docs/ops-config-report-rendering-timeout.md index 58238456..0c78f856 100644 --- a/docs/8.0/ayanova/docs/ops-config-report-rendering-timeout.md +++ b/docs/8.0/ayanova/docs/ops-config-report-rendering-timeout.md @@ -6,16 +6,15 @@ This avoids a situation where a subsequent user can not get their report because ## Performance implications -Note that increasing report rendering settings too high can result in the server running out of physical memory or CPU capacity. When increasing the limits be mindful of this potential and monitor the server carefully to ensure it's not "bottlenecking". The reporting capacity scales directly with the amount of memory and CPU capacity available to the server. +Note that increasing report rendering settings too high can result in the server running out of physical memory or CPU capacity. When increasing the limits be mindful of this potential and monitor the server carefully to ensure it's not "bottlenecking". The reporting capacity scales directly with the amount of memory and CPU capacity available to the server. ## How timeouts work -When a report is requested to be rendered AyaNova starts the process and makes note of the time and will process that report indefinitely for as long as it takes to complete. However, if a subsequent report request is made and the first report has not completed yet then AyaNova will use this setting to wait for the first report to process before starting the next one. If the timeout period completes without the first report completed rendering then AyaNova will forcibly stop processing the first report and release the resources dedicated to it and start processing the new report. +When a report is requested to be rendered AyaNova starts the process and makes note of the time and will process that report indefinitely for as long as it takes to complete. However, if a subsequent report request is made and the first report has not completed yet then AyaNova will use this setting to wait for the first report to process before starting the next one. If the timeout period completes without the first report completed rendering then AyaNova will forcibly stop processing the first report and release the resources dedicated to it and start processing the new report. It's important to note that this timeout does not prevent AyaNova from processing a report for any length of time necessary to complete it; this timeout only takes effect if another report is requested to be rendered so if a User has to render a very large report that is known to take longer than the timeout period they would be advised to render that report when no one else is requesting a report (i.e. after hours) - -The value is specified in **milliseconds** or thousandths of a second. For example a 30 second timeout is 30000 milliseconds. +The value is specified in **milliseconds** or thousandths of a second. For example a 30 second timeout is 30000 milliseconds. ## Default @@ -39,6 +38,15 @@ AyaNova expects this value to be provided by a config.json property, environment The value specified should be a string specifying the timeout in **milliseconds**, for example: `30000` +Example config.json entry + +```json +{ + ...other properties... + "AYANOVA_REPORT_RENDERING_TIMEOUT": "45000" +} +``` + Example command line parameter `ayanova.exe --AYANOVA_REPORT_RENDERING_TIMEOUT="30000` @@ -52,5 +60,3 @@ Windows Linux / MAC `export AYANOVA_REPORT_RENDERING_TIMEOUT="120000"` - - diff --git a/docs/8.0/ayanova/docs/ops-config-set-superuser-pw.md b/docs/8.0/ayanova/docs/ops-config-set-superuser-pw.md index 6e6ace75..bbfee841 100644 --- a/docs/8.0/ayanova/docs/ops-config-set-superuser-pw.md +++ b/docs/8.0/ayanova/docs/ops-config-set-superuser-pw.md @@ -17,6 +17,14 @@ AyaNova expects the override password to be provided by a config.json property, The value specified should be a string used to temporarily override the super user password e.g.: `Th3RainInSpainFallsMainlyOnTh3Pla1n` +Example config.json entry + +```json +{ + ...other properties... + "AYANOVA_REPORT_RENDERING_TIMEOUT": "Th3RainInSpainFallsMainlyOnTh3Pla1n" +} +``` Example command line parameter @@ -31,5 +39,3 @@ Windows Linux / MAC `export AYANOVA_SET_SUPERUSER_PW="Th3RainInSpainFallsMainlyOnTh3Pla1n"` - - diff --git a/docs/8.0/ayanova/docs/ops-config-use-urls.md b/docs/8.0/ayanova/docs/ops-config-use-urls.md index 90ce0075..02eea411 100644 --- a/docs/8.0/ayanova/docs/ops-config-use-urls.md +++ b/docs/8.0/ayanova/docs/ops-config-use-urls.md @@ -19,6 +19,15 @@ AyaNova expects the PORT and URL to be provided by a config.json property, envir The value specified should be a string of one or more semicolon separated values, for example: `http://*:5000;http://localhost:5001;https://hostname:5002` +Example config.json entry + +```json +{ + ...other properties... + "AYANOVA_USE_URLS": "http://*:49152" +} +``` + Example command line parameter `ayanova.exe --AYANOVA_USE_URLS="http://*:5000"`