Globus Usage Statistics XML Schema

Types

  • Type: report

    • Name report
    Documentation: The overall element of a Globus Usage Statistics Report

    XML Instance Representation
    <report>
    <histogram>...</histogram> [0...*]
    </report>

  • Type: histogram

    • Documentation: This type contains the necessary information to create histograms for Usage Statistics. The entry elements form the time histograms, and the slots element forms the slotted histograms. The title field determines the title of the graph, the output field the output file name of the graph, and the axis name the y-axis label for the graph

    XML Instance Representation
    <histogram>
    <title> ... </title> [1]
    <output> ... </output> [1]
    <axis> ... </axis> [1]
    <entry> ... </entry> [1...*]
    <slots> ... </slots> [1]
    </histogram>

  • Type: entry

    • Documentation: This contains the data for one time step of statistics. It is used to create time histograms.

    XML Instance Representation
    <entry>
    <start-date>...</start-date> [1]
    <end-date>...</end-date> [1]
    <item>...</item> [1...*]
    </entry>

  • Type: slots

    • Documentation: This contains the data to create a slotted histogram. Each item element in the slots element contains the aggregate value of that item for the entire sample period, not just one time step

    XML Instance Representation
    <slots>
    <start-date>...</start-date> [1]
    <end-date>...</end-date> [1]
    <item>...</item> [1...*]
    </slots>

  • Type: item

    • Documentation: This type contains the values to be graphed for one statistic for this time period. In an entry type, items are arranged in ascending order based on their overall number of occurences across all entries. In a slots type, they are listed in the order in which they are specified (to be later sorted by size if necessary and appropriate).

    XML Instance Representation
    <item>
    <name>...</name> [1]
    <sub-item>...</sub-item> [0...]
    <single-value> ... <single-value> [1]
    <value> ... <value> [0...1]
    <item>


  • Type: sub-item

    • Documentation: This type allows several items to be grouped together under one overall item. This is used, for example, when several items are of very low values compared to the total. If only one job out of one hundred thousand comes from the .gov domain, it will not be visible on the final graph. Therefore it is listed as a sub-item, along with all other domains too small to display, in the item named "other." This allows for neater final graphs without losing any raw data. The WS GRAM, GFTP, and RFT reports currently make an item a sub-item of "other" if its grand total is less than .5% of the overall total.

    XML Instance Representation
    <sub-item>
    <name>...</name> [1]
    <single-value> ... <single-value> [1]
    <sub-item>


    Elements

  • Element: title

    • Documentation: This contains a string that will be used as the title for the graph generated by this histogram.

    XML Instance Representation
    <title> string </title>

  • Element: ouptut

    • Documentation: This contains a string that will determine the output file for this histogram graph. The output will be [string].png.

    XML Instance Representation
    <output> string </output>

  • Element: axis

    • Documentation: This contains the name of the y axis for the histogram graph.

    XML Instance Representation
    <axis> string </axis>

    Element: start-date
    Documentation: This contains the beginning date of this time step in yyyy-mm-dd format, and is used for marking the x-axis on the histogram output.

    XML Instance Representation
    <start-date>yyyy-mm-dd</start-date>
  • Element: end-date

    • Documentation: This element contains the ending date of this time step in yyyy-mm-dd format.

    XML Instance Representation
    <end-date> yyyy-mm-dd</end-date>

  • Element: name
    • Documentation: This is the name of the specific item; it will be used to create a key.

    XML Instance Representation
    <name>string</name>

  • Element: single-value

    • Documentation: This contains the value of just this item. For example, if 2000 bytes were transfered, item "Number of Bytes Transfered" would have the single value of 2000. It is used for creating tables and graphing items in slotted histograms.

    XML Instance Representation
    <single-vlaue>int<single-value>

  • Element: value

    • Documentation: This value is used to plot stacked time histograms, where one item is placed directly on top of the other. It is the sum of the single-value of this item and all item single-value elements below it. This element is necessary for GNUplot version 4.0 as stacked histograms are not an inherent feature. In higher versions of GNUplot this is not an issue. If, for example, there were two items "% success" and "% failure" with single values of 5 and 95 respectively in an entry, then the value of "% success" would be 100 (the sum of the single values of success and failure) and the value of "% failure" would be 95 (as there are no further items to sum up). The GNUplot program will graph one bar of value 100 for this entry, where the top 5 units will be green (which the key will show to be "% success") and the bottom 95 units will be red (shown by the key to be "% failure"). This is a nice feature which can be used to show the breakdown of total values by type (number of packets shown by domain, for example).

    XML Instance Representation
    <value>double</value>