Page History
...
In addition to the already existing logging of pageviews and downloads, DSpace also logs search queries users enter in the DSpace search dialog and workflow events.
Warning | ||
---|---|---|
| ||
In DSpace 7.x & 8.0x, only usage statistics (pageview, downloads) are logged. Search statistics and workflow reports (which were available in v66.x and below) are not yet supported, but are both scheduled to be restored in a later 7.x release (currently 7.1 for workflow reports, and 7.2 for search statistics), see DSpace Release 7.0 Status. See their related tickets: https://github.com/DSpace/DSpace/issues/2880 and https://github.com/DSpace/DSpace/issues/2851 |
Warning | ||
---|---|---|
| ||
Only workflow events, initiated and executed by a physical user are being logged. Automated workflow steps or ingest procedures are currently not being logged by the workflow events logger. |
...
Code Block | ||
---|---|---|
| ||
<field name="workflowStep" type="string" indexed="true" stored="true" required="false" multiValued="true"/> <field name="previousWorkflowStep" type="string" indexed="true" stored="true" required="false" multiValued="true"/> <field name="owner" type="string" indexed="true" stored="true" required="false" multiValued="true"/> <field name="submitter" type="integer" indexed="true" stored="true" required="false" /> <field name="actor" type="integer" indexed="true" stored="true" required="false" /> <field name="workflowItemId" type="integer" indexed="true" stored="true" required="false" /> |
Web User Interface Elements
Pageview and Download statistics
Disabling Tracking of Statistics
By default, Statistics are captured by the REST API for all visits (page hits) and downloads that occur via both the User Interface and the REST API.
Disabling statistical tracking currently must be done by modifying the backend's Spring configuration in [dspace]/config/spring/rest/event-service-listeners.xml. In that file, you must comment out the "SolrLoggerUsageEventListener" in order to disable all tracking
Code Block | ||||
---|---|---|---|---|
| ||||
<beans>
...
<!-- Comment out this bean, as shown below, to disable all tracking of usage statistics in Solr -->
<!-- Inject the SolrLoggerUsageEventListener into the EventService -->
<!--
<bean class="org.dspace.statistics.SolrLoggerUsageEventListener">
<property name="eventService" ref="org.dspace.services.EventService"/>
</bean>
-->
</beans> |
After commenting out that bean, you will need to restart Tomcat.
NOTE: This only disables tracking statistics in Solr. The "Statistics" link will still appear in the header menu of the User Interface. However, you can limit its visibility by setting it to only be visible to administrative users. Update this configuration in your local.cfg or user-statistics.cfg:
Code Block |
---|
# Limit access to Admins, Community/Collection Admins
usage-statistics.authorization.admin.usage = true |
Note | ||
---|---|---|
| ||
At this time, there is no flag to remove the "Statistics" menu link completely. See https://github.com/DSpace/DSpace/issues/9698 |
Web User Interface Elements
Pageview and Download statistics
In the UI, pageview and download statistics can be accessed from the "Statistics" navigation menu near the header. That statistics page is "context aware", so it will show the usage statistics for whatever page (site, Community, Collection) In the UI, pageview and download statistics can be accessed from the "Statistics" navigation menu near the header. That statistics page is "context aware", so it will show the usage statistics for whatever page (site, Community, Collection) you are currently on.
If you are not seeing the menu, it's likely that they are only enabled for administrators in your installation. Change the configuration parameter "authorization.admin.usage" in usage-statistics.cfg to false in order to make statistics visible for all repository visitors.
...
Search Query Statistics
Warning | ||
---|---|---|
| ||
Search query statistics are not only supported in 7.0, but are scheduled to be released in a later 7.x release (currently 7.2), see DSpace Release 7.0 Status.DSpace 6.x and below at this time. The below screenshots and instructions are for 6.x and will need updating for 7.x once this feature is completed.if this feature is ported to later versions of DSpace. See https://github.com/DSpace/DSpace/issues/2880 |
In the UI, search query statistics can be accessed from the lower end of the navigation menu.
...
Workflow Event Statistics
Warning | |||
---|---|---|---|
| |||
Workflow Event statistics are only supported in DSpace 6.x and below at this time. Workflow event statistics are not supported in 7.0, but are scheduled to be released in a later 7.x release (currently 7.1), see DSpace Release 7.0 Status. The below screenshots and instructions are for 6.x and will need updating for 7.x once this feature is completed.if this feature is ported to later versions of DSpace. See https://github.com/DSpace/DSpace/issues/2851 |
In the UI, search query statistics can be accessed from the lower end of the navigation menu.
...
Property: | solr-statistics.server | ||
Example Values: | solr-statistics.server = http://127.0.0.1/solr/statistics | ||
Informational Note: | Is used by the SolrLogger Client class to connect to the Solr server over http and perform updates and queries. In most cases, this can (and should) be set to localhost (or 127.0.0.1).
Assuming you get an HTTP 200 OK response, then you should set | ||
Property: | solr-statistics.query.filter.bundles | ||
Example | solr-statistics.query.filter.bundles=ORIGINAL | ||
Informational | A comma seperated list that contains the bundles for which the file statistics will be | displayed.||
Property: | solr-statistics.query.filter.spiderIp | ||
Example Value: | solr-statistics.query.filter.spiderIp = false | ||
Informational Note: | If true, statistics queries will filter out spider IPs -- use with caution, as this often results in extremely long query stringsdisplayed. | ||
Property: | solr-statistics.query.filter.isBot | ||
Example Value: | solr-statistics.query.filter.isBot = true | ||
Informational Note: | If true, statistics queries will filter out events flagged with the "isBot" field. This is the recommended method of filtering spiders from statistics. | ||
Property: | solr-statistics.autoCommit | ||
Example Value: | solr-statistics.autoCommit = true | ||
Informational Note: | If true (default), then all view statistics will be committed to Solr whenever the next autoCommit is triggered. This is recommended behavior. If false, then view statistics will be committed to Solr immediately (i.e. via an explicit commit call). This setting is untested in Production scenarios, and is primarily used by automated integration tests (to verify that the statistics engine is working properly). | ||
Property: | solr-statistics.spiderips.urls | ||
Example Value: | solr-statistics.spiderips.urls =
| ||
Informational Note: | List of URLs to download spiders files into [dspace]/config/spiders. These files contain lists of known spider IPs and are utilized by the SolrLogger to flag usage events with an "isBot" field, or ignore them entirely.
from your [dspace]/bin directory |
...
Pre-1.6 Statistics settings
Warning | |||
---|---|---|---|
| |||
Search query statistics are only supported in DSpace 6.x and below at this time. See https://github.com/DSpace/DSpace/issues/2852Log-based statistics not supported in 7.0. They are under discussion as this feature is not widely used. Tentatively they are scheduled for a possible release/replacement in 7.1, see DSpace Release 7.0 Status. |
Older versions of DSpace featured static reports generated from the log files. They still persist in DSpace today but are completely independent from the SOLR based statistics.
The following configuration parameters applicable to these reports can be found in dspace.cfg.
...