FunctionStatsManager (Pulsar Functions :: Instance 2.10.0-rc-202111162205 API)

java.lang.Object
- org.apache.pulsar.functions.instance.stats.ComponentStatsManager
- - org.apache.pulsar.functions.instance.stats.FunctionStatsManager

All Implemented Interfaces:: AutoCloseable

public class FunctionStatsManager
extends ComponentStatsManager

Function stats.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`LAST_INVOCATION`
`static String`	`PROCESS_LATENCY_MS`
`static String`	`PROCESS_LATENCY_MS_1min`
`static String`	`PROCESSED_SUCCESSFULLY_TOTAL` Declare metric names
`static String`	`PROCESSED_SUCCESSFULLY_TOTAL_1min`
`static String`	`PULSAR_FUNCTION_METRICS_PREFIX`
`static String`	`RECEIVED_TOTAL`
`static String`	`RECEIVED_TOTAL_1min`
`static String`	`SINK_EXCEPTIONS_TOTAL`
`static String`	`SINK_EXCEPTIONS_TOTAL_1min`
`static String`	`SOURCE_EXCEPTIONS_TOTAL`
`static String`	`SOURCE_EXCEPTIONS_TOTAL_1min`
`static String`	`SYSTEM_EXCEPTIONS_TOTAL`
`static String`	`SYSTEM_EXCEPTIONS_TOTAL_1min`
`static String`	`USER_EXCEPTIONS_TOTAL`
`static String`	`USER_EXCEPTIONS_TOTAL_1min`

Fields inherited from class org.apache.pulsar.functions.instance.stats.ComponentStatsManager
collectorRegistry, EMPTY_QUEUE, exceptionMetricsLabelNames, metricsLabelNames, metricsLabels, scheduledFuture, USER_METRIC_PREFIX

Constructor Summary

Constructors
Constructor and Description
`FunctionStatsManager(FunctionCollectorRegistry collectorRegistry, String[] metricsLabels, ScheduledExecutorService scheduledExecutorService)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSystemException(Throwable ex)`
`void`	`addUserException(Throwable ex)`
`double`	`getAvgProcessLatency()`
`double`	`getAvgProcessLatency1min()`
`double`	`getLastInvocation()`
`com.google.common.collect.EvictingQueue<org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus.ExceptionInformation>`	`getLatestSinkExceptions()`
`com.google.common.collect.EvictingQueue<org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus.ExceptionInformation>`	`getLatestSourceExceptions()`
`double`	`getProcessLatency50P()`
`double`	`getProcessLatency50P1min()`
`double`	`getProcessLatency90P()`
`double`	`getProcessLatency90P1min()`
`double`	`getProcessLatency99_9P()`
`double`	`getProcessLatency99_9P1min()`
`double`	`getProcessLatency99P()`
`double`	`getProcessLatency99P1min()`
`double`	`getTotalProcessedSuccessfully()`
`double`	`getTotalProcessedSuccessfully1min()`
`double`	`getTotalRecordsReceived()`
`double`	`getTotalRecordsReceived1min()`
`double`	`getTotalSysExceptions()`
`double`	`getTotalSysExceptions1min()`
`double`	`getTotalUserExceptions()`
`double`	`getTotalUserExceptions1min()`
`void`	`incrSinkExceptions(Throwable ex)`
`void`	`incrSourceExceptions(Throwable ex)`
`void`	`incrSysExceptions(Throwable sysException)`
`void`	`incrTotalProcessedSuccessfully()`
`void`	`incrTotalReceived()`
`void`	`incrUserExceptions(Throwable userException)`
`void`	`processTimeEnd()`
`void`	`processTimeStart()`
`void`	`reset()`
`void`	`setLastInvocation(long ts)`

Methods inherited from class org.apache.pulsar.functions.instance.stats.ComponentStatsManager
close, getExceptionInfo, getLatestSystemExceptions, getLatestUserExceptions, getStatsAsString, getStatsManager

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PULSAR_FUNCTION_METRICS_PREFIX
```
public static final String PULSAR_FUNCTION_METRICS_PREFIX
```
    See Also:
    
    Constant Field Values
  - PROCESSED_SUCCESSFULLY_TOTAL
```
public static final String PROCESSED_SUCCESSFULLY_TOTAL
```
    Declare metric names
    
    See Also:
    
    Constant Field Values
  - SYSTEM_EXCEPTIONS_TOTAL
```
public static final String SYSTEM_EXCEPTIONS_TOTAL
```
    See Also:
    
    Constant Field Values
  - USER_EXCEPTIONS_TOTAL
