1. Overview¶
This guide is a quick reference to the information monitored by the AMPS administrative interface. It includes information on the RESTful AMPS interface as well as the information recorded in the AMPS statistics database.
For use with the AMPS administrative interface, the guide is intended to be a guide to help you understand the information presented in the interface. Likewise, when working with the statistics database, the guide is intended to provide a quick reference to the metrics in the database.
The guide is organized in the same way that the administrative interface is:
- Administrator This section describes the administrator resource in the administrative console. That resource provides the ability to change the state of the AMPS instance, and also generate diagnostic information to be written to the logs. There is no corresponding information in the statistics database.
- Host This section describes the
host
resource in the administrative console and the host tables in the statistics database (the tables prefixed withH
). - Instance This section describes the
instance
resource in the administrative console and the instance tables in the statistics database (the tables prefixed withI
).
Resource Mapping¶
The guide is designed to make it easy to locate a particular resource.
Administrative Interface
To find the correct URI for a particular resource, you can start with the guide to find the path to the area, then use a browser to find the path to the specific resource you are looking for. For example, to find information about a specific drive, you might use the following steps:
- Drive information is managed by the host, rather than a specific instance, so the information will be located in the host interface.
- Within the host section of the guide, the information for drives
is listed under the
disks
heading.
Therefore, to start exploring information about drives attached to
the host, you would use the /amps/host/disks
path in a browser
to locate a specific device and the information about this device.
Statistics Database
To find the correct table for a particular resource, you can start with the
guide to find the path to the area, then use sqlite3
or
amps-sqlite
to query the information for that resource. For example,
to find information about a specific drive, you might use the following
steps:
- Drive information is managed by the host, rather than a specific
instance, so the table that holds the information will have an
H
prefix. - Within the host section of the guide, the information for drives
is listed under the
disks
heading.
Therefore, to find information about drives, you would start with the
HDISKS
view (in amps-sqlite
) or the HDISKS_*
family of tables
(in sqlite3
).
Statistics Types¶
The AMPS statistics present statistics of several types:
Type | Description |
---|---|
cumulative | Statistics are cumulative since the instance was started (for example, the number of bytes AMPS has sent over a given network interface since the instance started). |
fixed | Information that is fixed for the lifetime of the instance (for example, the process ID of the AMPS server). |
interval average | Average computed for this statistics interval (for example, the number of bytes sent per second on a given network interface for the last statistics interval). |
running average | Average computed since the instance was started (for example, the conflation ratio for a conflated topic). |