Changesets can be listed by changeset number.
The Git repository is here.
- Revision:
- 297
- Log:
Updated to AWStats 7.0.
- Author:
- rool
- Date:
- Fri Mar 18 13:33:29 +0000 2011
- Size:
- 7712 Bytes
- Properties:
- Property svn:executable is set to *
| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 2 | <html><head> |
| 3 | <meta name="description" content="AWStats Documentation - Contrib and resource page"> |
| 4 | <meta name="keywords" content="awstats, awstat, log, file, analyzer, contrib, plugins, resources, maxmind, geoipfree, geoip, cities, regions, countries, frontend"> |
| 5 | <meta name="robots" content="index,follow"> |
| 6 | <meta name="title" content="AWStats Documentation - Plugins Development - Graphs"><title>AWStats Documentation - Plugins Development - Graphs</title> |
| 7 | |
| 8 | <link rel="stylesheet" href="styles.css" type="text/css"> |
| 9 | <link href="scripts/prettify.css" type="text/css" rel="stylesheet"> |
| 10 | <script type="text/javascript" src="scripts/prettify.js"></script><!-- $Revision: 1.2 $ - $Author: eldy $ - $Date: 2010/06/22 21:35:24 $ --> |
| 11 | </head> |
| 12 | <body onload="prettyPrint()"> |
| 13 | <table style="font-family: arial,helvetica,verdana; font-style: normal; font-variant: normal; font-weight: normal; font-size: 10pt; line-height: normal; font-size-adjust: none; font-stretch: normal;" bgcolor="#ffffff" border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 14 | <!-- Large --> |
| 15 | <tbody> |
| 16 | <tr style="font-family: arial,helvetica,verdana; font-style: normal; font-variant: normal; font-weight: normal; font-size: 10pt; line-height: normal; font-size-adjust: none; font-stretch: normal;"> |
| 17 | <td align="center" bgcolor="#9999cc"><a href="/"><img src="images/awstats_logo1.png" border="0"></a></td> |
| 18 | <td align="center" bgcolor="#9999cc"> |
| 19 | <br> |
| 20 | <font style="font-family: arial,helvetica,sans-serif; font-style: normal; font-variant: normal; font-weight: normal; font-size: 16pt; line-height: normal; font-size-adjust: none; font-stretch: normal;" color="#eeeeff"><b>AWStats logfile analyzer 7.0 |
| 21 | Documentation</b></font><br> |
| 22 | <br> |
| 23 | </td> |
| 24 | <td align="center" bgcolor="#9999cc"> |
| 25 | |
| 26 | </td> |
| 27 | </tr> |
| 28 | </tbody> |
| 29 | </table> |
| 30 | <br> |
| 31 | <br> |
| 32 | <h1 style="font-family: arial,helvetica,sanserif; font-style: normal; font-variant: normal; font-weight: normal; font-size: 26px; line-height: normal; font-size-adjust: none; font-stretch: normal;">Plugin |
| 33 | Graphs</h1> |
| 34 | Charts, graphs and maps can be generated by your plugin and make |
| 35 | AWStats reports look nice. AWStats generates arrays of values, label |
| 36 | names and titles so that your plugin only has to handle the final data |
| 37 | and display it as you wish.<br> |
| 38 | <span style="font-weight: bold;">NOTE:</span> Only |
| 39 | one graphing plugin should be choose by a user at any given time, thus |
| 40 | your plugin should generate as many graphs as possible. If more than |
| 41 | one graphing plugin is enabled at any given time, multiple graphs will |
| 42 | appear in the output for each graph type.<br> |
| 43 | <br> |
| 44 | Below is a list of variables passed to the graphin hook and how you |
| 45 | should use them.<br> |
| 46 | <ul> |
| 47 | <li>Title</li> |
| 48 | <li>Type</li> |
| 49 | <li>Block Label</li> |
| 50 | <li>Val Label</li> |
| 51 | <li>Val Color</li> |
| 52 | <li>Val Max</li> |
| 53 | <li>Val Total</li> |
| 54 | <li>Val Average</li> |
| 55 | <li>Val Data</li> |
| 56 | </ul> |
| 57 | <br> |
| 58 | <font color="#665544" size="3"><b>Title</b></font><br> |
| 59 | <hr>This is simply the title of the graph as it should be |
| 60 | displayed to the end user. This could be "Hosts (Top 5)" or "Monthly |
| 61 | History" or anything else. Of course, you don't have to show the title |
| 62 | unless you want to.<br> |
| 63 | <br> |
| 64 | <font color="#665544" size="3"><b>Type</b></font><br> |
| 65 | <hr>The type is important as your graphing plugin should |
| 66 | determine what type of graph to output depending on the type AWStats is |
| 67 | requesting. For information on types and the data order, <a href="#Graph_Types_and_Data">check the Types and Data section</a>.<br> |
| 68 | <ul> |
| 69 | </ul> |
| 70 | <font color="#665544" size="3"><b>Block Label</b></font><br> |
| 71 | <hr>This is a label for each group of data, usually labels for |
| 72 | the X axis such as the days of the week, months of the year, etc. Your |
| 73 | plugin can use the scalar count of values in this array as the number |
| 74 | of times a loop needs to iterate through an axis. For example:<br> |
| 75 | <br> |
| 76 | <code class="prettyprint">foreach my $j (1.. (scalar |
| 77 | @$blocklabel)) { ... }</code><br> |
| 78 | <br> |
| 79 | <font color="#665544" size="3"><b>Val Label</b></font><br> |
| 80 | <hr>@vallabel contains a list of labels for each of the data sets |
| 81 | such as "pages", "hits", etc. Use the scalar count of values when |
| 82 | accessing the data matrix.<br> |
| 83 | <br> |
| 84 | <font color="#665544" size="3"><b>Val Color</b></font><br> |
| 85 | <hr>This is an array of color values associated with each type of |
| 86 | data as assigned by the configuration file or the defaults in AWStats. |
| 87 | Each color is a web formatted RGB hex encoded value such as "FFFFFF" or |
| 88 | "000000". <br> |
| 89 | <br> |
| 90 | <font color="#665544" size="3"><b>Val Max</b></font><br> |
| 91 | <hr>This array contains the maximum individual numeric value for |
| 92 | each of the types of data stored in the data array. The count is the |
| 93 | same as the the color array.<br> |
| 94 | <br> |
| 95 | <font color="#665544" size="3"><b>Val Total</b></font><br> |
| 96 | <hr>This array contains the total numeric value for each type of |
| 97 | data stored in the data array. The count is the same as the |
| 98 | the color array. <br> |
| 99 | <br> |
| 100 | <font color="#665544" size="3"><b>Val Average</b></font><br> |
| 101 | <hr>This array contains the average numeric value for each type |
| 102 | of data |
| 103 | stored in the data array. The count is the same as the the |
| 104 | color array. <br> |
| 105 | <br> |
| 106 | <font color="#665544" size="3"><b>Val Data</b></font><br> |
| 107 | <hr>This array contains the actual data values for each type of |
| 108 | data indexed by each data type for a block of data, then the next set |
| 109 | of types for a block and so on. Thus if we were looking at the monthly |
| 110 | graph, the data would be laid out thusly:<br> |
| 111 | <br> |
| 112 | $valdata[0] --> January Unique Visitors<br> |
| 113 | $valdata[1] --> January Number of Visits<br> |
| 114 | $valdata[2] --> January Pages<br> |
| 115 | $valdata[3] --> January Hits<br> |
| 116 | $valdata[4] --> January Bandwidth<br> |
| 117 | $valdata[5] --> February Unique Visitors<br> |
| 118 | $valdata[6] --> February Number of Visits<br> |
| 119 | ....<br> |
| 120 | <br> |
| 121 | <font color="#665544" size="3"><b><a name="Graph_Types_and_Data"></a>Graph Types and Data</b></font><br> |
| 122 | <hr>Below is a list of the different graph types and the order in |
| 123 | which data appears in the associated arrays.<br> |
| 124 | <br> |
| 125 | <ul> |
| 126 | <li><span style="font-weight: bold;">month</span> |
| 127 | - a graph of each month for a given year</li> |
| 128 | <ul> |
| 129 | <li>Unique Visitors</li> |
| 130 | <li>Visits</li> |
| 131 | <li>Pages</li> |
| 132 | <li>Hits</li> |
| 133 | <li>Bandwidth</li> |
| 134 | </ul> |
| 135 | <li><span style="font-weight: bold;">daysofmonth</span> |
| 136 | - each day of the month</li> |
| 137 | <ul> |
| 138 | <li>Visits</li> |
| 139 | <li>Pages</li> |
| 140 | <li>Hits</li> |
| 141 | <li>Bandwidth</li> |
| 142 | </ul> |
| 143 | <li><span style="font-weight: bold;">daysofweek</span> |
| 144 | - an averaged data set for each day of the week</li> |
| 145 | <ul> |
| 146 | <li>Pages</li> |
| 147 | <li>Hits</li> |
| 148 | <li>Bandwidth</li> |
| 149 | </ul> |
| 150 | <li><span style="font-weight: bold;">hours</span> |
| 151 | - an averaged data set for each hour of a day</li> |
| 152 | <ul> |
| 153 | <li>Pages</li> |
| 154 | <li>Hits</li> |
| 155 | <li>Bandwidth</li> |
| 156 | </ul> |
| 157 | <li><span style="font-weight: bold;">cluster</span> |
| 158 | - the top 5 clustered servers if the cluster option is enabled</li> |
| 159 | <ul> |
| 160 | <li>Pages</li> |
| 161 | </ul> |
| 162 | <li><span style="font-weight: bold;">filetypes</span> |
| 163 | - the top 5 file types reported on</li> |
| 164 | <ul> |
| 165 | <li>Pages</li> |
| 166 | </ul> |
| 167 | <li><span style="font-weight: bold;">httpstatus</span> |
| 168 | - the top 5 HTTP status codes</li> |
| 169 | <ul> |
| 170 | <li>Pages</li> |
| 171 | </ul> |
| 172 | <li><span style="font-weight: bold;">browsers</span> |
| 173 | - the top 5 browsers</li> |
| 174 | <ul> |
| 175 | <li>Pages</li> |
| 176 | </ul> |
| 177 | <li><span style="font-weight: bold;">oss</span> |
| 178 | - the top 5 operating systems</li> |
| 179 | <ul> |
| 180 | <li>Pages</li> |
| 181 | </ul> |
| 182 | <li><span style="font-weight: bold;">hosts</span> |
| 183 | - the top 5 hosts</li> |
| 184 | <ul> |
| 185 | <li>Pages</li> |
| 186 | </ul> |
| 187 | <li><span style="font-weight: bold;">countries_map</span> |
| 188 | - a list of all countries and their hit counts</li> |
| 189 | <ul> |
| 190 | <li>Hits</li> |
| 191 | </ul> |
| 192 | </ul> |
| 193 | <br> |
| 194 | <hr> |
| 195 | <script language="javascript"> |
| 196 | var date='$Date: 2010/06/22 21:35:24 $'; |
| 197 | document.writeln("Last revision: "+date); |
| 198 | </script><!-- |
| 199 | First version of this tool was designed to analyze folowing web sites: |
| 200 | --> |
| 201 | </body></html> |
