All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
...
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.
...
Property: | server | ||||
Example Value: | 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: | spiderips.urls | ||||
Example Value: | spiderips.urls =
| ||||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="e6ce1db58f1e1b58-8f082cad-4c3c418d-ae199657-b5fb78fb3d7d20123c055125"><ac:plain-text-body><![CDATA[ | 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.
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2b69ad93d1bef876-093b9ab0-4db84328-b2dbaf09-7723271683c8b4de709caa1a"><ac:plain-text-body><![CDATA[from your [dspace]/bin directory | ]]></ac:plain-text-body></ac:structured-macro> | ||
Property: | dbfile | ||||
Example Value: | dbfile = ${dspace.dir}/config/GeoLiteCity.dat | ||||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2a54fc2aca217600-f94f4458-4aaa403d-897aae60-6f441362db6a2082591535a4"><ac:plain-text-body><![CDATA[ | Informational Note: | 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> | ||
Property: | resolver.timeout | ||||
Example Value: | resolver.timeout = 200 | ||||
Informational Note: | Timeout in milliseconds for DNS resolution of origin hosts/IPs. Setting this value too high may result in solr exhausting your connection pool. | ||||
Property: | useProxies | ||||
Example Value: | useProxies = true | ||||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="3a1144c62af03686-0f2a0702-42dc4b96-a37e9ec0-7296c60b4a6c4a9b0390b4b2"><ac:plain-text-body><![CDATA[ | Informational Note: | Will cause Statistics logging to look for X-Forward URI to detect clients IP that have accessed it through a Proxy service (e.g. the Apache mod_proxy). Allows detection of client IP when accessing DSpace. [Note: This setting is found in the DSpace Logging section of dspace.cfg] | ]]></ac:plain-text-body></ac:structured-macro> | ||
Property: | statistics.item.authorization.admin | ||||
Example Value: | statistics.item.authorization.admin = true | ||||
Informational Note: | When set to true, only general administrators, collection and community administrators are able to access the statistics from the web user interface. As a result, the links to access statistics are hidden for non logged-in admin users. Setting this property to "false" will display the links to access statistics to anyone, making them publicly available. | ||||
Property: | solr.statistics.logBots | ||||
Example Value: | solr.statistics.logBots = true | ||||
Informational Note: | When this property is set to false, and IP is detected as a spider, the event is not logged. | ||||
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 strings. | ||||
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: | query.filter.bundles | ||||
Example | query.filter.bundles=ORIGINAL | ||||
Informational | A comma seperated list that contains the bundles for which the file statistics will be displayed. |
...
Example of rebuild and redeploy DSpace (only if you have configured your distribution in this manner)
...
Wiki Markup |
---|
The last step is only used if you aredo not mounting follow the recommended practice of configuring _\[dspace\]/webapps_ directly into as location for webapps in your servlet container (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: |
...