Page is a draft due to changes in included resources
You are viewing an old version of this page. Return to the latest version.
Difference between revisions of "Manual:Extension/BlueSpiceExtendedStatistics"
| [unchecked revision] | [quality revision] |
Fbaeckmann (talk | contribs) m (Text replacement - "[[ExtendedStatistics" to "[[Reference:ExtendedStatistics") |
(Tag: Visual edit) |
/tmp/bshtmldiff/helpdesk_en-hw_/10597.html (Datei oder Verzeichnis nicht gefunden)
<bs:bookshelf src="Book:User manual" /> __TOC__ ==What is ExtendedStatistics?== {{DISPLAYTITLE:Extended statistics}} The extension '''ExtendedStatistics''' provides an analytic view of many relevant parameters on the wiki, providing wiki administrators better insight into the functioning of the wiki. ==Where to find ExtendedStatistics?== "Global actions", "Extended statistics": :::Extended statistics== The navigation link ''Extended statistics'' in the tab Global actions loads the page ''Special:ExtendedStatistics''. <br /> [[File:ExtendedStatistics1.png|thumb]] [[File:ExtendedStatistics2.png|thumb]] ===Choose the database=== Next, choose the database you want to use: *Number of users:|alt=Extended statistics navigation link|center|650x650px|Extended statistics navigation link]] ==Choosing a data source== ExtendedStatistics can show data for multiple aspects of the wiki. Available data sources are: *''Number of users:'' All the users that registered in the period chosen. * *''Number of pages:'' All pages created in the period chosen. Namespace, linking and so on play no role here. *Number of articles: All articles which were created *''Number of content pages:'' All articles in content namespaces created in the period chosen *''Number of edits:'' All edits carried out in the period chosen, lie in a content namespace and have at least one internal link. The numbers should conform with the article's MediaWiki statistics. Note: MediaWiki has changes the way it counts a little in Version 1.18. This can lead to slight discrepancies. *Number of edits: All edits carried out in the period chosen. *Edits per user: The quotient of "number of edits" and "number of users" in each interval is shown. ===Choose a filter=== Enter the settings you want:<br />'''Date range:''' *Both data fields empty: No time restriction. *From date empty: Starting from the earliest creation / edit / registration / search query. *To date empty: Up to the present day. '''Display:''' *Resolution (Year, month (default), week, day). *Mode: **Absolute: The actual numbers involved. **Aggregate: The running total. This graph will always either rise or stay at the same level. **As a list: The individual results will be shown as a sortable list. '''Filter:''' *Namespace: To choose several namespaces, hold down the CTRL key while clicking. No choice means that all namespaces will be considered. *Category: No choice means the results will not be filtered according to category, and pages not assigned to a category will be included. *Search space: Only for search query statistics. Enter which pages you want to be included in the statistics: Title, text, files, all. Excluded users: Select all users that shall not be included in the statistics. ==Tips for working with ExtendedStatistics== Carry out queries in small steps. If the server load is expected to be too high, you will be asked to minimise the steps. At the moment, a maximum of 366 steps (e.g. 366 weeks) can be entered. The maximum number will be set by the administrators in the preferences. The list of search queries can be sorted according to the "number of results". Queries which do not yield any information are especially interesting. There is clearly some information missing in the wiki. ==Classical statistics with MediaWiki== The statistics special page in MediaWiki has developed its own counting system. For example, an article or a content page will only be counted if: *It is in the main namespace or a different separately determined namespace. *It is not a redirect. *It contains at least one internal link. ==See also== *Our [[Reference:ExtendedStatistics|reference page]]. Further helpful information: *mediawiki.org: [http://www.mediawiki.org/wiki/Help:Magic_words Magic words] <div id="box-info" style="width: 98%; margin: 20px 0; border: solid 2px #99bbe8; padding: 8px; background-color: #d6e3f2;"> [[Image:Icon-link.png|left]]<div style="text-transform: uppercase; color: #99bbe8; font-size: 16px; font-weight: bold; margin: 0;">Related topics</div> <div color: 000> *[[SearchOptions|Search options]] *[[RecentChanges|Recent changes]] </div> </div> *''Edits per user:'' Number of edits per user in the period chosen *''Search queries:'' All terms users searched for in the period chosen. Only availble if [[Manual:Extension/ExtendedSearch|BlueSpiceExtendedSearch]] is installed. ==Choosing filters== General filters: *From - Date from which to display data *To - Date to which to display data Some data sources may have additional filters available, like for data sources based on wiki pages, namespace filter is available. <br /> [[File:Manual:Mediawiki Extension ExtendedStatistics.png|alt=Selecting a query type|center|thumb|300x300px|Selecting a query type]] <br /> ==Display settings== The display of the results is determined by the following settings: *Interval - grain of the diagram - determines which time unit will be used to group the data. *Mode - display type: **Absolute - shows changes in data for the given period **Aggregate - shows running total for the data source choosen **List - shows data in tabular view - only avaiable for search statistics {{Box Note|boxtype=note|Note text=Depending on the selected time period, the interval has to be set accordingly. For, example if you look for data between 02.06. and 03.06. for the same year, the interval setting "Year" will not return any data. Change the interval to "Week" or "Day" to return results.}} ==Viewing the results== Once all the filters and options are set, click on the ''Results'' tab to show the resulting data. <br /> [[File:ExtendedStatistics3.png|thumb|Result view with export buttons |alt=Results|center|650x650px]]<br /> ==<span class="mw-headline" id="Chart_export">Chart export</span>== In results view there is an ''Export-''button that allows the user to export and download the currently displayed chart as SVG. ==<span class="mw-headline" id="Data_export">Data export</span>== ===<span class="mw-headline" id="Location">Maintenance script</span>=== A <code>php</code> maintenance script will be provided on the following location: <code><mw-root>/extensions/BlueSpiceExtendedStatistics/maintenance/ExportCollection.php</code> ===<span class="mw-headline" id="Usage">Usage</span>=== This script must be called on the command line of the server. It takes the path of a configuration file in <code>JSON</code> format. '''Example''' php <mw-root>/extensions/BlueSpiceExtendedStatistics/maintenance/ExportCollection.php \ --config=<path-to-file>/myConfig.json \ --exportto=/tmp/myExport.xslx <span class="mw-headline" id="Params">'''Params'''</span> *<code>--config</code> - path to config file *<code>--exportto</code> - path to the file, the data gets exportet to. Note that vaiable file formats are <code>xsl</code>, <code>xslx</code> and <code>csv</code> ===<span class="mw-headline" id="Configuration">Scirpt configuration</span>=== The script configuration will take the same parameters as the API, which is used on Special:ExtendedStatistics. <span class="mw-headline" id="Params_2">'''Params'''</span> *<code>aggregate</code> *<code>filter</code> ===<span class="mw-headline" id="Examples">Example contents</span>=== The following examples show the content of the JSON file provided to <code>--config</code>. <span class="mw-headline" id=".22Page_views.22_aggregated_by_date_since_1_year_until_now">'''"Page views" aggregated by date over 1 year'''</span> <span class="p">{</span> <span class="nt">"aggregate"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="nt">"property"</span><span class="p">:</span> <span class="s2">"timestampcreated"</span><span class="p">,</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"daily"</span><span class="p">,</span> <span class="nt">"targets"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"pagetitle"</span><span class="p">,</span> <span class="s2">"numberhits"</span><span class="p">,</span> <span class="s2">"numberhitsaggregated"</span> <span class="p">]</span> <span class="p">}</span> <span class="p">],</span> <span class="nt">"filter"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="nt">"property"</span><span class="p">:</span> <span class="s2">"type"</span><span class="p">,</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"string"</span><span class="p">,</span> <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"hitcounter"</span><span class="p">,</span> <span class="nt">"comparison"</span><span class="p">:</span> <span class="s2">"eq"</span> <span class="p">},</span> <span class="p">{</span> <span class="nt">"property"</span><span class="p">:</span> <span class="s2">"timestampcreated"</span><span class="p">,</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"date"</span><span class="p">,</span> <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"20200707120000"</span><span class="p">,</span> <span class="nt">"comparison"</span><span class="p">:</span> <span class="s2">"gt"</span> <span class="p">},</span> <span class="p">{</span> <span class="nt">"property"</span><span class="p">:</span> <span class="s2">"timestampcreated"</span><span class="p">,</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"date"</span><span class="p">,</span> <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"20210707120000"</span><span class="p">,</span> <span class="nt">"comparison"</span><span class="p">:</span> <span class="s2">"lt"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> <span class="mw-headline" id=".22Review_by_namespaces.22_aggregated_by_namespace_since_1_year_until_now">'''"Review by namespaces" aggregated by namespace over 1 year'''</span>: <span class="p">{</span> <span class="nt">"aggregate"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="nt">"property"</span><span class="p">:</span> <span class="s2">"namespacename"</span><span class="p">,</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"string"</span><span class="p">,</span> <span class="nt">"targets"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"ongoingpages"</span><span class="p">,</span> <span class="s2">"expiredpages"</span><span class="p">,</span> <span class="s2">"notrunningpages"</span><span class="p">,</span> <span class="s2">"ongoingpagesaggregated"</span><span class="p">,</span> <span class="s2">"expiredpagesaggregated"</span><span class="p">,</span> <span class="s2">"notrunningpagesaggregated"</span> <span class="p">]</span> <span class="p">}</span> <span class="p">],</span> <span class="nt">"filter"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="nt">"property"</span><span class="p">:</span> <span class="s2">"type"</span><span class="p">,</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"string"</span><span class="p">,</span> <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"reviewedpages-ns"</span><span class="p">,</span> <span class="nt">"comparison"</span><span class="p">:</span> <span class="s2">"eq"</span> <span class="p">},</span> <span class="p">{</span> <span class="nt">"property"</span><span class="p">:</span> <span class="s2">"timestampcreated"</span><span class="p">,</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"date"</span><span class="p">,</span> <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"20200707120000"</span><span class="p">,</span> <span class="nt">"comparison"</span><span class="p">:</span> <span class="s2">"gt"</span> <span class="p">},</span> <span class="p">{</span> <span class="nt">"property"</span><span class="p">:</span> <span class="s2">"timestampcreated"</span><span class="p">,</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"date"</span><span class="p">,</span> <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"20210707120000"</span><span class="p">,</span> <span class="nt">"comparison"</span><span class="p">:</span> <span class="s2">"lt"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> <br /> ==Configuration== In the [[Manual:Extension/BlueSpiceConfigManager|Config manager]], you can change the following settings: {{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceExtendedStatistics}} {{Box Links-en|Topic1=[[Reference:BlueSpiceExtendedStatistics]]}} [[de:Handbuch:Erweiterung/{{SUBPAGENAME}}]] [[en:Manual:Extension/{{SUBPAGENAME}}]] __FORCETOC__ [[Category:Administration]]
| (19 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{DISPLAYTITLE:Extended statistics}} | |
| − | + | The extension '''ExtendedStatistics''' provides an analytic view of many relevant parameters on the wiki, providing wiki administrators better insight into the functioning of the wiki. | |
| − | == | + | ==Where to find Extended statistics== |
| − | '''ExtendedStatistics'' | + | The navigation link ''Extended statistics'' in the tab Global actions loads the page ''Special:ExtendedStatistics''. |
| − | + | <br /> | |
| − | + | [[File:ExtendedStatistics1.png|thumb|alt=Extended statistics navigation link|center|650x650px|Extended statistics navigation link]] | |
| + | ==Choosing a data source== | ||
| − | + | ExtendedStatistics can show data for multiple aspects of the wiki. Available data sources are: | |
| − | + | *''Number of users:'' All the users that registered in the period chosen | |
| + | *''Number of pages:'' All pages created in the period chosen. | ||
| + | *''Number of content pages:'' All articles in content namespaces created in the period chosen | ||
| + | *''Number of edits:'' All edits carried out in the period chosen | ||
| + | *''Edits per user:'' Number of edits per user in the period chosen | ||
| + | *''Search queries:'' All terms users searched for in the period chosen. Only availble if [[Manual:Extension/ExtendedSearch|BlueSpiceExtendedSearch]] is installed. | ||
| − | + | ==Choosing filters== | |
| − | + | General filters: | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | *From - Date from which to display data | |
| + | *To - Date to which to display data | ||
| − | + | Some data sources may have additional filters available, like for data sources based on wiki pages, namespace filter is available. | |
| − | + | <br /> | |
| − | + | [[File:Manual:Mediawiki Extension ExtendedStatistics.png|alt=Selecting a query type|center|thumb|300x300px|Selecting a query type]] | |
| − | + | <br /> | |
| − | + | ==Display settings== | |
| − | + | The display of the results is determined by the following settings: | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | *Interval - grain of the diagram - determines which time unit will be used to group the data. | |
| + | *Mode - display type: | ||
| + | **Absolute - shows changes in data for the given period | ||
| + | **Aggregate - shows running total for the data source choosen | ||
| + | **List - shows data in tabular view - only avaiable for search statistics | ||
| + | {{Box Note|boxtype=note|Note text=Depending on the selected time period, the interval has to be set accordingly. For, example if you look for data between 02.06. and 03.06. for the same year, the interval setting "Year" will not return any data. Change the interval to "Week" or "Day" to return results.}} | ||
| − | + | ==Viewing the results== | |
| − | |||
| − | |||
| − | + | Once all the filters and options are set, click on the ''Results'' tab to show the resulting data. | |
| − | + | <br /> | |
| + | [[File:ExtendedStatistics3.png|thumb|Result view with export buttons |alt=Results|center|650x650px]]<br /> | ||
| − | + | ==<span class="mw-headline" id="Chart_export">Chart export</span>== | |
| + | In results view there is an ''Export-''button that allows the user to export and download the currently displayed chart as SVG. | ||
| − | + | ==<span class="mw-headline" id="Data_export">Data export</span>== | |
| − | == | + | ===<span class="mw-headline" id="Location">Maintenance script</span>=== |
| + | A <code>php</code> maintenance script will be provided on the following location: | ||
| − | + | <code><mw-root>/extensions/BlueSpiceExtendedStatistics/maintenance/ExportCollection.php</code> | |
| − | + | ===<span class="mw-headline" id="Usage">Usage</span>=== | |
| − | + | This script must be called on the command line of the server. It takes the path of a configuration file in <code>JSON</code> format. | |
| − | |||
| − | == | + | '''Example''' |
| + | php <mw-root>/extensions/BlueSpiceExtendedStatistics/maintenance/ExportCollection.php \ | ||
| + | --config=<path-to-file>/myConfig.json \ | ||
| + | --exportto=/tmp/myExport.xslx | ||
| + | <span class="mw-headline" id="Params">'''Params'''</span> | ||
| − | * | + | *<code>--config</code> - path to config file |
| + | *<code>--exportto</code> - path to the file, the data gets exportet to. Note that vaiable file formats are <code>xsl</code>, <code>xslx</code> and <code>csv</code> | ||
| − | + | ===<span class="mw-headline" id="Configuration">Scirpt configuration</span>=== | |
| + | The script configuration will take the same parameters as the API, which is used on Special:ExtendedStatistics. | ||
| − | + | <span class="mw-headline" id="Params_2">'''Params'''</span> | |
| − | < | + | *<code>aggregate</code> |
| − | + | *<code>filter</code> | |
| − | |||
| − | |||
| − | |||
| − | </ | + | ===<span class="mw-headline" id="Examples">Example contents</span>=== |
| − | </ | + | The following examples show the content of the JSON file provided to <code>--config</code>. |
| + | |||
| + | <span class="mw-headline" id=".22Page_views.22_aggregated_by_date_since_1_year_until_now">'''"Page views" aggregated by date over 1 year'''</span> | ||
| + | <span class="p">{</span> | ||
| + | <span class="nt">"aggregate"</span><span class="p">:</span> <span class="p">[</span> | ||
| + | <span class="p">{</span> | ||
| + | <span class="nt">"property"</span><span class="p">:</span> <span class="s2">"timestampcreated"</span><span class="p">,</span> | ||
| + | <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"daily"</span><span class="p">,</span> | ||
| + | <span class="nt">"targets"</span><span class="p">:</span> <span class="p">[</span> | ||
| + | <span class="s2">"pagetitle"</span><span class="p">,</span> | ||
| + | <span class="s2">"numberhits"</span><span class="p">,</span> | ||
| + | <span class="s2">"numberhitsaggregated"</span> | ||
| + | <span class="p">]</span> | ||
| + | <span class="p">}</span> | ||
| + | <span class="p">],</span> | ||
| + | <span class="nt">"filter"</span><span class="p">:</span> <span class="p">[</span> | ||
| + | <span class="p">{</span> | ||
| + | <span class="nt">"property"</span><span class="p">:</span> <span class="s2">"type"</span><span class="p">,</span> | ||
| + | <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"string"</span><span class="p">,</span> | ||
| + | <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"hitcounter"</span><span class="p">,</span> | ||
| + | <span class="nt">"comparison"</span><span class="p">:</span> <span class="s2">"eq"</span> | ||
| + | <span class="p">},</span> | ||
| + | <span class="p">{</span> | ||
| + | <span class="nt">"property"</span><span class="p">:</span> <span class="s2">"timestampcreated"</span><span class="p">,</span> | ||
| + | <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"date"</span><span class="p">,</span> | ||
| + | <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"20200707120000"</span><span class="p">,</span> | ||
| + | <span class="nt">"comparison"</span><span class="p">:</span> <span class="s2">"gt"</span> | ||
| + | <span class="p">},</span> | ||
| + | <span class="p">{</span> | ||
| + | <span class="nt">"property"</span><span class="p">:</span> <span class="s2">"timestampcreated"</span><span class="p">,</span> | ||
| + | <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"date"</span><span class="p">,</span> | ||
| + | <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"20210707120000"</span><span class="p">,</span> | ||
| + | <span class="nt">"comparison"</span><span class="p">:</span> <span class="s2">"lt"</span> | ||
| + | <span class="p">}</span> | ||
| + | <span class="p">]</span> | ||
| + | <span class="p">}</span> | ||
| + | <span class="mw-headline" id=".22Review_by_namespaces.22_aggregated_by_namespace_since_1_year_until_now">'''"Review by namespaces" aggregated by namespace over 1 year'''</span>: | ||
| + | <span class="p">{</span> | ||
| + | <span class="nt">"aggregate"</span><span class="p">:</span> <span class="p">[</span> | ||
| + | <span class="p">{</span> | ||
| + | <span class="nt">"property"</span><span class="p">:</span> <span class="s2">"namespacename"</span><span class="p">,</span> | ||
| + | <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"string"</span><span class="p">,</span> | ||
| + | <span class="nt">"targets"</span><span class="p">:</span> <span class="p">[</span> | ||
| + | <span class="s2">"ongoingpages"</span><span class="p">,</span> | ||
| + | <span class="s2">"expiredpages"</span><span class="p">,</span> | ||
| + | <span class="s2">"notrunningpages"</span><span class="p">,</span> | ||
| + | <span class="s2">"ongoingpagesaggregated"</span><span class="p">,</span> | ||
| + | <span class="s2">"expiredpagesaggregated"</span><span class="p">,</span> | ||
| + | <span class="s2">"notrunningpagesaggregated"</span> | ||
| + | <span class="p">]</span> | ||
| + | <span class="p">}</span> | ||
| + | <span class="p">],</span> | ||
| + | <span class="nt">"filter"</span><span class="p">:</span> <span class="p">[</span> | ||
| + | <span class="p">{</span> | ||
| + | <span class="nt">"property"</span><span class="p">:</span> <span class="s2">"type"</span><span class="p">,</span> | ||
| + | <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"string"</span><span class="p">,</span> | ||
| + | <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"reviewedpages-ns"</span><span class="p">,</span> | ||
| + | <span class="nt">"comparison"</span><span class="p">:</span> <span class="s2">"eq"</span> | ||
| + | <span class="p">},</span> | ||
| + | <span class="p">{</span> | ||
| + | <span class="nt">"property"</span><span class="p">:</span> <span class="s2">"timestampcreated"</span><span class="p">,</span> | ||
| + | <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"date"</span><span class="p">,</span> | ||
| + | <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"20200707120000"</span><span class="p">,</span> | ||
| + | <span class="nt">"comparison"</span><span class="p">:</span> <span class="s2">"gt"</span> | ||
| + | <span class="p">},</span> | ||
| + | <span class="p">{</span> | ||
| + | <span class="nt">"property"</span><span class="p">:</span> <span class="s2">"timestampcreated"</span><span class="p">,</span> | ||
| + | <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"date"</span><span class="p">,</span> | ||
| + | <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"20210707120000"</span><span class="p">,</span> | ||
| + | <span class="nt">"comparison"</span><span class="p">:</span> <span class="s2">"lt"</span> | ||
| + | <span class="p">}</span> | ||
| + | <span class="p">]</span> | ||
| + | <span class="p">}</span> | ||
| + | <br /> | ||
| + | ==Configuration== | ||
| + | |||
| + | In the [[Manual:Extension/BlueSpiceConfigManager|Config manager]], you can change the following settings: | ||
| + | |||
| + | {{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceExtendedStatistics}} | ||
| + | |||
| + | {{Box Links-en|Topic1=[[Reference:BlueSpiceExtendedStatistics]]}} | ||
| + | |||
| + | [[de:Handbuch:Erweiterung/{{SUBPAGENAME}}]] | ||
| + | [[en:Manual:Extension/{{SUBPAGENAME}}]] | ||
| + | __FORCETOC__ | ||
| + | |||
| + | [[Category:Administration]] | ||