com.sap.cloud.server.odata

Class DataMetric

java.lang.Object

com.sap.cloud.server.odata.DataMetric

public class DataMetric
extends java.lang.Object

Metric that counts or times the occurrences of a particular kind of event.

Constructor Summary

Constructors

Constructor and Description
DataMetric()

Method Summary

Modifier and Type	Method and Description
void	add(long value) Add an observed value for an occurrence of the measured events for this metric.
static DataMetric	byteInstance(java.lang.String component, java.lang.String metric) Return a metric with unit "BYTE".
static DataMetricList	copyAndResetAll() Reset all metrics as if no measured events have occurred (after copying the previous values).
long	count() Return the number of occurrences of the measured event.
static DataMetric	createDatabaseTime(java.lang.String component) Return the 'createDatabaseTime' metric for the specified component.
static DataMetric	createEntityTime(java.lang.String component) Return the 'createEntityTime' metric for the specified component.
static DataMetric	createIndexTime(java.lang.String component) Return the 'createIndexTime' metric for the specified component.
static DataMetric	createLinkTime(java.lang.String component) Return the 'createLinkTime' metric for the specified component.
static DataMetric	createMediaTime(java.lang.String component) Return the 'createMediaTime' metric for the specified component.
static DataMetric	createTableTime(java.lang.String component) Return the 'createTableTime' metric for the specified component.
static DataMetric	deleteDatabaseTime(java.lang.String component) Return the 'deleteDatabaseTime' metric for the specified component.
static DataMetric	deleteEntityTime(java.lang.String component) Return the 'deleteEntityTime' metric for the specified component.
static DataMetric	deleteLinkTime(java.lang.String component) Return the 'deleteLinkTime' metric for the specified component.
static DataMetric	deleteStreamTime(java.lang.String component) Return the 'deleteStreamTime' metric for the specified component.
static DataMetric	deltaDownloadBytes_gzip(java.lang.String component) Return the 'deltaDownloadBytes_gzip' metric for the specified component.
static DataMetric	deltaDownloadBytes(java.lang.String component) Return the 'deltaDownloadBytes' metric for the specified component.
static DataMetric	deltaDownloadRows(java.lang.String component) Return the 'deltaDownloadRows' metric for the specified component.
static DataMetric	deltaDownloadTime(java.lang.String component) Return the 'executeQueryTime' metric for the specified component.
static DataMetric	downloadMediaTime(java.lang.String component) Return the 'downloadMediaTime' metric for the specified component.
static DataMetric	downloadPhaseTime(java.lang.String component) Return the 'downloadPhaseTime' metric for the specified component.
static DataMetric	downloadStreamTime(java.lang.String component) Return the 'downloadStreamTime' metric for the specified component.
static DataMetric	entityInstance(java.lang.String component, java.lang.String metric) Return a metric with unit "ENTITY".
static DataMetric	errorInstance(java.lang.String component, java.lang.String metric) Return a metric with unit "ERROR".
static java.lang.String	errorMetricName(java.lang.String method, java.lang.RuntimeException error) Return a suitable name for an error metric.
static DataMetric	executeMethodTime(java.lang.String component) Return the 'executeMethodTime' metric for the specified component.
static DataMetric	executeQueryTime(java.lang.String component) Return the 'executeQueryTime' metric for the specified component.
static DataMetric	fetchMetadataSize_gzip(java.lang.String component) Return the 'fetchMetadataSize_gzip' metric for the specified component.
static DataMetric	fetchMetadataSize(java.lang.String component) Return the 'fetchMetadataSize' metric for the specified component.
static DataMetric	fetchMetadataTime(java.lang.String component) Return the 'fetchMetadataTime' metric for the specified component.
static DataMetric	followedNextLink(java.lang.String component) Return the 'followedNextLink' metric for the specified component.
java.lang.String	getComponent() Return the component which owns this metric.
int	getId() Return a process-uniquie ID for this metric.
static DataMetric	getInstance(java.lang.String component, java.lang.String metric, java.lang.String unit) Construct a new metric or locate an existing metric.
long	getMaximum() Return the maximum observed value for occurrences of the measured event.
java.lang.String	getMetric() Return the name of this metric (should be unique for all metrics in the same DataMetric.component).
long	getMinimum() Return the minimum observed value for occurrences of the measured event.
long	getSum() Return the sum of observed values for occurrences of the measured event.
java.lang.String	getUnit() Return the measurement unit for this metric.
static DataMetric	initialDownloadBytes_gzip(java.lang.String component) Return the 'initialDownloadBytes_gzip' metric for the specified component.
static DataMetric	initialDownloadBytes(java.lang.String component) Return the 'initialDownloadBytes' metric for the specified component.
static DataMetric	initialDownloadRows(java.lang.String component) Return the 'initialDownloadRows' metric for the specified component.
static DataMetric	initialDownloadTime(java.lang.String component) Return the 'initialDownloadTime' metric for the specified component.
static DataMetric	linkInstance(java.lang.String component, java.lang.String metric) Return a metric with unit "LINK".
static DataMetric	loadMetadataTime(java.lang.String component) Return the 'loadMetadataTime' metric for the specified component, which includes fetch time and parse time.
static void	logAll() Log all metrics in CSV format to the DebugConsole.
static DataMetric	methodResultBytes_gzip(java.lang.String component) Return the 'methodResultBytes_gzip' metric for the specified component.
static DataMetric	methodResultBytes(java.lang.String component) Return the 'methodResultBytes' metric for the specified component.
static DataMetric	parseMetadataTime(java.lang.String component) Return the 'parseMetadataTime' metric for the specified component.
static DataMetric	pingServerTime(java.lang.String component) Return the 'pingServerTime' metric for the specified component.
static DataMetric	queryResultBytes_gzip(java.lang.String component) Return the 'queryResultBytes_gzip' metric for the specified component.
static DataMetric	queryResultBytes(java.lang.String component) Return the 'queryResultBytes' metric for the specified component.
static DataMetric	queryResultRows(java.lang.String component) Return the 'queryResultRows' metric for the specified component.
static DataMetric	requestInstance(java.lang.String component, java.lang.String metric) Return a metric with unit "REQUEST".
void	reset() Reset this metric as if no measured events have occurred.
static void	resetAll() Reset all metrics as if no measured events have occurred.
static DataMetric	rowInstance(java.lang.String component, java.lang.String metric) Return a metric with unit "ROW".
static DataMetric	selectEntityTime(java.lang.String component) Return the 'selectEntityTime' metric for the specified component.
static DataMetric	timeInstance(java.lang.String component, java.lang.String metric) Return a metric with unit "MICROSECOND".
static DataMetric	updateEntityTime(java.lang.String component) Return the 'updateEntityTime' metric for the specified component.
static DataMetric	updateLinkTime(java.lang.String component) Return the 'updateLinkTime' metric for the specified component.
static DataMetric	uploadMediaTime(java.lang.String component) Return the 'uploadMediaTime' metric for the specified component.
static DataMetric	uploadStreamTime(java.lang.String component) Return the 'uploadStreamTime' metric for the specified component.
static DataMetric	uploadTime(java.lang.String component) Return the 'uploadTime' metric for the specified component.
static DataMetric	upsertEntityTime(java.lang.String component) Return the 'upsertEntityTime' metric for the specified component.
static DataMetric	warningInstance(java.lang.String component, java.lang.String metric) Return a metric with unit "WARNING".
void	write(com.sap.cloud.server.odata.core.CharBuffer buffer) Write this metric in CSV format to the specified buffer.
static void	writeAll(com.sap.cloud.server.odata.core.CharBuffer buffer) Print all metrics in CSV format to the specified buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataMetric

