Package io.ably.lib.types

Class Stats

java.lang.Object

io.ably.lib.types.Stats

public class Stats
extends java.lang.Object

Contains application statistics for a specified time interval and time period.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Stats.ConnectionTypes	Contains a breakdown of summary stats data for different (TLS vs non-TLS) connection types.
static class	Stats.Granularity	Describes the interval unit over which statistics are gathered.
static class	Stats.MessageCategory
static class	Stats.MessageCount	Contains the aggregate counts for messages and data transferred.
static class	Stats.MessageTraffic	Contains a breakdown of summary stats data for traffic over various transport types.
static class	Stats.MessageTypes	Contains a breakdown of summary stats data for different (channel vs presence) message types.
static class	Stats.ProcessedCount
static class	Stats.ProcessedMessages
static class	Stats.PushedMessages	Details the stats on push notifications.
static class	Stats.RequestCount	Contains the aggregate counts for requests made.
static class	Stats.ResourceCount	Contains the aggregate data for usage of a resource in a specific scope.

Field Summary

Fields

Modifier and Type	Field	Description
Stats.MessageTypes	all	A Stats.MessageTypes object containing the aggregate count of all message stats.
Stats.RequestCount	apiRequests	A Stats.RequestCount object containing a breakdown of API Requests.
Stats.ResourceCount	channels	A Stats.ResourceCount object containing a breakdown of channels.
Stats.ConnectionTypes	connections	A Stats.ConnectionTypes object containing a breakdown of connection related stats, such as min, mean and peak connections.
int	count
Stats.MessageTraffic	inbound	A Stats.MessageTypes object containing the aggregate count of inbound message stats.
java.lang.String	inProgress
java.lang.String	intervalId	The UTC time at which the time period covered begins.
Stats.MessageTraffic	outbound	A Stats.MessageTypes object containing the aggregate count of outbound message stats.
Stats.MessageTypes	persisted	A Stats.MessageTypes object containing the aggregate count of persisted message stats.
Stats.ProcessedMessages	processed
Stats.PushedMessages	push	A Stats.PushedMessages object containing a breakdown of stats on push notifications.
Stats.RequestCount	tokenRequests	A Stats.RequestCount object containing a breakdown of Ably Token requests.
java.lang.String	unit	The length of the interval the stats span.

Constructor Summary

Constructors

Constructor	Description
Stats()

Method Summary

Modifier and Type	Method	Description
static long	fromIntervalId(java.lang.String intervalId)
static java.lang.String	toIntervalId(long timestamp, Stats.Granularity granularity)

Methods inherited from class java.lang.Object

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

Field Detail

intervalId

public java.lang.String intervalId

The UTC time at which the time period covered begins. If unit is set to minute this will be in the format YYYY-mm-dd:HH:MM, if hour it will be YYYY-mm-dd:HH, if day it will be YYYY-mm-dd:00 and if month it will be YYYY-mm-01:00.

Spec: TS12a

unit

public java.lang.String unit

The length of the interval the stats span. Values will be a Stats.Granularity.

Spec: TS12c

count

public int count

inProgress

public java.lang.String inProgress

all

public Stats.MessageTypes all

A Stats.MessageTypes object containing the aggregate count of all message stats.

Spec: TS12e

inbound

public Stats.MessageTraffic inbound

A Stats.MessageTypes object containing the aggregate count of inbound message stats.

Spec: TS12f

outbound

public Stats.MessageTraffic outbound

A Stats.MessageTypes object containing the aggregate count of outbound message stats.

Spec: TS12g

persisted

public Stats.MessageTypes persisted

A Stats.MessageTypes object containing the aggregate count of persisted message stats.

Spec: TS12h

connections

public Stats.ConnectionTypes connections

A Stats.ConnectionTypes object containing a breakdown of connection related stats, such as min, mean and peak connections.

Spec: TS12i

channels

public Stats.ResourceCount channels

A Stats.ResourceCount object containing a breakdown of channels.

Spec: TS12j

apiRequests

public Stats.RequestCount apiRequests

A Stats.RequestCount object containing a breakdown of API Requests.

Spec: TS12k

tokenRequests

public Stats.RequestCount tokenRequests

A Stats.RequestCount object containing a breakdown of Ably Token requests.

Spec: TS12l

processed

public Stats.ProcessedMessages processed

push

public Stats.PushedMessages push

A Stats.PushedMessages object containing a breakdown of stats on push notifications.

Spec: TS12m

Constructor Detail

Stats

public Stats()

Method Detail

toIntervalId

public static java.lang.String toIntervalId(long timestamp,
                                            Stats.Granularity granularity)

fromIntervalId

public static long fromIntervalId(java.lang.String intervalId)