com.solace.messaging.util

Interface Manageable.ApiMetrics

Enclosing interface:

Manageable

@ProviderType
public static interface Manageable.ApiMetrics

An interface for statistics and metrics collection.

Note: Metrics collection can be disabled by adding OS environment variable the JCSMP_DISABLE_STATS before using this API.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Manageable.ApiMetrics.Metric List of collected metrics in the API.

Method Summary

Modifier and Type	Method and Description
long	getValue(Manageable.ApiMetrics.Metric theMetric) Retrieves the metric's current value/count.
void	reset() Resets all the statistics.
String	toString() Prints all available statistics as a String value.

Method Detail

getValue

long getValue(Manageable.ApiMetrics.Metric theMetric)

Retrieves the metric's current value/count.

Parameters:

theMetric - the metric for which to retrieve the value

Returns:

the count of the specified theMetric

Since:

1.0

reset

void reset()

Resets all the statistics.

Since:

1.0

toString

String toString()

Prints all available statistics as a String value.

Overrides:

toString in class Object

Returns:

the collected metrics as a key-value list

Since:

1.0