com.solace.messaging.util

Enum Manageable.ApiMetrics.Metric

java.lang.Object

java.lang.Enum<Manageable.ApiMetrics.Metric>

com.solace.messaging.util.Manageable.ApiMetrics.Metric

All Implemented Interfaces:

Serializable, Comparable<Manageable.ApiMetrics.Metric>

Enclosing interface:

Manageable.ApiMetrics

public static enum Manageable.ApiMetrics.Metric
extends Enum<Manageable.ApiMetrics.Metric>

List of collected metrics in the API.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
BROKER_DISCARD_NOTIFICATIONS_RECEIVED The number of messages received when the Discard Notification is bit set.
COMPRESSED_BYTES_RECEIVED The number of compressed bytes received (before decompression).
CONNECTION_ATTEMPTS The total number of connections attempted by the Messaging Service.
DIRECT_BYTES_RECEIVED The number of bytes received as Direct Messages.
DIRECT_BYTES_SENT The number of the bytes sent as Direct Messages.
DIRECT_MESSAGES_RECEIVED The number of Direct Messages received.
DIRECT_MESSAGES_SENT The number of Direct Messages sent.
INTERNAL_DISCARD_NOTIFICATIONS The number of times discard flag on received messages was set as a result of messages being dropped by configured back-pressure strategy.
NONPERSISTENT_BYTES_RECEIVED A count of bytes received messages with delivery mode NON_PERSISTENT.
NONPERSISTENT_BYTES_REDELIVERED A count of bytes in messages that were retransmitted to the appliance with delivery mode NON_PERSISTENT
NONPERSISTENT_BYTES_SENT A count of bytes sent with delivery mode NON_PERSISTENT.
NONPERSISTENT_MESSAGES_RECEIVED A count of messages received that were acknowledged with delivery mode NON_PERSISTENT, indicating successful delivery to the application.
NONPERSISTENT_MESSAGES_REDELIVERED A count of messages that were retransmitted to the appliance with delivery mode NON_PERSISTENT.
NONPERSISTENT_MESSAGES_SENT A count of messages sent with delivery mode NON_PERSISTENT.
PERSISTENT_ACKNOWLEDGE_SENT The number of the messages received through Guaranteed Messaging that were acknowledged.
PERSISTENT_BYTES_RECEIVED The number of bytes of Guaranteed (Persistent) Messages received.
PERSISTENT_BYTES_REDELIVERED The number of bytes of Guaranteed Messages that were retransmitted to the event broker.
PERSISTENT_BYTES_SENT The number of bytes of Guaranteed Messages sent.
PERSISTENT_DUPLICATE_MESSAGES_DISCARDED The number of Guaranteed Messages received which were discarded as duplicate messages.
PERSISTENT_MESSAGES_RECEIVED The number of bytes of Guaranteed Messages received.
PERSISTENT_MESSAGES_REDELIVERED The number of Guaranteed Messages messages that were retransmitted to the event broker.
PERSISTENT_MESSAGES_SENT The number of Guaranteed Messages sent.
PERSISTENT_NO_MATCHING_FLOW_MESSAGES_DISCARDED The number of received Guaranteed Messages that were discarded due to arriving on a message flow that did not match any local open message flows.
PERSISTENT_OUT_OF_ORDER_MESSAGES_DISCARDED The number of Guaranteed Messages received and discarded for being received in the wrong sequence or order.
PUBLISH_INTERNAL_METHOD_CALLED The number of times the client API internal message send methods have been called.
PUBLISH_MESSAGE_ERROR_CALLBACKS The number of published Guaranteed Messages that generated an error response from the event broker.
PUBLISH_MESSAGE_OK_CALLBACKS The number of published Guaranteed Messages that generated a confirmed response from the event broker.
PUBLISH_MESSAGES_BACKPRESSURE_DISCARDED The number of outgoing messages dropped by the client API due to their publisher being too fast.
PUBLISH_MESSAGES_TERMINATION_DISCARDED The number of outgoing messages dropped by the client API due to their publisher being stopped.
PUBLISHED_MESSAGES_ACKNOWLEDGED The total number of Guaranteed Messages sent that were acknowledged by the event broker.
PUBLISHED_MESSAGES_REJECTED The number of messages rejected by the event broker.
PUBLISHER_ACKNOWLEDGEMENT_TIMEOUTS The number of times the acknowledgment timer expired.
PUBLISHER_WINDOW_CLOSED The number of times an application attempted to enqueue a Guaranteed Message for publishing and found the publisher window full.
RECEIVED_MESSAGES_BACKPRESSURE_DISCARDED The number of incoming messages dropped by the client API due to their receiver being slow.
RECEIVED_MESSAGES_DISCARDED_INTERNAL The number of incoming messages dropped by the client API due to their receiver being stopped or slow.
RECEIVED_MESSAGES_TERMINATION_DISCARDED The number of incoming messages dropped by the client API due to their receiver being stopped.
REQUEST_REPLY_REPLIES_DISCARDED The number of RequestReply replies discarded because there was no outstanding request.
REQUEST_REPLY_REPLIES_RECEIVED The number of RequestReply replies received.
REQUEST_REPLY_REQUESTS_SENT The number of RequestReply request messages sent.
REQUEST_REPLY_REQUESTS_TIMEOUT The number of RequestReply request messages timed out.
TOTAL_BYTES_RECEIVED The number of bytes received in all messages [Direct, Non-Persistent, and Guaranteed (Persistent)].
TOTAL_BYTES_SENT The number of bytes sent as part of all published messages [Direct, Non-Persistent, and Guaranteed (Persistent)].
TOTAL_MESSAGES_RECEIVED The number of messages received [Direct, Non-Persistent, and Guaranteed (Persistent)].
TOTAL_MESSAGES_SENT A count of all messages internally sent to the event broker.
UNKNOWN_PARAMETER_MESSAGES_DISCARDED The number of Solace messages discarded due to the presence of an unknown element in the SMF (Solace Message Format) header.

