Collect and display content statistics for Plone sites
Project description
Introduction
ftw.contentstats is a Plone add-on for collecting and displaying content statistics.
Compatibility
Plone 4.3.x
Installation
Add the package to your buildout configuration:
[instance] eggs += ... ftw.contentstats
Usage
Visit the @@content-stats view on a Plone site (requires the cmf.ManagePortal permission by default).
Logging content stats over time
In order to log content stats to a file, you can use the provided bin/dump-content-stats script to have stats dumped to a logfile that contains on JSON entry per line, containing the raw stats for that time.
Usage:
bin/dump-content-stats -s <plone_site_id>
The script will cause the stats to be dumped by making a request to the @@dump-content-stats view. This view is accessible to Anonymous (zope.Public), but only when requested from localhost!
So in order for this script to work, you’ll have to invoke it on the same machine where your Zope instances run, and make sure the Plone site is up and running, and reachable from localhost.
The logfile location will be in the same directory as the Z2 log, and the log will be named contentstats-json.log.
Note: In order to figure out the appropriate log directory, ftw.contentstats needs to derive this information from the eventlog location. It’s therefore important to have an eventlog configured, otherwise ftw.contentstats will prevent instance startup.
Development
Fork this repo
Clone your fork
Shell: ln -s development.cfg buildout.cfg
Shell: python boostrap.py
Shell: bin/buildout
Run bin/test to test your changes.
Or start an instance by running bin/instance fg.
Links
Copyright
This package is copyright by 4teamwork.
ftw.contentstats is licensed under GNU General Public License, version 2.
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.