Page History
...
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 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: | 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 |
...
In the {dspace.dir}/config/modules/usage-statistics.cfg
file review the following fields. These fields can be edited in place, or overridden in your own local.cfg config file (see Configuration Reference).
Property: | usage-statistics.dbfile | ||
Example Value: | usage-statistics.dbfile = ${dspace.dir}/config/GeoLiteCity.dat | ||
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. | ||
Property: | usage-statistics.resolver.timeout | ||
Example Value: | usage-statistics.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 (Set in dspace.cfg) | ||
Example Value: | useProxies = true | ||
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] | ||
Property: | usage-statistics.authorization.admin.usage | ||
Example Value: | usage-statistics.authorization.admin.usage = true | ||
Informational Note: | When set to true, only general administrators, collection and community administrators are able to access the pageview and download 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: | usage-statistics.authorization.admin.search | ||
Example Value: | usage-statistics.authorization.admin.search = true | ||
Informational Note: | When set to true, only system, collection or community administrators are able to access statistics on search queries. | ||
Property: | usage-statistics.authorization.admin.workflow | ||
Example Value: | usage-statistics.authorization.admin.workflow = true | ||
Informational Note: | When set to true, only system, collection or community administrators are able to access statistics on workflow events. | ||
Property: | usage-statistics.logBots | ||
Example Value: | usage-statistics.logBots = true | ||
Informational Note: | When this property is set to false, and IP is detected as a spider, the event is not logged. |
...
The GeoLite Database file (at [dspace]/config/GeoLite2-City.mmdb
) is used by the Statistics engine to generate location/country based reports. It is not provided with DSpace; you will need to manually install it. (Note: If you are not using DSpace Statistics, this file is not needed.)This file can be installed automatically when you run ant fresh_install
. However, if the file cannot be downloaded & installed automatically, you may need to manually install See the provider's web site for more information about this file, and to get a free account for downloading it.
Alternatively, DSpace can be configured to use a GeoLite City database file that you already have and maintain by other means. You can edit [dspace]/config/local.cfg
(or [dspace]/config/modules/usage-statistics.cfg
), changing the path usage-statistics.dbfile
to point to a shared copy of the database.
As this This file is also sometimes frequently updated by MaxMind.com, so you may also wish to update it on occasionwill need to refresh it regularly. As this is written, the database is updated monthly.
You have three options to install/update this file:
Attempt to re-run the automatic installer from your DSpace Source Directory ([dspace-source]). This will attempt to automatically download the database file, unzip it and install it into the proper location:
Code Block ant update_geolite
- NOTE: If the location of the GeoLite Database file is known to have changed, you can also run this auto-installer by passing it the new URL of the GeoLite Database File:
ant -Dgeolite=[full-URL-of-geolite] update_geolite
- NOTE: If the location of the GeoLite Database file is known to have changed, you can also run this auto-installer by passing it the new URL of the GeoLite Database File:
- OR, you can manually install the file by performing these steps yourself:
- First, download the latest GeoLite Database file from http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz
- Next, unzip that file to create a file named GeoLiteCity.dat
- Finally, move or copy that file to your DSpace installation, so that it is located at
[dspace]/config/GeoLiteCity.dat
.
- OR, you can combine the two alternatives above, by first downloading the GeoLiteCity.dat.gz file to a location accessible to you, and then configure a .dspace.properties file in your home folder. For example, create a .dspace.properties file in the home folder of the user who is running ant to deploy dspace, and add the following line to it:
Code Block | ||||
---|---|---|---|---|
| ||||
geolite=file:///path/to/your/downloaded/GeoLiteCity.dat.gz |
...
, and to be allowed to obtain it you need to agree to keep your copy updated.
The file is obtained using MaxMind's geoipupdate
tool. Find it here. Many Linux distributions also re-package geoipupdate
, so you may prefer to get it using your package manager.