public DataMetric()

Method Detail

add

public void add(long value)

Add an observed value for an occurrence of the measured events for this metric.

Parameters:

value - Observed value (count or time).

byteInstance

public static DataMetric byteInstance(java.lang.String component,
                                      java.lang.String metric)

Return a metric with unit "BYTE".

Parameters:

component - Metric owner.

metric - Metric name.

Returns:

A metric with unit "BYTE".

copyAndResetAll

public static DataMetricList copyAndResetAll()

Reset all metrics as if no measured events have occurred (after copying the previous values).

Returns:

The previous values.

count

public long count()

Return the number of occurrences of the measured event.

Returns:

The number of occurrences of the measured event.

createDatabaseTime

public static DataMetric createDatabaseTime(java.lang.String component)

Return the 'createDatabaseTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'createDatabaseTime' metric for the specified component.

createEntityTime

public static DataMetric createEntityTime(java.lang.String component)

Return the 'createEntityTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'createEntityTime' metric for the specified component.

createIndexTime

public static DataMetric createIndexTime(java.lang.String component)

Return the 'createIndexTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'createIndexTime' metric for the specified component.

createLinkTime

public static DataMetric createLinkTime(java.lang.String component)

Return the 'createLinkTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'createLinkTime' metric for the specified component.

createMediaTime

