Product SiteDocumentation Site

Chapter 5. Working With Usage Data

5.1. Usage Record Format
5.1.1. Virtual Machine Usage Record Format
5.1.2. Network Usage Record Format
5.1.3. IP Address Usage Record Format
5.1.4. Disk Volume Usage Record Format
5.1.5. Template, ISO, and Snapshot Usage Record Format
5.1.6. Load Balancer Policy or Port Forwarding Rule Usage Record Format
5.1.7. Network Offering Usage Record Format
5.1.8. VPN User Usage Record Format
5.2. Usage Types
5.3. Example response from listUsageRecords
5.4. Dates in the Usage Record
The Usage Server provides aggregated usage records which you can use to create billing integration for the CloudStack platform. The Usage Server works by taking data from the events log and creating summary usage records that you can access using the listUsageRecords API call.
The usage records show the amount of resources, such as VM run time or template storage space, consumed by guest instances. In the special case of bare metal instances, no template storage resources are consumed, but records showing zero usage are still included in the Usage Server's output.
The Usage Server runs at least once per day. It can be configured to run multiple times per day. Its behavior is controlled by configuration settings as described in the CloudStack Administration Guide.