Method Summary

Modifier and Type	Method and Description
static Manageable.ApiMetrics.Metric	valueOf(String name) Returns the enum constant of this type with the specified name.
static Manageable.ApiMetrics.Metric[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BROKER_DISCARD_NOTIFICATIONS_RECEIVED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="ROUTER_DISCARD_NOTIFICATIONS")
public static final Manageable.ApiMetrics.Metric BROKER_DISCARD_NOTIFICATIONS_RECEIVED

The number of messages received when the Discard Notification is bit set.

Note that a message arriving with the Discard Notification bit set indicates that one or more direct messages prior to this message were dropped, therefore, this statistic is not indicative of the number of dropped messages.

Since:

1.0

COMPRESSED_BYTES_RECEIVED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="TOTAL_SOCKET_COMPRESSED_BYTES_RECVED")
public static final Manageable.ApiMetrics.Metric COMPRESSED_BYTES_RECEIVED

The number of compressed bytes received (before decompression).

Since:

1.0

CONNECTION_ATTEMPTS

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="TOTAL_CONNECTION_ATTEMPTS")
public static final Manageable.ApiMetrics.Metric CONNECTION_ATTEMPTS

The total number of connections attempted by the Messaging Service.

Since:

1.0

DIRECT_BYTES_RECEIVED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_DIRECT_BYTES_RECVED")
public static final Manageable.ApiMetrics.Metric DIRECT_BYTES_RECEIVED

The number of bytes received as Direct Messages.

Since:

1.0

DIRECT_BYTES_SENT

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_DIRECT_BYTES_SENT")
public static final Manageable.ApiMetrics.Metric DIRECT_BYTES_SENT

The number of the bytes sent as Direct Messages.

Since:

1.0

DIRECT_MESSAGES_RECEIVED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_DIRECT_MSGS_RECVED")
public static final Manageable.ApiMetrics.Metric DIRECT_MESSAGES_RECEIVED

The number of Direct Messages received.

Since:

1.0

DIRECT_MESSAGES_SENT

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_DIRECT_MSGS_SENT")
public static final Manageable.ApiMetrics.Metric DIRECT_MESSAGES_SENT

The number of Direct Messages sent.

Since:

1.0

INTERNAL_DISCARD_NOTIFICATIONS

@MetricsKeyMapping(target=com.solace.messaging.util.internal.NextGenStatType.class,
                   mappedFieldName="INTERNAL_DISCARD_NOTIFICATIONS")
public static final Manageable.ApiMetrics.Metric INTERNAL_DISCARD_NOTIFICATIONS

The number of times discard flag on received messages was set as a result of messages being dropped by configured back-pressure strategy.

Since:

1.0

NONPERSISTENT_BYTES_RECEIVED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_NONPERSISTENT_BYTES_RECVED")
public static final Manageable.ApiMetrics.Metric NONPERSISTENT_BYTES_RECEIVED

A count of bytes received messages with delivery mode NON_PERSISTENT.