```
public static final String USER_EXCEPTIONS_TOTAL
```
    See Also:
    
    Constant Field Values
  - SOURCE_EXCEPTIONS_TOTAL
```
public static final String SOURCE_EXCEPTIONS_TOTAL
```
    See Also:
    
    Constant Field Values
  - SINK_EXCEPTIONS_TOTAL
```
public static final String SINK_EXCEPTIONS_TOTAL
```
    See Also:
    
    Constant Field Values
  - PROCESS_LATENCY_MS
```
public static final String PROCESS_LATENCY_MS
```
    See Also:
    
    Constant Field Values
  - LAST_INVOCATION
```
public static final String LAST_INVOCATION
```
    See Also:
    
    Constant Field Values
  - RECEIVED_TOTAL
```
public static final String RECEIVED_TOTAL
```
    See Also:
    
    Constant Field Values
  - PROCESSED_SUCCESSFULLY_TOTAL_1min
```
public static final String PROCESSED_SUCCESSFULLY_TOTAL_1min
```
    See Also:
    
    Constant Field Values
  - SYSTEM_EXCEPTIONS_TOTAL_1min
```
public static final String SYSTEM_EXCEPTIONS_TOTAL_1min
```
    See Also:
    
    Constant Field Values
  - USER_EXCEPTIONS_TOTAL_1min
```
public static final String USER_EXCEPTIONS_TOTAL_1min
```
    See Also:
    
    Constant Field Values
  - SOURCE_EXCEPTIONS_TOTAL_1min
```
public static final String SOURCE_EXCEPTIONS_TOTAL_1min
```
    See Also:
    
    Constant Field Values
  - SINK_EXCEPTIONS_TOTAL_1min
```
public static final String SINK_EXCEPTIONS_TOTAL_1min
```
    See Also:
    
    Constant Field Values
  - PROCESS_LATENCY_MS_1min
```
public static final String PROCESS_LATENCY_MS_1min
```
    See Also:
    
    Constant Field Values
  - RECEIVED_TOTAL_1min
```
public static final String RECEIVED_TOTAL_1min
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FunctionStatsManager
```
public FunctionStatsManager(FunctionCollectorRegistry collectorRegistry,
                            String[] metricsLabels,
                            ScheduledExecutorService scheduledExecutorService)
