]> git.evergreen-ils.org Git - working/Evergreen.git/blob - docs/RELEASE_NOTES_NEXT/Administration/set_resource_limits_for_reporter.txt
LP#1435494: add release notes entry
[working/Evergreen.git] / docs / RELEASE_NOTES_NEXT / Administration / set_resource_limits_for_reporter.txt
1 Set resource limits for Clark Kent
2 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3 Several parameters are now available for the reporter daemon process
4 (`clark-kent.pl`) to control resource usage.  These can be used to
5 reduce the chances that a malformed report can cause indigestion
6 on a database or reports server.  The new parameters, which can be
7 set in `opensrf.xml` or as command-line switches for `clark-kent.pl` are
8
9 * `//reporter/setup/statement_timeout` / `--statement-timeout`
10
11 Number of minutes to allow a report's underlying SQL query
12 to run before it gets cancelled.  Default value is
13 60 minutes.  If a report's query gets cancelled, the
14 error_text value will be set to a valid that indicates that
15 the allowed time was exceeded.
16
17 * `//reporter/setup/max_rows_for_charts` / `--max-rows-for-charts`
18
19 Number of rows permitted in the query's output before
20 Clark Kent refuses to attempt to draw a graph. Default
21 value is 1,000 rows.
22
23 * `//reporter/setup/resultset_limit` / `--resultset-limit`
24
25 If set, truncates the report's output to the specified
26 number of hits.  Note that it will not be apparent
27 to a staff user if the report's output has been
28 truncated.  Default value is unlimited.
29
30 The report concurrency (i.e., the number of reports that Clark
31 Kent will run in parallel) can now also be controlled via
32 the `opensrf.xml` setting `//reporter/setup/parallel`.