Since:

1.0

NONPERSISTENT_BYTES_REDELIVERED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_NONPERSISTENT_BYTES_RESENT")
public static final Manageable.ApiMetrics.Metric NONPERSISTENT_BYTES_REDELIVERED

A count of bytes in messages that were retransmitted to the appliance with delivery mode NON_PERSISTENT

Since:

1.0

NONPERSISTENT_BYTES_SENT

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_NONPERSISTENT_BYTES_SENT")
public static final Manageable.ApiMetrics.Metric NONPERSISTENT_BYTES_SENT

A count of bytes sent with delivery mode NON_PERSISTENT.

Since:

1.0

NONPERSISTENT_MESSAGES_RECEIVED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_NONPERSISTENT_MSGS_RECVED")
public static final Manageable.ApiMetrics.Metric NONPERSISTENT_MESSAGES_RECEIVED

A count of messages received that were acknowledged with delivery mode NON_PERSISTENT, indicating successful delivery to the application.

Since:

1.0

NONPERSISTENT_MESSAGES_REDELIVERED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_NONPERSISTENT_MSGS_RESENT")
public static final Manageable.ApiMetrics.Metric NONPERSISTENT_MESSAGES_REDELIVERED

A count of messages that were retransmitted to the appliance with delivery mode NON_PERSISTENT.

Since:

1.0

NONPERSISTENT_MESSAGES_SENT

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_NONPERSISTENT_MSGS_SENT")
public static final Manageable.ApiMetrics.Metric NONPERSISTENT_MESSAGES_SENT

A count of messages sent with delivery mode NON_PERSISTENT.

Since:

1.0

PERSISTENT_ACKNOWLEDGE_SENT

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_MSGS_RECVED_ACKED")
public static final Manageable.ApiMetrics.Metric PERSISTENT_ACKNOWLEDGE_SENT

The number of the messages received through Guaranteed Messaging that were acknowledged. The acknowledgement indicates successful delivery of the message to the subscribing application.

Since:

1.0

PERSISTENT_BYTES_RECEIVED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_PERSISTENT_BYTES_RECVED")
public static final Manageable.ApiMetrics.Metric PERSISTENT_BYTES_RECEIVED

The number of bytes of Guaranteed (Persistent) Messages received.

Since:

1.0

PERSISTENT_BYTES_REDELIVERED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_PERSISTENT_BYTES_RESENT")
public static final Manageable.ApiMetrics.Metric PERSISTENT_BYTES_REDELIVERED

The number of bytes of Guaranteed Messages that were retransmitted to the event broker.

Since:

1.0

PERSISTENT_BYTES_SENT

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_PERSISTENT_BYTES_SENT")
public static final Manageable.ApiMetrics.Metric PERSISTENT_BYTES_SENT

The number of bytes of Guaranteed Messages sent.

Since:

1.0

PERSISTENT_DUPLICATE_MESSAGES_DISCARDED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_MSGS_DISCARDED_DUPLICATES")
public static final Manageable.ApiMetrics.Metric PERSISTENT_DUPLICATE_MESSAGES_DISCARDED

The number of Guaranteed Messages received which were discarded as duplicate messages.

Since:

1.0

PERSISTENT_MESSAGES_RECEIVED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_PERSISTENT_MSGS_RECVED")
public static final Manageable.ApiMetrics.Metric PERSISTENT_MESSAGES_RECEIVED

The number of bytes of Guaranteed Messages received.

Since:

1.0

PERSISTENT_MESSAGES_REDELIVERED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_PERSISTENT_MSGS_RESENT")
public static final Manageable.ApiMetrics.Metric PERSISTENT_MESSAGES_REDELIVERED

The number of Guaranteed Messages messages that were retransmitted to the event broker.

Since:

1.0

PERSISTENT_MESSAGES_SENT

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_PERSISTENT_MSGS_SENT")
public static final Manageable.ApiMetrics.Metric PERSISTENT_MESSAGES_SENT

The number of Guaranteed Messages sent.

Since:

1.0

PERSISTENT_NO_MATCHING_FLOW_MESSAGES_DISCARDED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_MSGS_DISCARDED_NO_MATCHING_FLOW")
public static final Manageable.ApiMetrics.Metric PERSISTENT_NO_MATCHING_FLOW_MESSAGES_DISCARDED

The number of received Guaranteed Messages that were discarded due to arriving on a message flow that did not match any local open message flows.

Since:

1.0