public static DataMetric createMediaTime(java.lang.String component)

Return the 'createMediaTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'createMediaTime' metric for the specified component.

createTableTime

public static DataMetric createTableTime(java.lang.String component)

Return the 'createTableTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'createTableTime' metric for the specified component.

deleteDatabaseTime

public static DataMetric deleteDatabaseTime(java.lang.String component)

Return the 'deleteDatabaseTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'deleteDatabaseTime' metric for the specified component.

deleteEntityTime

public static DataMetric deleteEntityTime(java.lang.String component)

Return the 'deleteEntityTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'deleteEntityTime' metric for the specified component.

deleteLinkTime

public static DataMetric deleteLinkTime(java.lang.String component)

Return the 'deleteLinkTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'deleteLinkTime' metric for the specified component.

deleteStreamTime

public static DataMetric deleteStreamTime(java.lang.String component)

Return the 'deleteStreamTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'deleteStreamTime' metric for the specified component.

deltaDownloadBytes

public static DataMetric deltaDownloadBytes(java.lang.String component)

Return the 'deltaDownloadBytes' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'deltaDownloadBytes' metric for the specified component.

deltaDownloadBytes_gzip

public static DataMetric deltaDownloadBytes_gzip(java.lang.String component)

Return the 'deltaDownloadBytes_gzip' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'deltaDownloadBytes_gzip' metric for the specified component.

deltaDownloadRows

public static DataMetric deltaDownloadRows(java.lang.String component)

Return the 'deltaDownloadRows' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'deltaDownloadRows' metric for the specified component.

deltaDownloadTime

public static DataMetric deltaDownloadTime(java.lang.String component)

Return the 'executeQueryTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'executeQueryTime' metric for the specified component.

downloadMediaTime

public static DataMetric downloadMediaTime(java.lang.String component)

Return the 'downloadMediaTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'downloadMediaTime' metric for the specified component.

downloadPhaseTime

public static DataMetric downloadPhaseTime(java.lang.String component)

Return the 'downloadPhaseTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'downloadPhaseTime' metric for the specified component.

downloadStreamTime

public static DataMetric downloadStreamTime(java.lang.String component)

Return the 'downloadStreamTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'downloadStreamTime' metric for the specified component.

entityInstance

public static DataMetric entityInstance(java.lang.String component,
                                        java.lang.String metric)

Return a metric with unit "ENTITY".

Parameters:

component - Metric owner.

metric - Metric name.

Returns:

A metric with unit "ENTITY".

errorInstance

public static DataMetric errorInstance(java.lang.String component,
                                       java.lang.String metric)

Return a metric with unit "ERROR".

Parameters:

component - Metric owner.

metric - Metric name.

Returns:

A metric with unit "ERROR".

errorMetricName

public static java.lang.String errorMetricName(java.lang.String method,
                                               java.lang.RuntimeException error)

