Docs: Update 2.8 RELEASE NOTES to include new Bug Fixes section
authorBen Shum <bshum@biblio.org>
Fri, 10 Apr 2015 14:48:43 +0000 (10:48 -0400)
committerBen Shum <bshum@biblio.org>
Fri, 10 Apr 2015 14:49:44 +0000 (10:49 -0400)
Signed-off-by: Ben Shum <bshum@biblio.org>
docs/RELEASE_NOTES_2_8.txt

index 4fbbfa9..fc21612 100644 (file)
@@ -338,8 +338,8 @@ displays better on mobile devices.
 
 
 
-Miscellaneous
--------------
+Bug Fixes
+---------
 
 IMPORTANT SECURITY INFORMATION
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -351,6 +351,40 @@ information.  If you are running a vulnerable release of Evergreen you
 are *strongly* encouraged to upgrade to a non-vulnerable release as
 soon as possible.
 
+Set resource limits for Clark Kent
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Several parameters are now available for the reporter daemon process
+(`clark-kent.pl`) to control resource usage.  These can be used to
+reduce the chances that a malformed report can cause indigestion
+on a database or reports server.  The new parameters, which can be
+set in `opensrf.xml` or as command-line switches for `clark-kent.pl` are
+
+* `//reporter/setup/statement_timeout` / `--statement-timeout`
+
+Number of minutes to allow a report's underlying SQL query
+to run before it gets cancelled.  Default value is
+60 minutes.  If a report's query gets cancelled, the
+error_text value will be set to a valid that indicates that
+the allowed time was exceeded.
+
+* `//reporter/setup/max_rows_for_charts` / `--max-rows-for-charts`
+
+Number of rows permitted in the query's output before
+Clark Kent refuses to attempt to draw a graph. Default
+value is 1,000 rows.
+
+* `//reporter/setup/resultset_limit` / `--resultset-limit`
+
+If set, truncates the report's output to the specified
+number of hits.  Note that it will not be apparent
+to a staff user if the report's output has been
+truncated.  Default value is unlimited.
+
+The report concurrency (i.e., the number of reports that Clark
+Kent will run in parallel) can now also be controlled via
+the `opensrf.xml` setting `//reporter/setup/parallel`.
+
+
 Acknowledgments
 ---------------
 The Evergreen project would like to acknowledge the following