```
- Method Detail
  - addUserException
```
public void addUserException(Throwable ex)
```
  - addSystemException
```
public void addSystemException(Throwable ex)
```
  - incrTotalReceived
```
public void incrTotalReceived()
```
    Specified by:
    
    incrTotalReceived in class ComponentStatsManager
  - incrTotalProcessedSuccessfully
```
public void incrTotalProcessedSuccessfully()
```
    Specified by:
    
    incrTotalProcessedSuccessfully in class ComponentStatsManager
  - incrSysExceptions
```
public void incrSysExceptions(Throwable sysException)
```
    Specified by:
    
    incrSysExceptions in class ComponentStatsManager
  - incrUserExceptions
```
public void incrUserExceptions(Throwable userException)
```
    Specified by:
    
    incrUserExceptions in class ComponentStatsManager
  - incrSourceExceptions
```
public void incrSourceExceptions(Throwable ex)
```
    Specified by:
    
    incrSourceExceptions in class ComponentStatsManager
  - incrSinkExceptions
```
public void incrSinkExceptions(Throwable ex)
```
    Specified by:
    
    incrSinkExceptions in class ComponentStatsManager
  - setLastInvocation
```
public void setLastInvocation(long ts)
```
    Specified by:
    
    setLastInvocation in class ComponentStatsManager
  - processTimeStart
```
public void processTimeStart()
```
    Specified by:
    
    processTimeStart in class ComponentStatsManager
  - processTimeEnd
```
public void processTimeEnd()
```
    Specified by:
    
    processTimeEnd in class ComponentStatsManager
  - getTotalProcessedSuccessfully
```
public double getTotalProcessedSuccessfully()
```
    Specified by:
    
    getTotalProcessedSuccessfully in class ComponentStatsManager
  - getTotalRecordsReceived
```
public double getTotalRecordsReceived()
```
    Specified by:
    
    getTotalRecordsReceived in class ComponentStatsManager
  - getTotalSysExceptions
```
public double getTotalSysExceptions()
```
    Specified by:
    
    getTotalSysExceptions in class ComponentStatsManager
  - getTotalUserExceptions
```
public double getTotalUserExceptions()
```
    Specified by:
    
    getTotalUserExceptions in class ComponentStatsManager
  - getLastInvocation
```
public double getLastInvocation()
```
    Specified by:
    
    getLastInvocation in class ComponentStatsManager
  - getAvgProcessLatency
```
public double getAvgProcessLatency()
```
    Specified by:
    
    getAvgProcessLatency in class ComponentStatsManager
  - getProcessLatency50P
```
public double getProcessLatency50P()
```
  - getProcessLatency90P
```
public double getProcessLatency90P()
```
  - getProcessLatency99P
```
public double getProcessLatency99P()
```
  - getProcessLatency99_9P
```
public double getProcessLatency99_9P()
```
  - getTotalProcessedSuccessfully1min
```
public double getTotalProcessedSuccessfully1min()
```
    Specified by:
    
    getTotalProcessedSuccessfully1min in class ComponentStatsManager
  - getTotalRecordsReceived1min
```
public double getTotalRecordsReceived1min()
```
    Specified by:
    
    getTotalRecordsReceived1min in class ComponentStatsManager
  - getTotalSysExceptions1min
```
public double getTotalSysExceptions1min()
```
    Specified by:
    
    getTotalSysExceptions1min in class ComponentStatsManager
  - getTotalUserExceptions1min
```
public double getTotalUserExceptions1min()
```
    Specified by:
    
    getTotalUserExceptions1min in class ComponentStatsManager
  - getAvgProcessLatency1min
```
public double getAvgProcessLatency1min()
```
    Specified by:
    
    getAvgProcessLatency1min in class ComponentStatsManager
  - getLatestSourceExceptions
```
public com.google.common.collect.EvictingQueue<org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus.ExceptionInformation> getLatestSourceExceptions()
```
    Specified by:
    
    getLatestSourceExceptions in class ComponentStatsManager
  - getLatestSinkExceptions
```
public com.google.common.collect.EvictingQueue<org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus.ExceptionInformation> getLatestSinkExceptions()
```
    Specified by:
    
    getLatestSinkExceptions in class ComponentStatsManager
  - getProcessLatency50P1min
```
public double getProcessLatency50P1min()
```
  - getProcessLatency90P1min
```
public double getProcessLatency90P1min()
```
  - getProcessLatency99P1min
```
public double getProcessLatency99P1min()
```
  - getProcessLatency99_9P1min
```
public double getProcessLatency99_9P1min()
```
  - reset
```
public void reset()
```
    Specified by:
    
    reset in class ComponentStatsManager

Class FunctionStatsManager

Field Summary

Fields inherited from class org.apache.pulsar.functions.instance.stats.ComponentStatsManager

Constructor Summary

Method Summary

Methods inherited from class org.apache.pulsar.functions.instance.stats.ComponentStatsManager

Methods inherited from class java.lang.Object

Field Detail

PULSAR_FUNCTION_METRICS_PREFIX

PROCESSED_SUCCESSFULLY_TOTAL

SYSTEM_EXCEPTIONS_TOTAL

USER_EXCEPTIONS_TOTAL

SOURCE_EXCEPTIONS_TOTAL

SINK_EXCEPTIONS_TOTAL

PROCESS_LATENCY_MS

LAST_INVOCATION

RECEIVED_TOTAL

PROCESSED_SUCCESSFULLY_TOTAL_1min

SYSTEM_EXCEPTIONS_TOTAL_1min

USER_EXCEPTIONS_TOTAL_1min

SOURCE_EXCEPTIONS_TOTAL_1min

SINK_EXCEPTIONS_TOTAL_1min

PROCESS_LATENCY_MS_1min

RECEIVED_TOTAL_1min

Constructor Detail

FunctionStatsManager

Method Detail

addUserException

addSystemException

incrTotalReceived

incrTotalProcessedSuccessfully

incrSysExceptions

incrUserExceptions

incrSourceExceptions

incrSinkExceptions

setLastInvocation

processTimeStart

processTimeEnd

getTotalProcessedSuccessfully

getTotalRecordsReceived

getTotalSysExceptions

getTotalUserExceptions

getLastInvocation

getAvgProcessLatency

getProcessLatency50P

getProcessLatency90P

getProcessLatency99P

getProcessLatency99_9P

getTotalProcessedSuccessfully1min

getTotalRecordsReceived1min

getTotalSysExceptions1min

getTotalUserExceptions1min

getAvgProcessLatency1min

getLatestSourceExceptions

getLatestSinkExceptions

getProcessLatency50P1min

getProcessLatency90P1min

getProcessLatency99P1min

getProcessLatency99_9P1min

reset