Return a suitable name for an error metric.

Parameters:

method - Data method name.

error - Error for metric that occurred when invoking the data method.

Returns:

A suitable name for an error metric.

executeMethodTime

public static DataMetric executeMethodTime(java.lang.String component)

Return the 'executeMethodTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'executeMethodTime' metric for the specified component.

executeQueryTime

public static DataMetric executeQueryTime(java.lang.String component)

Return the 'executeQueryTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'executeQueryTime' metric for the specified component.

fetchMetadataSize

public static DataMetric fetchMetadataSize(java.lang.String component)

Return the 'fetchMetadataSize' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'fetchMetadataSize' metric for the specified component.

fetchMetadataSize_gzip

public static DataMetric fetchMetadataSize_gzip(java.lang.String component)

Return the 'fetchMetadataSize_gzip' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'fetchMetadataSize_gzip' metric for the specified component.

fetchMetadataTime

public static DataMetric fetchMetadataTime(java.lang.String component)

Return the 'fetchMetadataTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'fetchMetadataTime' metric for the specified component.

followedNextLink

public static DataMetric followedNextLink(java.lang.String component)

Return the 'followedNextLink' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'followedNextLink' metric for the specified component.

getComponent

public java.lang.String getComponent()

Return the component which owns this metric.

Returns:

The component which owns this metric.

getId

public int getId()

Return a process-uniquie ID for this metric.

Returns:

A process-uniquie ID for this metric.

getInstance

public static DataMetric getInstance(java.lang.String component,
                                     java.lang.String metric,
                                     java.lang.String unit)

Construct a new metric or locate an existing metric.

Parameters:

component - Value for DataMetric.component.

metric - Value for DataMetric.metric.

unit - Value for DataMetric.unit.

Returns:

Data metric (new or existing).

getMaximum

public long getMaximum()

Return the maximum observed value for occurrences of the measured event.

Returns:

The maximum observed value for occurrences of the measured event.

getMetric

public java.lang.String getMetric()

Return the name of this metric (should be unique for all metrics in the same DataMetric.component).

Returns:

The name of this metric (should be unique for all metrics in the same DataMetric.component).

getMinimum

public long getMinimum()

Return the minimum observed value for occurrences of the measured event.

Returns:

The minimum observed value for occurrences of the measured event.

getSum

public long getSum()

Return the sum of observed values for occurrences of the measured event.

Returns:

The sum of observed values for occurrences of the measured event.

getUnit

public java.lang.String getUnit()

Return the measurement unit for this metric.

Returns:

The measurement unit for this metric.

initialDownloadBytes

public static DataMetric initialDownloadBytes(java.lang.String component)

Return the 'initialDownloadBytes' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'initialDownloadBytes' metric for the specified component.

initialDownloadBytes_gzip

public static DataMetric initialDownloadBytes_gzip(java.lang.String component)

Return the 'initialDownloadBytes_gzip' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'initialDownloadBytes_gzip' metric for the specified component.

initialDownloadRows

public static DataMetric initialDownloadRows(java.lang.String component)

Return the 'initialDownloadRows' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'initialDownloadRows' metric for the specified component.

initialDownloadTime

public static DataMetric initialDownloadTime(java.lang.String component)

Return the 'initialDownloadTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'initialDownloadTime' metric for the specified component.

linkInstance

public static DataMetric linkInstance(java.lang.String component,
                                      java.lang.String metric)

Return a metric with unit "LINK".

Parameters:

component - Metric owner.

metric - Metric name.

Returns:

A metric with unit "LINK".

loadMetadataTime

public static DataMetric loadMetadataTime(java.lang.String component)

Return the 'loadMetadataTime' metric for the specified component, which includes fetch time and parse time.

See Also:

DataMetric.fetchMetadataTime, DataMetric.parseMetadataTime.

Parameters:

component - Metric owner.

Returns:

The 'loadMetadataTime' metric for the specified component, which includes fetch time and parse time.

logAll

public static void logAll()

