Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Update for [DS-1059]; tidy up slight awkawardness

...

With the release of DSpace 1.6, new statistics software component was added. DSpace's use of SOLR for statistics makes it possible to have a database of statistics. This in mind, there is the issue of the older log files and how a site can use them. The following command process is able to convert the existing log files and then import them for SOLR use. The user will need to perform this only once.

The Log Converter program command converts log files from dspace.log into an intermediate format that can be inserted into SOLR.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="434ea74cf1a252b3-f01cc900-49004ee1-8dcdb36a-2c73f6a95682c1df70a3ebda"><ac:plain-text-body><![CDATA[

Command used:

[dspace]/bin/dspace stats-log-converter

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

Java class:

org.dspace.statistics.util.ClassicDSpaceLogConverter

Arguments short and long forms):

Description

-i or -in

Input file. Read from standard input if omitted or "-".

-o or -out

Output file. Written to standard output if omitted or "-".

-m or -multiple

Adds a wildcard at the end of input and output, so it would mean dspace.log* would be converted. (For example, the following files would be included because of this argument: dspace.log, dspace.log.1, dspace.log.2, dspace.log.3, etc.)

-n or -newformat

If the log files have been created with DSpace 1.6

-v or -verbose

Display verbose output (helpful for debugging)

-h or -help

Help

The Log Importer command loads into SOLR the intermediate log files that have been created by the aforementioned script into SOLRLog Converter.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="47508baa464695d8-3010b600-45544110-91998fca-100e904cdf4b16e61c104184"><ac:plain-text-body><![CDATA[

Command used:

[dspace]/bin/dspace stats-log-importer

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

Java class:

org.dspace.statistics.util.StatisticsImporter

Arguments (short and long forms):

Description

-i or --

input file. Read from standard input if omitted or "-".

-m or --

Adds a wildcard at the end of the input, so it would mean dspace.log* would be imported

-s or --

To skip the reverse DNS lookups that work out where a user is from. (The DNS lookup finds the information about the host from its IP address, such as geographical location, etc. This can be slow, and wouldn't work on a server not connected to the internet.)

-v or --

Display verbose ouput (helpful for debugging)

-l or --

For developers: allows you to import a log file from another system, so because the handles won't exist, it looks up random items in your local system to add hits to instead.

-h or --

Help

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="4c05255598add6b9-b7748195-4cdd4c46-b96b840b-ec073dfae2e2ecde4f55c59a"><ac:plain-text-body><![CDATA[

Command used:

[dspace]/bin/dspace stats-util

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

Java class:

org.dspace.statistics.util.StatisticsClient

Arguments (short and long forms):

Description

-u or -update-spider-files

Update Spider IP Files from internet into /dspace/config/spiders. Downloads Spider files identified in dspace.cfg under property solr.spiderips.urls. See DSpace SOLR Statistics Configuration

-f or -delete-spiders-by-flag

Delete Spiders in Solr By isBot Flag. Will prune out all records that have isBot:true

-i or -delete-spiders-by-ip

Delete Spiders in Solr By IP Address. Will prune out all records that have IP's that match spider IPs.

-m or -mark-spiders

Update isBog Flag in Solr. Marks any records currently stored in statistics that have IP addresses matched in spiders files

-h or -help

Calls up this brief help table at command line.

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="fde2f61998f70073-fb442ec1-4a094ca8-9ab19343-45653fc7748634ac65a89225"><ac:plain-text-body><![CDATA[

Command used:

[dspace]/bin/dspace stats-util

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

Java class:

org.dspace.statistics.util.StatisticsClient

Arguments (short and long forms):

Description

-o or -optimize

Run maintenance on the SOLR index. Recommended to run daily, to prevent your servlet container from running out of memory

...