hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-17 23:13:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

[2025998] Usage event (statistics) plugin hook

Browse Source 
git-svn-id: http://scm.dspace.org/svn/repo/branches/dspace-1_5_x@3402 9c30dcfa-912a-0410-8fc2-9e0234be79fd
This commit is contained in:
Mark Wood
2009-01-29 15:26:05 +00:00
parent b14f5aa54a
commit 722fff1518
20 changed files with 916 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
dspace/docs/docbook/configure.xml
View File

@@ -2494,7 +2494,40 @@ ant index
[dspace]/bin/dsrun org.dspace.browse.IndexBrowse -i
</screen>
</section>
<section remap="h3">
<title>
<anchor id="docbook-configure.html-usage-instrumentation" xreflabel="Configuring Usage Instrumentation Plugins"></anchor>Configuring Usage Instrumentation Plugins</title>
<para>A usage instrumentation plugin is configured as a
<link linkend="docbook-business.html-plugin">singleton plugin</link>
for the abstract class <code>org.dspace.app.statistics.AbstractUsageEvent</code>.
</para>
<section remap="h4">
<title>
<anchor id="docbook-configure.html-usage-insturmentation-passive" xreflabel="The Passive Plugin"></anchor>
The Passive Plugin
</title>
<para>
The Passive plugin is provided as the class <code>org.dspace.app.statistics.PassiveUsageEvent</code>. It absorbs events without effect. Use the Passive plugin when you have no use for usage event postings. This is the default if no plugin is configured.
</para>
</section>
<section remap="h4">
<title>
<anchor id="docbook-configure.html-usage-instrumentation-tsv" xreflabel="The TSV File Logger Plugin"></anchor>
The Tab File Logger Plugin
</title>
<para>
The Tab File Logger plugin is provided as the class <code>org.dspace.app.statistics.UsageEventTabFileLogger</code>. It writes event records to a file in tab-separated column format. If left unconfigured, an error will be noted in the DSpace log and no file will be produced. To specify the file path, provide an absolute path as the value for <code>usageEvent.tabFileLogger.file</code> in <code>dspace.cfg</code>.
</para>
</section>
<section remap="h4">
<title>
<anchor id="docbook-configure.html-usage-instrumentation-xml" xreflabel="The XML Logger Plugin"></anchor>
The XML Logger Plugin
</title>
<para>
The XML Logger plugin is provided as the class <code>org.dspace.app.statistics.UsageEventXMLLogger</code>. It writes event records to a file in a simple XML-like format. If left unconfigured, an error will be noted in the DSpace log and no file will be produced. To specify the file path, provide an absolute path as the value for <code>usageEvent.xmlLogger.file</code> in <code>dspace.cfg</code>.
</para>
</section>
</section>
</section>
</chapter>

8
dspace/docs/docbook/functional.xml
View File

@@ -697,6 +697,12 @@ Export"/>Import and Export</title>
<title><anchor id="docbook-functional.html-checker" xreflabel="Checksum Checker"/>Checksum Checker</title>
<para>The purpose of the checker is to verify that the content in a DSpace repository has not become corrupted or been tampered with. The functionality can be invoked on an ad-hoc basis from the command line, or configured via cron or similar. Options exist to support large repositories that cannot be entirely checked in one run of the tool. The tool is extensible to new reporting and checking priority approaches.</para>
</section>
</chapter>
<section remap="h2">
<title>
<anchor id="docbook-functional.html-usage"
xreflabel="Usage Instrumentation"></anchor>Usage Instrumentation</title>
<para>DSpace can report usage events, such as bitstream downloads, to a pluggable event processor. This can be used for developing customized usage statistics, for example. Sample event processor plugins writes event records to a file as tab-separated values or XML.</para>
</section>
</chapter>

5
dspace/docs/docbook/index.xml
View File

@@ -134,6 +134,11 @@
<ulink url="functional.html#checker">Checksum Checker</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="functional.html#usage">Usage Instrumentation</ulink>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>