Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Extended what is being logged

...

What is exactly being logged ?

Each time a page or file gets requested, this request is being logged. The logging happens at the server side, and doesn't require a javascript like Google Analytics does, to provide usage data.

Definition of which fields are to be stored happens in the file dspace/solr/statistics/conf/schema.xml.
The fields, stored in a usage event by default are:

DSpace 1.6 and newer

After the introduction of the SOLR Statistics logging in DSpace 1.6, every pageview and file download is logged in a dedicated SOLR statistics core.

DSpace 3.0 and newer

In addition to the already existing logging of pageviews and downloads, DSpace 3.0 now also logs search queries users enter in the DSpace search dialog and workflow events.

The logging happens at the server side, and doesn't require a javascript like Google Analytics does, to provide usage data. Definition of which fields are to be stored happens in the file dspace/solr/statistics/conf/schema.xml.

Although they are stored in the same index, the stored fields for views, search queries and workflow events are different. A new field, statistics_type determines which kind of a usage event you are dealing with.

Code Block
languagehtml/xml
<field name="statistics_type" type="string" indexed="true" stored="true" required="true" />

Stored fields for pageviews and file downloads

Code Block
languagehtml/xml
<field name="type" type="integer" indexed="true" stored="true" required="true" />
<field name="id" type="integer" indexed="true" stored="true" required="true" />
<field name="ip" type="string" indexed="true" stored="true" required="false" />
<field name="time" type="date" indexed="true" stored="true" required="true" />
<field name="epersonid" type="integer" indexed="true" stored="true" required="false" />
<field name="continent" type="string" indexed="true" stored="true" required="false"/>
<field name="country" type="string" indexed="true" stored="true" required="false"/>
<field name="countryCode" type="string" indexed="true" stored="true" required="false"/>
<field name="city" type="string" indexed="true" stored="true" required="false"/>
<field name="longitude" type="float" indexed="true" stored="true" required="false"/>
<field name="latitude" type="float" indexed="true" stored="true" required="false"/>
<field name="owningComm" type="integer" indexed="true" stored="true" required="false" multiValued="true"/>
<field name="owningColl" type="integer" indexed="true" stored="true" required="false" multiValued="true"/>
<field name="owningItem
Code Block
<field name="type" type="integer" indexed="true" stored="true" required="false" multiValued="true" />
<field name="iddns" type="integerstring" indexed="true" stored="true" required="truefalse" />
<field name="ipuserAgent" type="string" indexed="true" stored="true" required="false" />
<field name="timeisBot" type="dateboolean" indexed="true" stored="true" required="truefalse" />
<field name="epersonidbundleName" type="integerstring" indexed="true" stored="true" required="false" multiValued="true" />

The combination of type and id determine which resource (either community, collection, item page or file download) has been requested.

Stored fields for search queries

Code Block
languagehtml/xml
="false" />
<field name="continentquery" type="string" indexed="true" stored="true" required="false" multiValued="true"/>
<field name="countryscopeType" type="stringinteger" indexed="true" stored="true" required="false" />
<field name="countryCodescopeId" type="stringinteger" indexed="true" stored="true" required="false" />
<field name="cityrpp" type="stringinteger" indexed="true" stored="true" required="false" />
<field name="longitudesortBy" type="floatstring" indexed="true" stored="true" required="false" />
<field name="latitudesortOrder" type="floatstring" indexed="true" stored="true" required="false" />
<field name="owningCommpage" type="integer" indexed="true" stored="true" required="false" multiValued="true"/>
/>

Stored fields for workflow events

Code Block
languagehtml/xml
<field name="owningCollworkflowStep" type="integerstring" indexed="true" stored="true" required="false" multiValued="true"/>
<field name="owningItempreviousWorkflowStep" type="integerstring" indexed="true" stored="true" required="false" multiValued="true"/>
<field name="dnsowner" type="string" indexed="true" stored="true" required="false" multiValued="true"/>
<field name="userAgentsubmitter" type="stringinteger" indexed="true" stored="true" required="false" />
<field name="isBotactor" type="booleaninteger" indexed="true" stored="true" required="false" />
<field name="bundleNameworkflowItemId" type="stringinteger" indexed="true" stored="true" required="false" multiValued="true" />

...

Web user interface for DSpace statistics

...