Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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. In most cases, this can (and should) be set to localhost.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="526fbe64-5fc2-4d6f-b395-fcd8e92b63fa"><ac:plain-text-body><![CDATA[

solr.spiderips.urls

[http://iplists.com/google.txt,\\

...

][http://iplists.com/inktomi.txt,\\

...

][http://iplists.com/lycos.txt,\\

...

][http://iplists.com/infoseek.txt,\\

...

][http://iplists.com/altavista.txt,\\

...

][http://iplists.com/excite.txt,\\

...

][http://iplists.com/misc.txt,

...


][http://iplists.com/non_engines.txt

...

]

String

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:plain-text-body></ac:structured-macro>
The "stats-util"

...

command

...

can

...

be

...

used

...

to

...

force

...

an

...

update

...

of

...

spider

...

files,

...

regenerate

...

"isBot"

...

fields

...

on

...

indexed

...

events,

...

and

...

delete

...

spiders

...

from

...

the

...

index.

...

For

...

usage,

...

run:

...




Code Block

dspace stats-util -h

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d3261a74-fcac-449b-8f5f-f060dd246485"><ac:plain-text-body><![CDATA[from your [dspace]/bin directory

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

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9837aa3d-f1cc-4cb1-9a9b-e99ab49d4085"><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="701ffdd0-c286-422f-9423-782721fff29e"><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

Code Block
 | true \\ | boolean \\ | Enables access control restriction on DSpace&nbsp; 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. |

h3.



h3. 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


{code}
 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
{code}

Wiki Markup
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:

{
Code Block
}
 cp -R dspace/webapps/solr TOMCAT/webapps
{code}

Wiki Markup
_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:

{
Code Block
}
 ###### 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/
{code}

These

...

fields

...

are

...

not

...

used

...

by

...

the

...

new

...

1.6

...

Statistics,

...

but

...

are

...

only

...

related

...

to

...

the

...

Statistics

...

from

...

previous

...

DSpace

...

releases