Warning
There is a known issue when using an sqlite database on an ext4 filesystem. You will want to remount the filesystem without barriers (-o barrier=0) in order to speed up the operations of the database. For more information, please see http://phoronix-test-suite.com/pipermail/trondheim-pts_phoronix-test-suite.com/2009-March/000095.html.
Be sure to include the specified fields included in the example bcfg2.conf file. These can be specified in either /etc/bcfg2.conf, if it is readable by the webserver user, or /etc/bcfg2-web.conf. Any database supported by Django can be used. If you are not using sqlite (the default choice), please see the Notes on Alternative Databases section below.
Warning
If you are using an sqlite database, the directory containing the database file will need to be writable by the web server. The reason for this is that sqlite will create another file for its journal when it tries to update the database file.
Note
Distributed environments can share a single remote database for reporting.
The recommended statistics plugin is DBStats. To use it, add it to the plugins line in your bcfg2.conf. Alternatively, the Statistics plugin can be used in conjunction with a crontab entry to run /usr/sbin/bcfg2-admin reports load_stats.
Detailed installation instructions can be found here.
Note
Reports no longer needs to be installed at the root URL for a given host. Therefore, reports no longer require their own virtual host.
In order to make this work, you will need to specify your web prefix by adding a web_prefix setting in the [statistics] section of your bcfg2.conf.
Warning
When running with SELINUX enabled, you can have potential problems with the WSGISocketPrefix. One solution that works without too much trouble is modifying your prefix so that it is located in a standard location:
WSGISocketPrefix /var/run/httpd/wsgi
An example site config is included below:
<IfModule mod_wsgi.c>
#
# If the root is changed update the static content alias as well
#
WSGIScriptAlias /bcfg2 "/usr/share/bcfg2/reports.wsgi"
WSGISocketPrefix run
WSGIDaemonProcess Bcfg2.Server.Reports processes=1 threads=10
WSGIProcessGroup Bcfg2.Server.Reports
#
# Manually set this to override the static content
#
#SetEnv bcfg2.media_url /bcfg2/site_media/
#
# This should have the same prefix as WSGIScriptAlias
#
Alias "/bcfg2/site_media/" "/usr/share/bcfg2/site_media/"
<Directory "/usr/share/bcfg2/site_media/">
Options None
AllowOverride None
order deny,allow
deny from all
allow from 127.0.0.1
</Directory>
</IfModule>
This configuration is suitable for use with the default installation from an RPM or deb package.
At this point you should be able to point your web browser to http://localhost/bcfg2 and see the new reports.
If you choose to use a different database, you’ll need to edit /etc/bcfg2.conf. These fields should be updated in the [statistics] section:
The new reporting system was implemented to address a number of deficiencies in the previous system. By storing statistics data in a relational database, we are now able to view and analyze more information about the state of the configuration, including information about previous configuration. Specific features in the new system include:
The bcfg2-admin tool provides management and maintenance capabilities for the reporting database. A few useful Django commands are provided as well.
bcfg2-reports allows you to retrieve data from the database about clients, and the states of their current interactions. It also allows you to change the expired/unexpired states.
The utility runs as a standalone application. It does, however, use the models from /src/lib/Server/Reports/reports/models.py.
A number of different options can be used to change what bcfg2-reports displays:
Usage: python bcfg2-reports [option] ...
Options and arguments (and corresponding environment variables):
-a : shows all hosts, including expired hosts
-b NAME : single-host mode - shows bad entries from the
current interaction of NAME
-c : shows only clean hosts
-d : shows only dirty hosts
-e NAME : single-host mode - shows extra entries from the
current interaction of NAME
-h : shows help and usage info about bcfg2-reports
-m NAME : single-host mode - shows modified entries from the
current interaction of NAME
-s NAME : single-host mode - shows bad, modified, and extra
entries from the current interaction of NAME
-t NAME : single-host mode - shows total number of managed and
good entries from the current interaction of NAME
-x NAME : toggles expired/unexpired state of NAME
--badentry=KIND,NAME : shows only hosts whose current interaction has bad
entries in of KIND kind and NAME name; if a single
argument ARG1 is given, then KIND,NAME pairs will be
read from a file of name ARG1
--modifiedentry=KIND,NAME : shows only hosts whose current interaction has
modified entries in of KIND kind and NAME name; if a
single argument ARG1 is given, then KIND,NAME pairs
will be read from a file of name ARG1
--extraentry=KIND,NAME : shows only hosts whose current interaction has extra
entries in of KIND kind and NAME name; if a single
argument ARG1 is given, then KIND,NAME pairs will be
read from a file of name ARG1
--fields=ARG1,ARG2,... : only displays the fields ARG1,ARG2,...
(name,time,state,total,good,bad)
--sort=ARG1,ARG2,... : sorts output on ARG1,ARG2,...
(name,time,state,total,good,bad)
--stale : shows hosts which haven't run in the last 24 hours
