A python library for sending usage stats events from Dspace to Matomo & ELK
Project description
============================ Dspace usage stats collector
.. image:: https://img.shields.io/pypi/v/dspace-stats-collector.svg :target: https://pypi.python.org/pypi/dspace-stats-collector
.. image:: https://img.shields.io/travis/lareferencia/dspace-stats-collector.svg :target: https://travis-ci.org/lareferencia/dspace-stats-collector
.. image:: https://readthedocs.org/projects/dspace-stats-collector/badge/?version=latest :target: https://dspace-stats-collector.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
.. image:: https://img.shields.io/pypi/l/dspace-stats-collector.svg :target: https://pypi.python.org/pypi/dspace-stats-collector :alt: License
A python agent for sending DSpace usage statistics events to Matomo and ELK Stack.
- Free software: GNU General Public License v3
- Documentation: https://dspace-stats-collector.readthedocs.io.
Standalone user level installing (w/ python bundle)
This is the recommended installation method, the instalation script :
- Downloads and install Miniconda (x86 or x64) a free minimal installer for conda/python (https://docs.conda.io/en/latest/miniconda.html) in CURRENT_USER_HOME/dspace-stats-collector directory.
- Installs dspace-stats-collector requeriments and packages in the miniconda python enviroment
- Creates a default configuration file in CURRENT_USER_HOME/dspace-stats-collector/config
- Downloads lastest COUNTER Robots file
- Installs dspace-stats-collector script in the user crontab
IMPORTANT: The instalation script and the dspace-stats-collector does not require superuser privileges and don´t install any software outside the CURRENT_USER_HOME/dspace-stats-collector. The collector script execute read only queries over dspace relational db and solr core. This tool doesn´t write or modify any dspace file, dspace db or solr core. It´s recommended, but not mandatory, execute the instalation script from de dspace user.
Installation steps:
- Check if wget and cron are installed in the system.
- Download installation script from: https://raw.githubusercontent.com/lareferencia/dspace-stats-collector/master/install-standalone.sh
- Execute installation script from a plain user (ie: dspace)
- Configure matomo site parameters provided in CURRENT_USER_HOME/dspace-stats-collector/config/default.properties
- Execute CURRENT_USER_HOME/dspace-stasts-collector/bin/dspace-stats-collector -v (will collect and send events for the first time)
- Check/ajust the user crontab (the instalation scripts adds an entry automatically)
Credits
This component is part of an alternative DSpace Usage Statistics collector strategy developed by LA Referencia / CONCYTEC (Perú) / IBICT (Brasil) / OpenAIRE as part of OpenAIRE Advance project - WP5 - Subtask 5.2.2. "Pilot common methods for usage statistics across Europe & Latin America"
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dspace_stats_collector-0.2.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87c14f838c894c0d5eb4643c3b739423b4fd9a57e3b5ebc90705993423daabd7 |
|
MD5 | 77868142a78e48165af7b503200b27f0 |
|
BLAKE2b-256 | 4ef3f6882b1ad06cf6c33efa3148d7c84e19b4520d25b76f14960def0be015ef |
Hashes for dspace_stats_collector-0.2.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e14ab21058957cddab6323c67016790f6da8a88eb787e65bc9f31bb1f14fc70c |
|
MD5 | 4f0746ec9b2a296b4c367f5503a2eff2 |
|
BLAKE2b-256 | 07194bea1ba5aa532c0938a566fc12c5cfc3449373104f539f9aa8220953334f |