| <?xml version='1.0' encoding='utf-8' ?> |
| <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ |
| <!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> |
| %BOOK_ENTITIES; |
| ]> |
| |
| <!-- Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| <chapter id="work-with-usage"> |
| <title>Working with Usage</title> |
| <para>The Usage Server is an optional, separately-installed part of &PRODUCT; that provides |
| aggregated usage records which you can use to create billing integration for &PRODUCT;. 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. </para> |
| <para>The usage records show the amount of resources, such as VM run time or template storage |
| space, consumed by guest instances.</para> |
| <para>The Usage Server runs at least once per day. It can be configured to run multiple times per |
| day.</para> |
| <xi:include href="configure-usage-server.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
| <xi:include href="set-usage-limit.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
| <xi:include href="globally-configured-limits.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
| <xi:include href="limit-accounts-domains.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
| </chapter> |