com.opendxl.databus.producer.metric

Enum ProducerMetricEnum

java.lang.Object

java.lang.Enum<ProducerMetricEnum>

com.opendxl.databus.producer.metric.ProducerMetricEnum

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ProducerMetricEnum>

public enum ProducerMetricEnum
extends java.lang.Enum<ProducerMetricEnum>

ProducerMetricEnum. This class is responsible to list and get a ProducerMetricEnum instance.
ProducerMetricEnum has two fields:

1. name: the Kafka given name for the metric.
2. error: an error message if the metric is not able to be returned.

Enum Constant Summary

Enum Constants

Enum Constant and Description
RECORD_BATCH_SIZE_AVG ProducerMetricEnum per clientId which gets the average batch size
RECORD_BATCH_SIZE_MAX ProducerMetricEnum per clientId which gets the max batch size
RECORD_BYTE_RATE_PER_TOPIC ProducerMetricEnum per clientId and topic which gets the average bytes sent
RECORD_BYTE_TOTAL_PER_TOPIC ProducerMetricEnum per clientId and topic which gets the total bytes sent
RECORD_ERROR_RATE ProducerMetricEnum per clientId which gets the average error
RECORD_ERROR_RATE_PER_TOPIC ProducerMetricEnum per clientId and topic which gets the average error
RECORD_ERROR_TOTAL ProducerMetricEnum per clientId which gets the total error
RECORD_ERROR_TOTAL_PER_TOPIC ProducerMetricEnum per clientId and topic which gets the total errors
RECORD_SEND_RATE ProducerMetricEnum per clientId which gets the average records sent
RECORD_SEND_RATE_PER_TOPIC ProducerMetricEnum per clientId and topic which gets the average records sent
RECORD_SEND_TOTAL ProducerMetricEnum per clientId which gets the total records sent
RECORD_SEND_TOTAL_PER_TOPIC ProducerMetricEnum per clientId and topic which gets the total records sent
RECORD_SIZE_AVG ProducerMetricEnum per clientId which gets the average record size
RECORD_SIZE_MAX ProducerMetricEnum per clientId which gets the max record size

Method Summary

Modifier and Type	Method and Description
java.lang.String	getError() Gets the error message for the ProducerMetricEnum instance
java.lang.String	getName() Gets the error message for the ProducerMetricEnum instance
static ProducerMetricEnum	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ProducerMetricEnum[]	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

RECORD_BATCH_SIZE_MAX

public static final ProducerMetricEnum RECORD_BATCH_SIZE_MAX

ProducerMetricEnum per clientId which gets the max batch size

RECORD_BATCH_SIZE_AVG

public static final ProducerMetricEnum RECORD_BATCH_SIZE_AVG

ProducerMetricEnum per clientId which gets the average batch size

RECORD_SEND_TOTAL

public static final ProducerMetricEnum RECORD_SEND_TOTAL

ProducerMetricEnum per clientId which gets the total records sent

RECORD_SEND_RATE

public static final ProducerMetricEnum RECORD_SEND_RATE

ProducerMetricEnum per clientId which gets the average records sent

RECORD_SIZE_AVG

public static final ProducerMetricEnum RECORD_SIZE_AVG

ProducerMetricEnum per clientId which gets the average record size

RECORD_SIZE_MAX

public static final ProducerMetricEnum RECORD_SIZE_MAX

ProducerMetricEnum per clientId which gets the max record size

RECORD_ERROR_TOTAL

public static final ProducerMetricEnum RECORD_ERROR_TOTAL

ProducerMetricEnum per clientId which gets the total error

RECORD_ERROR_RATE

public static final ProducerMetricEnum RECORD_ERROR_RATE

ProducerMetricEnum per clientId which gets the average error

RECORD_SEND_TOTAL_PER_TOPIC

public static final ProducerMetricEnum RECORD_SEND_TOTAL_PER_TOPIC

ProducerMetricEnum per clientId and topic which gets the total records sent

RECORD_SEND_RATE_PER_TOPIC

public static final ProducerMetricEnum RECORD_SEND_RATE_PER_TOPIC

ProducerMetricEnum per clientId and topic which gets the average records sent

RECORD_ERROR_TOTAL_PER_TOPIC

public static final ProducerMetricEnum RECORD_ERROR_TOTAL_PER_TOPIC

ProducerMetricEnum per clientId and topic which gets the total errors

RECORD_ERROR_RATE_PER_TOPIC

public static final ProducerMetricEnum RECORD_ERROR_RATE_PER_TOPIC

ProducerMetricEnum per clientId and topic which gets the average error

RECORD_BYTE_TOTAL_PER_TOPIC

public static final ProducerMetricEnum RECORD_BYTE_TOTAL_PER_TOPIC

ProducerMetricEnum per clientId and topic which gets the total bytes sent

RECORD_BYTE_RATE_PER_TOPIC

public static final ProducerMetricEnum RECORD_BYTE_RATE_PER_TOPIC

ProducerMetricEnum per clientId and topic which gets the average bytes sent

Method Detail

values

public static ProducerMetricEnum[] 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 (ProducerMetricEnum c : ProducerMetricEnum.values())
    System.out.println(c);

Returns:

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

valueOf

public static ProducerMetricEnum valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getName

public java.lang.String getName()

Gets the error message for the ProducerMetricEnum instance

Returns:

The Kafka given name of the ProducerEnum metric.

getError

public java.lang.String getError()

Gets the error message for the ProducerMetricEnum instance

Returns:

The error message of the ProducerEnum metric if the metric will not able to be obtained.