$smwgQueryProfiler

From semantic-mediawiki.org


Configuration parameter details:
Name $smwgQueryProfiler
Description Sets whether specific monitorable profile data are recorded
Default setting
true
Software Semantic MediaWiki
Since version
Until version still available
Configuration Installation
Keyword monitoring · profiling


$smwgQueryProfiler is a configuration parameter that sets whether specific monitorable profile data for queries such as query duration and query parameters are recorded or not. The configuration parameter was introduced in Semantic MediaWiki 1.9.0Released on 3 January 2014 and compatible with MW 1.19.0 - 1.22.x..1 Starting with Semantic MediaWiki 2.5.0Released on 14 March 2017 and compatible with MW 1.23.0 - 1.29.x. an additional option to record query parameters is available.2

This configuration parameter underwent a major change in Semantic MediaWiki 3.0.0Released on 11 October 2018 and compatible with MW 1.27.0 - 1.31.x. aiming at simplifying the setup.3 See this version of the documentation available for releases prior to Semantic MediaWiki 3.0.0Released on 11 October 2018 and compatible with MW 1.27.0 - 1.31.x..

Default setting[edit]

$smwgQueryProfiler = true;

This means that query profiling is enabled for Query size, Query depth, Query format, Query string and Query scode (status code).

Available options[edit]

  • SMW_QPRFL_DUR - Allows recording the query duration (the time between the query result selection and its output) / since Semantic MediaWiki 1.9.0Released on 3 January 2014 and compatible with MW 1.19.0 - 1.22.x.
  • SMW_QPRFL_PARAMS - Allows recording the query parameters (the parameters like limits and sorting influencing on how and which results are selected for the output) / since Semantic MediaWiki 2.5.0Released on 14 March 2017 and compatible with MW 1.23.0 - 1.29.x.
The option's strings have changed starting with Semantic MediaWiki 3.0.0Released on 11 October 2018 and compatible with MW 1.27.0 - 1.31.x..

Changing the default setting[edit]

If you change the setting for this configuration parameter, please ensure to run maintenance script "setupStore.php"Allows to set up the data backend/store followed by maintenance script "rebuildData.php"Allows to rebuild all the semantic data for a selected data backend/store.

To modify the setting to this configuration parameter, add one of the following lines to your "LocalSettings.php" file after the enableSemantics() call:

Enable the recording of query duration
$smwgQueryProfiler = SMW_QPRFL_DUR;
Enable the recording of query parameters
$smwgQueryProfiler = SMW_QPRFL_PARAMS;
Enable the recording of query duration and query parameters
$smwgQueryProfiler = SMW_QPRFL_DUR | SMW_QPRFL_PARAMS;
Disable all query profiling from being recorded
$smwgQueryProfiler = false;
This setting is not recommended since the disabled functionality may impact secondary processes that rely on profile information to be available (notification system etc.).

See also[edit]

References

  1. ^  Semantic MediaWiki: GitHub pull request gh:smw:30
  2. ^  Semantic MediaWiki: GitHub pull request gh:smw:2270
  3. ^  Semantic MediaWiki: GitHub pull request gh:smw:2732