com.quantum.dxi.rest.dar

Class RrdStats

java.lang.Object

BaseTimeSeries

com.quantum.dxi.rest.dar.RrdStats

public class RrdStats
extends BaseTimeSeries

The RrdStats resource represents RRD time series data for the system. The RrdStats interfaces includes services for getting data series from RRD databases on the system. For getting RRD databases metadata (database and data source names, supported consolidation functions and resolutions) please refer to the Rrd web service.

The schema that defines the RrdStats resource is defined below.

 
    <xs:element name="TimedFloats">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="T" type="xs:long">
                    <xs:annotation>
                        <xs:documentation>Offset from Base Time</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="V1" type="xs:float">
                    <xs:annotation>
                        <xs:documentation>Value for Id 1</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="V2" type="xs:float" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Value for Id 2</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="V3" type="xs:float" minOccurs="0"/>
                <xs:element name="V4" type="xs:float" minOccurs="0"/>
                <xs:element name="V5" type="xs:float" minOccurs="0"/>
                <xs:element name="V6" type="xs:float" minOccurs="0"/>
                <xs:element name="V7" type="xs:float" minOccurs="0"/>
                <xs:element name="V8" type="xs:float" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:element name="FloatSeries">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="IdentifierList" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>Comma seperated list of Ids</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="TotalCount" type="xs:long"/>
                <xs:element name="BaseTime" type="xs:long"/>
                <xs:element ref="TimedFloats" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
RrdStats()

Method Summary

Modifier and Type	Method and Description
FloatSeries	getSingleTrendSeries(javax.servlet.http.HttpServletRequest request, java.lang.String database, java.lang.String function, java.lang.String resolution, java.lang.String series, java.lang.String filterString) GET /rest/RrdStats/{database}/{function}/{resolution}/{series}
FloatSeries	getTrendSeries(javax.servlet.http.HttpServletRequest request, java.lang.String database, java.lang.String function, java.lang.String resolution, java.lang.String filterString, java.lang.String ids) GET /rest/RrdStats/{database}/{function}/{resolution}

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RrdStats

public RrdStats()

Method Detail

getSingleTrendSeries

public FloatSeries getSingleTrendSeries(@Context
                                        javax.servlet.http.HttpServletRequest request,
                                        java.lang.String database,
                                        java.lang.String function,
                                        java.lang.String resolution,
                                        java.lang.String series,
                                        java.lang.String filterString)

GET /rest/RrdStats/{database}/{function}/{resolution}/{series}

Get the RRD statistics for a single data series from the database identified by {database}, using the consolidation function specified by {function}, at the requested {resolution}, for the data series identified by {series}.

{database}: Use the GET /rest/Rrd request to retrieve the list of valid database names.

The {function} is the rrdtool consolidation function for the data (AVERAGE, MIN, MAX, and LAST). Use the GET /rest/Rrd/Archives/{database} request to find out what functions are available for a specific database. Specifying an unsupported consolidation function for a data series will result in an error.

The {resolution} value specifies the requested resolution of the data, in seconds. Most of the databases support resolutions of 2 seconds, 60 seconds, 600 seconds (10 minutes), and 3600 seconds (1 hour). Note that requested start and end times must be multiples of the requested resolution. If the start or end time is not a multiple of the requested resolution, or the requested resolution is not supported by the database, or there is no data available at the requested resolution for the requested time period, the returned data may be at a different resolution than the request. GET /rest/Rrd/Archives/{database} allows to list resolutions, supported by a specific database.

{series} parameter allows to narrow the results to a specific data source. Use the GET /rest/Rrd/DataSources/{database} request to retrieve the list of data sources available in a specific database.

getSingleTrendSeries supports the table query parameters for filtering. The only supported filter column is "Time".

Response Entity type: <xs:element name="FloatSeries">

Since:

1.1

See Also:

Rrd

getTrendSeries

public FloatSeries getTrendSeries(@Context
                                  javax.servlet.http.HttpServletRequest request,
                                  java.lang.String database,
                                  java.lang.String function,
                                  java.lang.String resolution,
                                  java.lang.String filterString,
                                  java.lang.String ids)

GET /rest/RrdStats/{database}/{function}/{resolution}

Get the RRD statistics for multiple data series from a single database identified by {database}, using the consolidation function specified by {function}, at the requested {resolution}.

{database}: Use the GET /rest/Rrd request to retrieve the list of valid database names.

The {function} is the rrdtool consolidation function for the data (AVERAGE, MIN, MAX, and LAST). Use the GET /rest/Rrd/Archives/{database} request to find out what functions are available for a specific database. Specifying an unsupported consolidation function for a data series will result in an error.

The {resolution} value specifies the requested resolution of the data, in seconds. Most of the databases support resolutions of 2 seconds, 60 seconds, 600 seconds (10 minutes), and 3600 seconds (1 hour). Note that requested start and end times must be multiples of the requested resolution. If the start or end time is not a multiple of the requested resolution, or the requested resolution is not supported by the database, or there is no data available at the requested resolution for the requested time period, the returned data may be at a different resolution than the request. GET /rest/Rrd/Archives/{database} allows to list resolutions, supported by a specific database.

Requested data series names are specified as a comma-separated list, passed in via the ids query parameter, e.g.:

?ids=series1,series2,seriesN

If the ids query parameter is not present, all data series are returned. Use the GET /rest/Rrd/DataSources/{database} request to retrieve the list of data sources available in a specific database.

getTrendSeries supports the table query parameters for filtering. The only supported filter column is "Time".

Response Entity type: <xs:element name="FloatSeries">

Since:

1.1

See Also:

Rrd