PERSISTENT_OUT_OF_ORDER_MESSAGES_DISCARDED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_MSGS_DISCARDED_OUTOFORDER")
public static final Manageable.ApiMetrics.Metric PERSISTENT_OUT_OF_ORDER_MESSAGES_DISCARDED

The number of Guaranteed Messages received and discarded for being received in the wrong sequence or order.

Since:

1.0

PUBLISH_INTERNAL_METHOD_CALLED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="TOTAL_SEND_METHOD_CALLED")
public static final Manageable.ApiMetrics.Metric PUBLISH_INTERNAL_METHOD_CALLED

The number of times the client API internal message send methods have been called.

Since:

1.0

PUBLISH_MESSAGE_ERROR_CALLBACKS

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="TOTAL_ERROR_RESPONSE_CALLBACKS")
public static final Manageable.ApiMetrics.Metric PUBLISH_MESSAGE_ERROR_CALLBACKS

The number of published Guaranteed Messages that generated an error response from the event broker.

Since:

1.0

PUBLISH_MESSAGE_OK_CALLBACKS

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="TOTAL_OK_RESPONSE_CALLBACKS")
public static final Manageable.ApiMetrics.Metric PUBLISH_MESSAGE_OK_CALLBACKS

The number of published Guaranteed Messages that generated a confirmed response from the event broker.

Since:

1.0

PUBLISH_MESSAGES_BACKPRESSURE_DISCARDED

@MetricsKeyMapping(target=com.solace.messaging.util.internal.NextGenStatType.class,
                   mappedFieldName="PUBLISH_MESSAGES_BACKPRESSURE_DISCARDED")
public static final Manageable.ApiMetrics.Metric PUBLISH_MESSAGES_BACKPRESSURE_DISCARDED

The number of outgoing messages dropped by the client API due to their publisher being too fast. This statistic tracks Direct messages dropped by very fast publisher due to configured back-pressure strategy for dropping messages.

Since:

1.0

PUBLISH_MESSAGES_TERMINATION_DISCARDED

@MetricsKeyMapping(target=com.solace.messaging.util.internal.NextGenStatType.class,
                   mappedFieldName="PUBLISH_MESSAGES_TERMINATION_DISCARDED")
public static final Manageable.ApiMetrics.Metric PUBLISH_MESSAGES_TERMINATION_DISCARDED

The number of outgoing messages dropped by the client API due to their publisher being stopped. This statistic tracks both Direct and Guaranteed messages dropped by a stopped publisher. Note that not acknowledged guaranteed delivery messages may or may not be published.

Since:

1.0

PUBLISHED_MESSAGES_ACKNOWLEDGED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="RELIABLE_MSGS_SENT_CONFIRMED")
public static final Manageable.ApiMetrics.Metric PUBLISHED_MESSAGES_ACKNOWLEDGED

The total number of Guaranteed Messages sent that were acknowledged by the event broker.

Since:

1.0

PUBLISHED_MESSAGES_REJECTED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="MESSAGES_REJECTED_BY_APPLIANCE")
public static final Manageable.ApiMetrics.Metric PUBLISHED_MESSAGES_REJECTED

The number of messages rejected by the event broker.

Since:

1.0

PUBLISHER_ACKNOWLEDGEMENT_TIMEOUTS

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="TOTAL_ACK_TIMEOUT")
public static final Manageable.ApiMetrics.Metric PUBLISHER_ACKNOWLEDGEMENT_TIMEOUTS

The number of times the acknowledgment timer expired.

Since:

1.0

PUBLISHER_WINDOW_CLOSED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="PUBLISHER_WINDOW_CLOSED")
public static final Manageable.ApiMetrics.Metric PUBLISHER_WINDOW_CLOSED

The number of times an application attempted to enqueue a Guaranteed Message for publishing and found the publisher window full.

High values for this statistic may indicate the publisher flow's window size is too small to accommodate the network transit time.

Since:

1.0

RECEIVED_MESSAGES_BACKPRESSURE_DISCARDED

@MetricsKeyMapping(target=com.solace.messaging.util.internal.NextGenStatType.class,
                   mappedFieldName="RECEIVED_MESSAGES_BACKPRESSURE_DISCARDED")
public static final Manageable.ApiMetrics.Metric RECEIVED_MESSAGES_BACKPRESSURE_DISCARDED

The number of incoming messages dropped by the client API due to their receiver being slow. This statistic tracks Direct messages dropped by non-active (or slow) consumer due to configured back-pressure strategy for dropping messages.

Since:

1.0

