root/trunk/quickstats/README

Revision 34, 2.4 kB (checked in by robert, 5 years ago)

and make it plain readme file

Line 
1 NAME
2
3     quickstats - a set of scripts for gathering transaction information in
4     postgres
5
6 SYNOPSIS
7
8     A set of schema and functions for gathering transaction information
9     (insert/update/delete), which can be used to report on transaction rates over
10     time.
11
12 VERSION
13
14     This document refers to version 0.1 of quickstats, released December 9th, 2008
15
16 USAGE
17
18     To use quickstats , install quickstats_schema.sql in the database you want to
19     gather data on. You then need to schedule a cron job to gather the statistics.
20
21     */5 * * * * /opt/pgsql/bin/psql -U postgres -c "select quickstats.gather()" -d
22     DBNAME > /dev/null 2>&1
23
24 BUGS AND LIMITATIONS
25
26     The package is designed to work on single databases at a time, if you want to
27     report on multiple databases in a cluster, you will need to install this in
28     each individual database, and also set cron jobs independently for each
29     database.
30
31     This package is only verified to work on Postgres 8.3, although it probably
32     would work on earlier versions.
33
34     Please report any problems to robert@omniti.com.
35
36 TODO
37
38 LICENSE AND COPYRIGHT
39
40     Copyright (c) 2008 OmniTI, Inc.
41
42     Redistribution and use in source and binary forms, with or without
43     modification, are permitted provided that the following conditions are met:
44
45     1. Redistributions of source code must retain the above copyright notice,
46      this list of conditions and the following disclaimer.
47     2. Redistributions in binary form must reproduce the above copyright notice,
48      this list of conditions and the following disclaimer in the documentation
49      and/or other materials provided with the distribution.
50
51     THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
52     WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
53     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
54     EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
56     PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
57     BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
58     IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
59     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
60     POSSIBILITY OF SUCH DAMAGE.
61
Note: See TracBrowser for help on using the browser.