SUNScholar/Elastic Statistics/5.X - Revision history

Hgibson: /* Step 4 - Enable public viewing of statistics */

2016-09-25T15:41:49Z

Step 4 - Enable public viewing of statistics

Hgibson: /* Chart Styling */

2016-05-29T13:47:54Z

Chart Styling

Hgibson: /* Step 6 - Import old log data */

2015-06-03T11:32:33Z

Step 6 - Import old log data

Hgibson: /* Step 5 - Rebuild DSpace */

2015-06-03T11:32:24Z

Step 5 - Rebuild DSpace

Hgibson: /* Step 1 - Modify "xmlui.xconf" */

2015-06-03T11:29:59Z

Step 1 - Modify "xmlui.xconf"

Hgibson: /* References */

2015-06-03T11:25:54Z

References

Hgibson: /* Requirements */

2015-06-03T11:25:27Z

Requirements

Hgibson: Created page with " '''Back to Elastic Statistics''' ==Requirements== ===Java version=== {{Java7}} ===Source symlink=== Please see: http://wi..."

2015-06-03T11:22:27Z

Created page with "<center> '''Back to Elastic Statistics''' </center> ==Requirements== ===Java version=== {{Java7}} ===Source symlink=== Please see: http://wi..."

New page

<center>
'''[[SUNScholar/Elastic_Statistics|Back to Elastic Statistics]]'''
</center>
==Requirements==
===Java version===
{{Java7}}
===Source symlink===
Please see: http://wiki.lib.sun.ac.za/index.php/SUNScholar/Install_DSpace/S03

''Make sure you have correctly "symlinked" to the DSpace source code, see step 3.2 in the link above.''

==Installation==
===Step 1 - Modify "xmlui.xconf"===
Type the following as the "dspace" user:
nano $HOME/{{Source}}/dspace/config/xmlui.xconf
Enable "Elastic Statistics" and disable "SOLR Statistics".

Remove the enclosing markers to the left and right of the Elastic Search aspect and add markers around the Statistics aspect.

See an example below.
<pre>





<aspect name="Statistics - Elastic Search" path="resource://aspects/StatisticsElasticSearch/" />
</pre>

{{NANO}}

===Step 2 - Enable the Elastic Statistics event listener===
Type the following as the "dspace" user:
nano $HOME/{{Source}}/dspace-xmlui/src/main/webapp/WEB-INF/spring/applicationContext.xml
Enable the Elastic Statistics event listener (remove the enclosing markers). See example below:
<pre>

<bean class="org.dspace.statistics.ElasticSearchLoggerEventListener">
<property name="eventService">
<ref bean="dspace.eventService" />
</property>
</bean>
</pre>

{{NANO}}

===Step 3 - Open network ports===
Also see: http://wiki.lib.sun.ac.za/index.php/SUNScholar/Firewall

Type the following:
sudo ufw allow 9200

sudo ufw allow 9300