RECEIVED_MESSAGES_DISCARDED_INTERNAL

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="MESSAGES_DISCARDED_INTERNAL")
public static final Manageable.ApiMetrics.Metric RECEIVED_MESSAGES_DISCARDED_INTERNAL

The number of incoming messages dropped by the client API due to their receiver being stopped or slow. This statistic tracks both Direct and Guaranteed messages dropped by non-active (or stopped) consumer. Note that guaranteed delivery messages are not lost and are received after the consumer becomes active (or starts) again.

Since:

1.0

RECEIVED_MESSAGES_TERMINATION_DISCARDED

@MetricsKeyMapping(target=com.solace.messaging.util.internal.NextGenStatType.class,
                   mappedFieldName="RECEIVED_MESSAGES_TERMINATION_DISCARDED")
public static final Manageable.ApiMetrics.Metric RECEIVED_MESSAGES_TERMINATION_DISCARDED

The number of incoming messages dropped by the client API due to their receiver being stopped. This statistic tracks both Direct and Guaranteed messages dropped by a stopped consumer. Note that guaranteed delivery messages are not lost and are received after the consumer becomes active (or starts) again.

Since:

1.0

REQUEST_REPLY_REPLIES_DISCARDED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="REPLIES_DISCARDED")
public static final Manageable.ApiMetrics.Metric REQUEST_REPLY_REPLIES_DISCARDED

The number of RequestReply replies discarded because there was no outstanding request. For example request already timed out and delayed reply received.

Since:

1.1

REQUEST_REPLY_REPLIES_RECEIVED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="REPLIES_RECVED")
public static final Manageable.ApiMetrics.Metric REQUEST_REPLY_REPLIES_RECEIVED

The number of RequestReply replies received.

Since:

1.1

REQUEST_REPLY_REQUESTS_SENT

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="REQUESTS_SENT")
public static final Manageable.ApiMetrics.Metric REQUEST_REPLY_REQUESTS_SENT

The number of RequestReply request messages sent.

Since:

1.1

REQUEST_REPLY_REQUESTS_TIMEOUT

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="REQUESTS_TIMED_OUT")
public static final Manageable.ApiMetrics.Metric REQUEST_REPLY_REQUESTS_TIMEOUT

The number of RequestReply request messages timed out.

Since:

1.1

TOTAL_BYTES_RECEIVED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="TOTAL_BYTES_RECVED")
public static final Manageable.ApiMetrics.Metric TOTAL_BYTES_RECEIVED

The number of bytes received in all messages [Direct, Non-Persistent, and Guaranteed (Persistent)].

Since:

1.0

TOTAL_BYTES_SENT

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="TOTAL_BYTES_SENT")
public static final Manageable.ApiMetrics.Metric TOTAL_BYTES_SENT

The number of bytes sent as part of all published messages [Direct, Non-Persistent, and Guaranteed (Persistent)].

Since:

1.0

TOTAL_MESSAGES_RECEIVED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="TOTAL_MSGS_RECVED")
public static final Manageable.ApiMetrics.Metric TOTAL_MESSAGES_RECEIVED

The number of messages received [Direct, Non-Persistent, and Guaranteed (Persistent)].

Since:

1.0

TOTAL_MESSAGES_SENT

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="TOTAL_MSGS_SENT")
public static final Manageable.ApiMetrics.Metric TOTAL_MESSAGES_SENT

A count of all messages internally sent to the event broker. This count includes Direct, Non-Persistent, and Guaranteed (Persistent) messages but does not include control messages.

Since:

1.0

UNKNOWN_PARAMETER_MESSAGES_DISCARDED

@MetricsKeyMapping(target=com.solacesystems.jcsmp.statistics.StatType.class,
                   mappedFieldName="SMF_DISCARDS_UNKNOWN_ELEMENT")
public static final Manageable.ApiMetrics.Metric UNKNOWN_PARAMETER_MESSAGES_DISCARDED

The number of Solace messages discarded due to the presence of an unknown element in the SMF (Solace Message Format) header.

Incoming protocol messages can be discarded due to the presence of unknown elements, such as an unknown protocol or parameter. Note that this statistic includes not only subscriber-bound routed messages, but all dropped SMF protocol messages received by the client API.

Since:

1.0

Method Detail

valueOf

public static Manageable.ApiMetrics.Metric valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

values

public static Manageable.ApiMetrics.Metric[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Manageable.ApiMetrics.Metric c : Manageable.ApiMetrics.Metric.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared