| about timian |
|---|
|
summary & news overview some samples license mailing-lists things to do bugs!! the author |
| get timian |
|---|
|
supported platforms download building binaries |
| documentation |
|---|
|
manpage change log XSLT report formats report specs Xalan extensions DTDs |
| styles |
|---|
|
overview writing gallery |
| analog |
|---|
|
summary XML explained DTD analog-data |
| i18n |
|---|
|
Overview locale languages ISO639-2 ISO3166 UTF-8 |
| feedback |
|---|
| tell me |
|
© 2003 Per Jessen, per@computer.org. Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved. |
Analogs XML - elements & attributes
This document is intended as quick introduction to the format of the XML document
produced when you use "OUTPUT XML" in analog. This is not meant as a detailed walk-through of
the entire document, but more as a way to get an idea of what the document contains.
It will also
list reference material which will come in handy for anyone writing a analog XML post-processor or a
Timian report format.
XML sample
An excerpt from an analog XML document - the analog section and a single report section. In this case the yearly report, which holds just a single row.
<analog>
<property name="version" content="5.90beta2/Unix" />
<property name="built" content="200304141314" />
<property name="starttime" content="200304241047" />
<timespan from="200303040336" to="200304232232" days="50.793889" />
</analog>
<report name="rep_year">
<rowlimit count="0" />
<sort dir="ascending" by="" />
<row>
<col name="col_reqs">416</col>
<col name="col_preqs">100.000000</col>
<col name="col_pages">56</col>
<col name="col_ppages">100.000000</col>
<col name="col_bytes">26703141.000000</col>
<col name="col_pbytes">100.000000</col>
<col name="name"><timespan from="200303040000" to="200403022359" /></col>
</row>
<busiest time="200303040000" pages="56" />
</ report><!-- name="rep_year" -->
</analog-data>
elements & attributes
This section describes the individual elements and attributes used in the analog-data XML document. To some extent it is the prose-equivalent of the analog-data DTD.
Some general details:
number = a floating point number, with optional decimal point and trailing decimals.
timestamp = a timestamp of the form YYYYMMDDhhmm.
string = a sequence characters.
| Elements & attributes | Description/explanation |
| <analog-data> | This is the top-level element of the document. It has two attributes: |
|---|---|
| version | The specific version of analog that produced the document. This information is primarily used to make sure that the DTD and the XML document are in synch. |
| timestamp | The time at which this XML document was created. The format is YYYYMMDDhhmmss. |
| <analog> | The <analog> element contains data that applies to the entire document. |
| <property> | The <property> element is a sort of catch-all. There are currently no restrictions on the use of the name and content attributes. |
| name | |
| content | |
| <timespan> | The <timespan> element identifies a period of time by listing its begin- and end-times. Optionally, a selection of other attributes may be present. |
| from | A timestamp. |
| to | A timestamp. |
| days | The timespan represented as a number of days |
| dayofweek | The from timestamp represented as a day of the week: 0=Sunday, 1=Monday, etc. |
| hour | The hh part of the from timestamp represented as 0-23. |
| minute | The mm part of the from timestamp represented as 0-59. |
| <report> | The <report> element identifies a single instance of an individual analog report-section,
an individual analog report-section being one of the 44 possible. |
| name | The name attribute uniquely identifies the report. A complete list of possible report names is listed at the bottom of this page. |
| <row> | Each <report> will contain 1 or more <row> elements. Optionally a <row> element may have a level attribute. |
| level | The level attribute indicates the hierarchical level of a <row>. |
| <rowlimit> | The <rowlimit> element is used in Time Reports to indicate the maximum number of rows listed. It is the representation of the analog configuration *ROWS. |
| count | number |
| <busiest> | The <busiest> element is used in Time Reports to identify the busiest time of the period reported on. |
| time | timestamp |
| pages | number |
| bytes | number |
| reqs | number |
| <sort> | A <report> may have 0, 1 or 2 <sort> elements. They indicate the sort-order and -key in document order. Generally, the <sort> elements represent the analog configurations *BACK and *SORTBY. |
| dir | The sort direction: "ascending" or "descending". |
| by | The sort key: REQUESTS | REQUESTS7 | PAGES | PAGES7 | REDIR | REDIR7 | FAIL | FAIL7 | SUCCDATE | REDIRDATE | FAILDATE | SUCCFIRSTD | REDIRFIRSTD | FAILFIRSTD | BYTES | BYTES7 | ALPHABETICAL | RANDOM. |
| <floor> | A <report> may have 0, 1 or 2 <floor> elements. They indicate the settings used to limit the number row listed. |
| level | |
| qual | The "qual" attribute is optional; if specified it will have one of the following values: "%" (percent) : |
| by | |
| <col> |
The <col> contains the actual analog analysis data. Each <row> element may have 1 or more <col> elements.
A column is uniquely identified by its name attribute. A complete list of possible column names is listed at the bottom of this page. |
| <i18n> | The <i18n> element is used in name columns to represent names known .... known to analog: |
| key | The key attribute is intended as an index- or lookup key to a message-table for internationali[sz]ation. |
List of report names
| Name | Description | Name | Description |
|---|---|---|---|
| REP_YEAR | Yearly/annual report | REP_QUARTERLY | Quarterly report |
| REP_MONTH | Monthly report | REP_WEEK | Weekly report |
| REP_DAYREP | Daily report | REP_HOURREP | Hourly report |
| REP_QUARTERREP | 15-minute report | REP_FIVEREP | 5-minute report |
| REP_DAYSUM | Daily summary | REP_HOURSUM | Hourly summary |
| REP_WEEKHOUR | Hour-of-the-week report | REP_QUARTERSUM | 15-minute summary |
| REP_FIVESUM | 5-minute summary | REP_GENSUM | Generic summary report |
| REP_REQ | Request report | REP_REDIR | Redirected request report |
| REP_FAIL | REP_TYPE | ||
| REP_DIR | REP_HOST | ||
| REP_REDIRHOST | REP_FAILHOST | ||
| REP_DOM | REP_REF | ||
| REP_REFSITE | REP_REDIRREF | ||
| REP_FAILREF | REP_BROWREP | ||
| REP_VHOST | REP_REDIRVHOST | ||
| REP_FAILVHOST | REP_USER | ||
| REP_REDIRUSER | REP_FAILUSER | ||
| REP_ORG | Organisation Report | REP_SEARCHREP | Search Word Report |
| REP_SEARCHSUM | Search Word Summary | REP_INTSEARCHREP | Internal Search Word Report |
| REP_INTSEARCHSUM | Internal Search Word Summary | REP_BROWSUM | Browser Summary Report |
| REP_OS | Operating System | REP_SIZE | |
| REP_CODE | Status Code Teport | REP_PROCTIME | Processing Time Report |
List of column names
| Name | Description |
|---|---|
| COL_NAME | Name column. |
| COL_REQS | Number of requests |
| COL_REQS7 | Number of requests in the last 7 days |
| COL_PAGES | Number of pages |
| COL_PAGES7 | Number of pages in the last 7 days |
| COL_BYTES | Number of bytes |
| COL_BYTES7 | Number of bytes in the last 7 days |
| COL_PREQS | Number of requests as a percentage of the total |
| COL_PREQS7 | Number of requests in the last 7 days as a percentage of the total |
| COL_PPAGES | Number of requests as a percentage of the total |
| COL_PPAGES7 | Number of pages in the last 7 days as a percentage of the total |
| COL_PBYTES | Number of bytes as a percentage of the total |
| COL_PBYTES7 | Number of bytes in the last 7 days as a percentage of the total |
| COL_FIRSTT | Time and date of the earliest occurrence |
| COL_TIME | Time and date of the latest occurrence |
| COL_INDEX |
| Last time this page was updated: Friday 9 May 2003 20:52 |
|