Unsupported Release

This documentation relates to an old, unsupported version of DSpace, version 1.7.x. Looking for another version? See all documentation.

As of January 2014, the DSpace 1.7.x platform is no longer supported. We recommend upgrading to a more recent version of DSpace.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

DSpace Statistics

DSpace uses the Apache Solr application underlaying the statistics. There is no need to download any separate software. All the necessary software is included.

Usage Event Logging and Usage Statistics Gathering

The DSpace Statistics Implementation is a Client/Server architecture based on Solr for collecting usage events in the JSPUI and XMLUI user interface applications of DSpace.  Solr runs as a separate webapplication and an instance of Apache Http Client is utilized to allow parallel requests to log statistics events into this Solr instance.  The Usage Event framework has a couple EventListeners installed which assist in

Configuration settings for Statistics

In the dspace.cfg file review the following fields to make sure they are uncommented:

Property Name

Default Value

Type

Description

solr.log.server

${dspace.baseUrl}/solr/statistics

String

Is used by the SolrLogger Client class to connect tot the Solr server over http and perform updates and queries. Access to this

solr.spidersfile

${dspace.dir}/config/spiders.txt

String

Spiders file is utilized by the SolrLogger, this will be populated by running the following command:

dsrun org.dspace.statistics.util.SpiderDetector -i <httpd log file>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7ee632e9-bb68-4591-bf56-501dde3c2ce4"><ac:plain-text-body><![CDATA[

solr.dbfile

${dspace.dir}/config/GeoLiteCity.dat

String

The following referes to the GeoLiteCity database file utilized by the LocationUtils to calculate the location of client requests based on IP address. During the Ant build process (both fresh_install and update) this file will be downloaded from [http://www.maxmind.com/app/geolitecity] if a new version has been published or it is absent from your [dspace]/config directory.

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9fe66030-11e6-4a68-a1d5-c421a729f7ec"><ac:plain-text-body><![CDATA[

useProxies

true

boolean

Will cause Statistics loging to look for X-Forward URI to detect clients IP that have accessed it through a Proxy service.  Allows detection of client IP when accessing DSpace. [Note: This setting is found in the DSpace Logging sesction of dspace.cfg]

]]></ac:plain-text-body></ac:structured-macro>

statistics.item.authorization.admin

true

boolean

Enables access control restriction on DSpace  Statistics pages, Restrictions are based on access rights to Community, Collection and Item Pages. This will require the user to sign on to see that statistics. Setting the statistics to "false" will make them publicly available.

Upgrade Process for Statistics.

Example of rebuild and redeploy DSpace (only if you have configured your distribution in this manner)

First approach the traditional DSpace build process for updating

 cd [dspace-source]/dspace
 mvn package
 cd [dspace-source]/dspace/target/dspace-<version>-build.dir
 ant -Dconfig=[dspace]/config/dspace.cfg update
 cp -R [dspace]/webapps/* [TOMCAT]/webapps

The last step is only used if you are not mounting [~mdiggory:dspace]/webapps directly into your Tomcat, Resin or Jetty host (the recommended practice)If you only need to build the statistics, and don't make any changes to other web applications, you can replace the copy step above with:

 cp -R dspace/webapps/solr TOMCAT/webapps

Again, only if you are not mounting [~mdiggory:dspace]/webapps directly into your Tomcat, Resin or Jetty host (the recommended practice)

Restart your webapps (Tomcat/Jetty/Resin)

Older setting that are no currently utilized in the reports

Are the following Dspace.cfg fields still used by the new 1.6 Statistics? If not, we need to either document this well or remove them altogether:

 ###### Statistical Report Configuration Settings ######

 # should the stats be publicly available?  should be set to false if you only
 # want administrators to access the stats, or you do not intend to generate
 # any
 report.public = false

 # directory where live reports are stored
 report.dir = ${dspace.dir}/reports/

These fields are not used by the new 1.6 Statistics, but are only related to the Statistics from previous DSpace releases

  • No labels

All content on the LYRASIS Wiki is licensed under the CC BY (Attribution) license, unless otherwise noted.