Difference between revisions of "Stats Design"

From Dreamwidth Notes
Jump to: navigation, search
m (Fix typos)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This is a a loosely organized collection of notes and links for the Stats feature design. (Note: this is for the new stats system only - there's an existing legacy system too.)
+
{{Update}}
  
[http://bugs.dwscoalition.org/show_bug.cgi?id=124 Bug 124]
+
This is a a loosely organized collection of notes and links for the Stats feature design. (Note: this is for the new stats system only - there's an existing legacy system too.)
  
[[Project_Teams#Site_statistics|Stats project team]] (we're recruiting)
+
[[Project_Teams#Site_statistics|Stats project team]]
  
 
== Table definitions ==
 
== Table definitions ==
Line 27: Line 27:
 
)</source>
 
)</source>
  
== Storing statistics ==
+
== Storing and retrieving statistics ==
  
[http://hg.dwscoalition.org/dw-free/file/tip/cgi-bin/DW/StatStore.pm DW::StatStore]
+
[https://github.com/dreamwidth/dw-free/blob/develop/cgi-bin/DW/StatStore.pm DW::StatStore]
  
 
== Statistics items ==
 
== Statistics items ==
  
* [http://hg.dwscoalition.org/dw-free/file/tip/cgi-bin/DW/StatData.pm DW::StatData]
+
* [https://github.com/dreamwidth/dw-free/blob/develop/cgi-bin/DW/StatData.pm DW::StatData]
* [http://hg.dwscoalition.org/dw-free/file/tip/cgi-bin/DW/StatData/ DW::StatData::*]
+
* [https://github.com/dreamwidth/dw-free/blob/develop/cgi-bin/DW/StatData/ DW::StatData::*]
  
 
== Collecting statistics ==
 
== Collecting statistics ==
  
# [http://hg.dwscoalition.org/dw-free/file/tip/etc/stats-collection.conf etc/stats-collection.conf] should contain something like:<source lang="text">## collect and store all stats under the accounts category
+
This works by massaging, aggregating, and or compiling (as appropriate) data from various places and storing the results using DW::StatStore.
 +
 
 +
1. [https://github.com/dreamwidth/dw-free/blob/develop/etc/stats-collection.conf etc/stats-collection.conf] should contain something like:
 +
<source lang="text">## collect and store all stats under the accounts category
 
## hangs if you don't enclose the asterisk in quotes
 
## hangs if you don't enclose the asterisk in quotes
 
# accounts: "*"
 
# accounts: "*"
Line 45: Line 48:
 
accounts: "*"
 
accounts: "*"
 
active: "*"
 
active: "*"
paid: "*"</source>
+
paid: "*"
# [http://hg.dwscoalition.org/dw-free/file/tip/bin/worker/stats-collection bin/worker/stats-collection] is the utility that handles stats collection. Run at least once per 24 hours, either from your crontab or by listing it in [http://hg.dwscoalition.org/dw-free/file/tip/etc/workers.conf etc/workers.conf].
+
</source>
# (only needed if you chose to use [http://hg.dwscoalition.org/dw-free/file/tip/etc/workers.conf etc/workers.conf]): add a line to the "all" section reading:<source lang="text">  stats-collection: 1</source>(note: this is for development only, as it assumes you only have one server - in production environments, you will usually list it in the section for a specific server)
+
 
 +
2. [https://github.com/dreamwidth/dw-free/blob/develop/bin/worker/stats-collection bin/worker/stats-collection] is the utility that handles stats collection. Run at least once per 24 hours, either from your crontab or by listing it in [https://github.com/dreamwidth/dw-free/blob/develop/etc/workers.conf etc/workers.conf].
 +
 
 +
3. (only needed if you chose to use [https://github.com/dreamwidth/dw-free/blob/develop/etc/workers.conf etc/workers.conf]): add a line to the "all" section reading:
 +
<source lang="text">  stats-collection: 1
 +
</source>(note: this is for development only, as it assumes you only have one server - in production environments, you will usually list it in the section for a specific server)
  
 
== Displaying statistics ==
 
== Displaying statistics ==
  
* [http://hg.dwscoalition.org/dw-free/file/tip/htdocs/stats/ htdocs/stats/*] (public stats)
+
* [https://github.com/dreamwidth/dw-free/blob/develop/views/stats/site.tt views/stats/site.tt] (public stats)
* [http://hg.dwscoalition.org/dw-free/file/tip/htdocs/admin/stats.bml htdocs/admin/stats.bml] (restricted stats)
+
* [https://github.com/dreamwidth/dw-free/blob/develop/views/admin/stats.tt views/admin/stats.tt] (restricted stats)
 +
* [https://github.com/dreamwidth/dw-free/blob/develop/cgi-bin/DW/Controller/SiteStats.pm DW::Controller::SiteStats.pm] (the stats page controller for both public and restricted stats)
 +
* [https://github.com/dreamwidth/dw-free/blob/develop/cgi-bin/DW/Controller/Graphs.pm DW::Controller::Graphs.pm] (the stats graphs controller for both public and restricted stats)
  
(note: as of March 28 there is an [http://bugs.dwscoalition.org/attachment.cgi?id=3299 uncommitted patch] on bug 124 [[Routing_and_Template_Toolkit|TTizing] the stats display to DW::Controller::SiteStats, views/admin/stats.tt, view/site/stats.tt)
+
[[Category: Development]]

Latest revision as of 10:08, 4 August 2014

Needs Update: This page has been found in need of an update. Information may be wrong or outdated!

This is a a loosely organized collection of notes and links for the Stats feature design. (Note: this is for the new stats system only - there's an existing legacy system too.)

Stats project team

Table definitions

CREATE TABLE statkeylist (
    statkeyid INT UNSIGNED NOT NULL AUTO_INCREMENT, 
    name VARCHAR(255) DEFAULT NULL, 
 
    PRIMARY KEY (statkeyid), 
    UNIQUE KEY (name) 
)
 
CREATE TABLE site_stats ( 
    category_id INT UNSIGNED NOT NULL, 
    key_id INT UNSIGNED NOT NULL, 
    insert_time INT UNSIGNED NOT NULL, 
    VALUE INT UNSIGNED NOT NULL, 
 
    -- FIXME: This is good for retrieving data for a single category+key, but 
    -- maybe not as good if we want all keys for the category, with a limit on 
    -- time (ie, last 5 entries, or last 2 weeks). Do we need an extra index? 
    INDEX (category_id, key_id, insert_time) 
)

Storing and retrieving statistics

DW::StatStore

Statistics items

Collecting statistics

This works by massaging, aggregating, and or compiling (as appropriate) data from various places and storing the results using DW::StatStore.

1. etc/stats-collection.conf should contain something like:

## collect and store all stats under the accounts category
## hangs if you don't enclose the asterisk in quotes
# accounts: "*"
## collect and store only these stats under the accounts category
# accounts: [ identity, personal, redirect ]
accounts: "*"
active: "*"
paid: "*"

2. bin/worker/stats-collection is the utility that handles stats collection. Run at least once per 24 hours, either from your crontab or by listing it in etc/workers.conf.

3. (only needed if you chose to use etc/workers.conf): add a line to the "all" section reading:

  stats-collection: 1
(note: this is for development only, as it assumes you only have one server - in production environments, you will usually list it in the section for a specific server)

Displaying statistics