===Step 4 - Enable public viewing of statistics===
====Custom modification====
Download the modified "sitemap.xmap" aspect file which allows for public viewing of statistics. (Thanks to [mailto:peter@longsight.com Peter Dietz] of [http://www.longsight.com Longsight])

Type the following:
cd $HOME/{{Source}}/dspace-xmlui/src/main/resources/aspects/StatisticsElasticSearch

rm sitemap.xmap

wget --no-check-certificate https://gist.githubusercontent.com/peterdietz/0bac2c720d8373477897/raw/44c8aaf9703c216f72fae82c6aa3ea1da67809fa/sitemap.xmap

====Official setup====
*Create the group "statistics_viewer" in DSpace and add other groups or e-persons to the group.
*These added members will be allowed to view the "Elastic Statistics" after they have logged into DSpace.

===Step 5 - [[SUNScholar/Rebuild_DSpace|Rebuild DSpace]]===
Click on the heading above.
===Step 6 - [[SUNScholar/Elastic Statistics/Import Logs|Import old log data]]===
Click on the heading above.

==Customisation==
At present the elastic statistics are not very configurable. See below:
*https://github.com/DSpace/DSpace/blob/master/dspace/config/modules/elastic-search-statistics.cfg

===Default Country View===
By default the US map is displayed for top cities downloads, however not all institutions would like to display downloads from the US only.

At Stellenbosch University in South Africa we would like to see city downloads for South Africa.

At present this parameter is hard coded, If you want to change it then modify the source code starting at the following locations:
*https://github.com/DSpace/DSpace/blob/master/dspace-xmlui/src/main/java/org/dspace/app/xmlui/aspect/statisticsElasticSearch/ElasticSearchStatsViewer.java#L79
*https://github.com/DSpace/DSpace/blob/master/dspace-xmlui/src/main/webapp/static/js/statisticsElasticSearch/visualizeData.js#L321
===Chart Styling===
Modify the CSS at the following location:
*https://github.com/DSpace/DSpace/blob/master/dspace-xmlui/src/main/webapp/static/css/statisticsElasticSearch/style.css

==References==
*http://www.elasticsearch.org
*https://wiki.duraspace.org/display/DSDOC5x/Elastic+Search+Usage+Statistics
*https://wiki.duraspace.org/display/DSDOC4x/Elastic+Search+Usage+Statistics
*https://wiki.duraspace.org/display/DSDOC3x/Elastic+Search+Usage+Statistics
*http://or2013.net/sessions/usage-statistics-powered-elastic-search
*https://jira.duraspace.org/browse/DS-1400
*https://jira.duraspace.org/browse/DS-1241
*https://gist.github.com/peterdietz/0bac2c720d8373477897
*http://sharadchhetri.com/2015/03/22/install-and-configure-elasticsearch-cluster-on-ubuntu-14-04-lts/

← Older revision		Revision as of 13:47, 29 May 2016
Line 89:		Line 89:
	Modify the CSS at the following location:		Modify the CSS at the following location:
	*https://github.com/DSpace/DSpace/blob/master/dspace-xmlui/src/main/webapp/static/css/statisticsElasticSearch/style.css		*https://github.com/DSpace/DSpace/blob/master/dspace-xmlui/src/main/webapp/static/css/statisticsElasticSearch/style.css
		+	[[Category:Customisation]]

← Older revision		Revision as of 11:32, 3 June 2015
Line 73:		Line 73:

	===Step 6 - [[SUNScholar/Elastic Statistics/Import Logs\|Import old log data]]===		===Step 6 - [[SUNScholar/Elastic Statistics/Import Logs\|Import old log data]]===
−	~~Click on the heading above.~~

	==Customisation==		==Customisation==

← Older revision		Revision as of 11:25, 3 June 2015
Line 90:		Line 90:
	Modify the CSS at the following location:		Modify the CSS at the following location:
	*https://github.com/DSpace/DSpace/blob/master/dspace-xmlui/src/main/webapp/static/css/statisticsElasticSearch/style.css		*https://github.com/DSpace/DSpace/blob/master/dspace-xmlui/src/main/webapp/static/css/statisticsElasticSearch/style.css
−
−	~~==References==~~
−	*http://www.elasticsearch.org
−	*https://wiki.duraspace.org/display/DSDOC5x/Elastic+Search+Usage+Statistics
−	*https://wiki.duraspace.org/display/DSDOC4x/Elastic+Search+Usage+Statistics
−	*https://wiki.duraspace.org/display/DSDOC3x/Elastic+Search+Usage+Statistics
−	*http://or2013.net/sessions/usage-statistics-powered-elastic-search
−	*https://jira.duraspace.org/browse/DS-1400
−	*https://jira.duraspace.org/browse/DS-1241
−	*https://gist.github.com/peterdietz/0bac2c720d8373477897
−	*http://sharadchhetri.com/2015/03/22/install-and-configure-elasticsearch-cluster-on-ubuntu-14-04-lts/

@@ Line 62: / Line 62: @@
   cd $HOME/{{Source}}/dspace-xmlui/src/main/resources/aspects/StatisticsElasticSearch
-  rm sitemap.xmap
+  mv sitemap.xmap sitemap.xmap-orig
   wget --no-check-certificate https://gist.githubusercontent.com/peterdietz/0bac2c720d8373477897/raw/44c8aaf9703c216f72fae82c6aa3ea1da67809fa/sitemap.xmap

@@ Line 71: / Line 71: @@
 ===Step 5 - [[SUNScholar/Rebuild_DSpace|Rebuild DSpace]]===
-Click on the heading above.
 ===Step 6 - [[SUNScholar/Elastic Statistics/Import Logs|Import old log data]]===
 Click on the heading above.

@@ Line 10: / Line 10: @@
 Type the following as the "dspace" user:
    nano $HOME/{{Source}}/dspace/config/xmlui.xconf
-Enable "Elastic Statistics" and disable "SOLR Statistics".
+<font color="red">'''Enable "Elastic Statistics" and disable "SOLR Statistics".'''</font>
 Remove the enclosing markers to the left and right of the Elastic Search aspect and add markers around the Statistics aspect.

@@ Line 5: / Line 5: @@
 ===Java version===
 {{Java7}}
 ==Installation==