Log all metrics in CSV format to the DebugConsole.

methodResultBytes

public static DataMetric methodResultBytes(java.lang.String component)

Return the 'methodResultBytes' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'methodResultBytes' metric for the specified component.

methodResultBytes_gzip

public static DataMetric methodResultBytes_gzip(java.lang.String component)

Return the 'methodResultBytes_gzip' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'methodResultBytes_gzip' metric for the specified component.

parseMetadataTime

public static DataMetric parseMetadataTime(java.lang.String component)

Return the 'parseMetadataTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'parseMetadataTime' metric for the specified component.

pingServerTime

public static DataMetric pingServerTime(java.lang.String component)

Return the 'pingServerTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'pingServerTime' metric for the specified component.

queryResultBytes

public static DataMetric queryResultBytes(java.lang.String component)

Return the 'queryResultBytes' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'queryResultBytes' metric for the specified component.

queryResultBytes_gzip

public static DataMetric queryResultBytes_gzip(java.lang.String component)

Return the 'queryResultBytes_gzip' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'queryResultBytes_gzip' metric for the specified component.

queryResultRows

public static DataMetric queryResultRows(java.lang.String component)

Return the 'queryResultRows' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'queryResultRows' metric for the specified component.

requestInstance

public static DataMetric requestInstance(java.lang.String component,
                                         java.lang.String metric)

Return a metric with unit "REQUEST".

Parameters:

component - Metric owner.

metric - Metric name.

Returns:

A metric with unit "REQUEST".

reset

public void reset()

Reset this metric as if no measured events have occurred.

resetAll

public static void resetAll()

Reset all metrics as if no measured events have occurred.

rowInstance

public static DataMetric rowInstance(java.lang.String component,
                                     java.lang.String metric)

Return a metric with unit "ROW".

Parameters:

component - Metric owner.

metric - Metric name.

Returns:

A metric with unit "ROW".

selectEntityTime

public static DataMetric selectEntityTime(java.lang.String component)

Return the 'selectEntityTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'selectEntityTime' metric for the specified component.

timeInstance

public static DataMetric timeInstance(java.lang.String component,
                                      java.lang.String metric)

Return a metric with unit "MICROSECOND".

Parameters:

component - Metric owner.

metric - Metric name.

Returns:

A metric with unit "MICROSECOND".

updateEntityTime

public static DataMetric updateEntityTime(java.lang.String component)

Return the 'updateEntityTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'updateEntityTime' metric for the specified component.

updateLinkTime

public static DataMetric updateLinkTime(java.lang.String component)

Return the 'updateLinkTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'updateLinkTime' metric for the specified component.

uploadMediaTime

public static DataMetric uploadMediaTime(java.lang.String component)

Return the 'uploadMediaTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'uploadMediaTime' metric for the specified component.

uploadStreamTime

public static DataMetric uploadStreamTime(java.lang.String component)

Return the 'uploadStreamTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'uploadStreamTime' metric for the specified component.

uploadTime

public static DataMetric uploadTime(java.lang.String component)

Return the 'uploadTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'uploadTime' metric for the specified component.

upsertEntityTime

public static DataMetric upsertEntityTime(java.lang.String component)

Return the 'upsertEntityTime' metric for the specified component.

Parameters:

component - Metric owner.

Returns:

The 'upsertEntityTime' metric for the specified component.

warningInstance

public static DataMetric warningInstance(java.lang.String component,
                                         java.lang.String metric)

Return a metric with unit "WARNING".

Parameters:

component - Metric owner.

metric - Metric name.

Returns:

A metric with unit "WARNING".

write

public void write(com.sap.cloud.server.odata.core.CharBuffer buffer)

Write this metric in CSV format to the specified buffer.

Parameters:

buffer - Buffer for metrics to be appended to.

writeAll

public static void writeAll(com.sap.cloud.server.odata.core.CharBuffer buffer)

Print all metrics in CSV format to the specified buffer.

Parameters:

buffer - Output buffer.