Package org.apache.pulsar.functions.instance.stats

Class ComponentStatsManager

java.lang.Object

org.apache.pulsar.functions.instance.stats.ComponentStatsManager

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

FunctionStatsManager, SinkStatsManager, SourceStatsManager

public abstract class ComponentStatsManager
extends Object
implements AutoCloseable

Field Summary

Fields

Modifier and Type	Field	Description
protected final FunctionCollectorRegistry	collectorRegistry
protected final com.google.common.collect.EvictingQueue	emptyQueue
protected static final String[]	EXCEPTION_METRICS_LABEL_NAMES
static final String[]	METRICS_LABEL_NAMES
protected String[]	metricsLabels
protected ScheduledFuture<?>	scheduledFuture
static final String	USER_METRIC_PREFIX

Constructor Summary

Constructors

Constructor	Description
ComponentStatsManager(FunctionCollectorRegistry collectorRegistry, String[] metricsLabels, ScheduledExecutorService scheduledExecutorService)

Method Summary

Modifier and Type	Method	Description
void	close()
abstract double	getAvgProcessLatency()
abstract double	getAvgProcessLatency1min()
protected org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus.ExceptionInformation	getExceptionInfo(Throwable th, long ts)
abstract double	getLastInvocation()
abstract com.google.common.collect.EvictingQueue<org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus.ExceptionInformation>	getLatestSinkExceptions()
abstract com.google.common.collect.EvictingQueue<org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus.ExceptionInformation>	getLatestSourceExceptions()
abstract com.google.common.collect.EvictingQueue<org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus.ExceptionInformation>	getLatestSystemExceptions()
abstract com.google.common.collect.EvictingQueue<org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus.ExceptionInformation>	getLatestUserExceptions()
String	getStatsAsString()
static ComponentStatsManager	getStatsManager(FunctionCollectorRegistry collectorRegistry, String[] metricsLabels, ScheduledExecutorService scheduledExecutorService, org.apache.pulsar.functions.proto.Function.FunctionDetails.ComponentType componentType)
abstract double	getTotalProcessedSuccessfully()
abstract double	getTotalProcessedSuccessfully1min()
abstract double	getTotalRecordsReceived()
abstract double	getTotalRecordsReceived1min()
abstract double	getTotalSysExceptions()
abstract double	getTotalSysExceptions1min()
abstract double	getTotalUserExceptions()
abstract double	getTotalUserExceptions1min()
abstract void	incrSinkExceptions(Throwable userException)
abstract void	incrSourceExceptions(Throwable userException)
abstract void	incrSysExceptions(Throwable sysException)
abstract void	incrTotalProcessedSuccessfully()
abstract void	incrTotalReceived()
abstract void	incrUserExceptions(Throwable userException)
abstract void	processTimeEnd()
abstract void	processTimeStart()
abstract void	reset()
abstract void	setLastInvocation(long ts)

Methods inherited from class java.lang.Object

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

Field Details

metricsLabels

protected String[] metricsLabels

scheduledFuture

protected ScheduledFuture<?> scheduledFuture

collectorRegistry

protected final FunctionCollectorRegistry collectorRegistry

emptyQueue

protected final com.google.common.collect.EvictingQueue emptyQueue

USER_METRIC_PREFIX

public static final String USER_METRIC_PREFIX

See Also:

• Constant Field Values

METRICS_LABEL_NAMES

public static final String[] METRICS_LABEL_NAMES

EXCEPTION_METRICS_LABEL_NAMES

protected static final String[] EXCEPTION_METRICS_LABEL_NAMES

Constructor Details

ComponentStatsManager

public ComponentStatsManager(FunctionCollectorRegistry collectorRegistry,
 String[] metricsLabels,
 ScheduledExecutorService scheduledExecutorService)

Method Details

getStatsManager

public static ComponentStatsManager getStatsManager(FunctionCollectorRegistry collectorRegistry,
 String[] metricsLabels,
 ScheduledExecutorService scheduledExecutorService,
 org.apache.pulsar.functions.proto.Function.FunctionDetails.ComponentType componentType)

reset

public abstract void reset()

incrTotalReceived

public abstract void incrTotalReceived()

incrTotalProcessedSuccessfully

public abstract void incrTotalProcessedSuccessfully()

incrSysExceptions

public abstract void incrSysExceptions(Throwable sysException)

incrUserExceptions

public abstract void incrUserExceptions(Throwable userException)

incrSourceExceptions

public abstract void incrSourceExceptions(Throwable userException)

incrSinkExceptions

public abstract void incrSinkExceptions(Throwable userException)

setLastInvocation

public abstract void setLastInvocation(long ts)

processTimeStart

public abstract void processTimeStart()

processTimeEnd

public abstract void processTimeEnd()

getTotalProcessedSuccessfully

public abstract double getTotalProcessedSuccessfully()

getTotalRecordsReceived

public abstract double getTotalRecordsReceived()

getTotalSysExceptions

public abstract double getTotalSysExceptions()

getTotalUserExceptions

public abstract double getTotalUserExceptions()

getLastInvocation

public abstract double getLastInvocation()

getAvgProcessLatency

public abstract double getAvgProcessLatency()

getTotalProcessedSuccessfully1min

public abstract double getTotalProcessedSuccessfully1min()

getTotalRecordsReceived1min

public abstract double getTotalRecordsReceived1min()

getTotalSysExceptions1min

public abstract double getTotalSysExceptions1min()

getTotalUserExceptions1min

public abstract double getTotalUserExceptions1min()

getAvgProcessLatency1min

public abstract double getAvgProcessLatency1min()

getLatestUserExceptions

public abstract com.google.common.collect.EvictingQueue<org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus.ExceptionInformation> getLatestUserExceptions()

getLatestSystemExceptions

public abstract com.google.common.collect.EvictingQueue<org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus.ExceptionInformation> getLatestSystemExceptions()

getLatestSourceExceptions

public abstract com.google.common.collect.EvictingQueue<org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus.ExceptionInformation> getLatestSourceExceptions()

getLatestSinkExceptions

public abstract com.google.common.collect.EvictingQueue<org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus.ExceptionInformation> getLatestSinkExceptions()

getStatsAsString

public String getStatsAsString()
                        throws IOException

Throws:

IOException

getExceptionInfo

protected org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus.ExceptionInformation getExceptionInfo(Throwable th,
 long ts)

close

public void close()

Specified by:

close in interface AutoCloseable