com.sonicsw.mf.framework.monitor.offload.spi

Interface IAnalyticsOffload

All Known Implementing Classes:

SinkOffload

public interface IAnalyticsOffload

The Analytics Offload SPI provides the means by which developers can write plugins that divert metric and notifications collected by a Collections Monitor component directly into a third party big-data/analytics engine. This data diversion bypasses the normal internal storage mechanisms used by Collections Monitor, providing performance benefits, more direct and easier integration with third party engines. The Analytics Offload SPI consists primarily of the com.sonicsw.mf.framework.monitor.offload.spi.IAnalyticsOffload. It leverages the standard Java service provider extension mechanism for class-path introduced extensions. To deploy a plugin, build the implementation and import jars and dependencies into the Sonic Directory Service. Configure the Collections Monitor component resources pre-pend classpath to include the jars. Alternatively, jars may be included in the Management Framework Container pre-pend classpath. Ensure that one of the jars contains a META-INF/services/com.sonicsw.mf.framework.monitor.offload.spi.IAnalyticsOffload entry. This file must contain a single text line that identifies the fully qualified class name of the implementation class. Restart the MF Container

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Destroy the offload provider - called on Collections Monitor termination and cleanup.
void	init() Open the offload provider - called on Collections Monitor initialization
void	offloadMetrics(com.sonicsw.mf.common.metrics.IMetric[] metrics, com.sonicsw.mf.common.runtime.ICanonicalName source) Offload collected metrics from a source component
void	offloadNotification(com.sonicsw.mf.common.runtime.INotification notification) Offload a notification
void	start() Start the offload provider - called on Collections Monitor start.
void	stop() Stop the offload provider - called on Collections Monitor stop.

Method Detail

init

void init()
          throws AnalyticsOffloadException

Open the offload provider - called on Collections Monitor initialization

Throws:

AnalyticsOffloadException

destroy

void destroy()
             throws AnalyticsOffloadException

Destroy the offload provider - called on Collections Monitor termination and cleanup.

Throws:

AnalyticsOffloadException

start

void start()
           throws AnalyticsOffloadException

Start the offload provider - called on Collections Monitor start.

Throws:

AnalyticsOffloadException

stop

void stop()
          throws AnalyticsOffloadException

Stop the offload provider - called on Collections Monitor stop.

Throws:

AnalyticsOffloadException

offloadNotification

void offloadNotification(com.sonicsw.mf.common.runtime.INotification notification)
                         throws AnalyticsOffloadException

Offload a notification

Parameters:

notification -

Throws:

AnalyticsOffloadException

offloadMetrics

void offloadMetrics(com.sonicsw.mf.common.metrics.IMetric[] metrics,
                  com.sonicsw.mf.common.runtime.ICanonicalName source)
                    throws AnalyticsOffloadException

Offload collected metrics from a source component

Parameters:

metrics -

source - component canonical name

Throws:

AnalyticsOffloadException