com.oracle.bmc.hdfs.monitoring

Class OCIMonitorConsumerPlugin

java.lang.Object

com.oracle.bmc.hdfs.monitoring.OCIMonitorConsumerPlugin

Direct Known Subclasses:

DummyOCIMonitoringPlugin, OCIMonitorPlugin

public abstract class OCIMonitorConsumerPlugin
extends Object

This class has to be extended by any plugin, that wants to consume the metrics emitted by OCI HDFS connector.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	bucketName This is the object storage bucket for which the metrics are being emitted for.
protected String	monitoringGroupingID This is the unique identifier defined for grouping monitoring together.
protected String	namespaceName This is the namespace of the bucket in OSS.
protected BmcPropertyAccessor	propertyAccessor This provides a handle to the properties defined for the hdfs connector.

Constructor Summary

Constructors

Constructor and Description
OCIMonitorConsumerPlugin(BmcPropertyAccessor propertyAccessor, String bucketName, String monitoringGroupingID, String namespaceName)

Method Summary

Modifier and Type	Method and Description
abstract void	accept(OCIMetric ociMetric) This method will be called on plugins by the OCI monitoring framework, whenever it wants to emit out a metric.
abstract void	shutdown() This shutdown method will be called on the implementing plugins, whenever the JVM is shutting down.

Methods inherited from class java.lang.Object

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

Field Detail

propertyAccessor

protected BmcPropertyAccessor propertyAccessor

This provides a handle to the properties defined for the hdfs connector.

bucketName

protected String bucketName

This is the object storage bucket for which the metrics are being emitted for.

monitoringGroupingID

protected String monitoringGroupingID

This is the unique identifier defined for grouping monitoring together.

namespaceName

protected String namespaceName

This is the namespace of the bucket in OSS.

Constructor Detail

OCIMonitorConsumerPlugin

public OCIMonitorConsumerPlugin(BmcPropertyAccessor propertyAccessor,
                                String bucketName,
                                String monitoringGroupingID,
                                String namespaceName)

Method Detail

accept

public abstract void accept(OCIMetric ociMetric)

This method will be called on plugins by the OCI monitoring framework, whenever it wants to emit out a metric. This method should finish as quickly as possible, so the consumer of this should ideally handover the ocimetric and stage it elsewhere for processing, instead of trying to deal with it in the accept call itself.

Parameters:

ociMetric - The metric that is being emitted by the OCI HDFS connector

shutdown

public abstract void shutdown()

This shutdown method will be called on the implementing plugins, whenever the JVM is shutting down. It could be used to cleanup, finish pending tasks before exit.