Package org.eso.ias.plugin.publisher.impl

Class KafkaPublisher

java.lang.Object

org.eso.ias.plugin.publisher.PublisherBase

org.eso.ias.plugin.publisher.impl.KafkaPublisher

All Implemented Interfaces:

MonitorPointSender

public class KafkaPublisher
extends PublisherBase

The publisher of monitor point values through Kafka.

KafkaPublisher is an unbuffered publisher because Kafka already does its own buffering and optimizations.

Kafka topic is hardcoded in defaultTopicName property. It delegates to SimpleStringProducer

Author:

acaproni

Nested Class Summary

Nested classes/interfaces inherited from interface org.eso.ias.plugin.publisher.MonitorPointSender

MonitorPointSender.SenderStats

Field Summary

Fields

Modifier and Type	Field	Description
static final String	defaultTopicName	The topic name for kafka publisher (in the actual implementation all the plugins publish on the same topic but each one has its own partition).
static final String	KAFKA_TOPIC_PROP_NAME	The name of the java property to set the kafka topic.
static final String	topicName	The topic name red from the passed property if exists, or the default.

Fields inherited from class org.eso.ias.plugin.publisher.PublisherBase

defaultBufferSize, defaultThrottlingTime, iso8601dateFormat, MAX_BUFFER_SIZE_PROPNAME, maxBufferSize, monitoredSystemId, monitorPoints, monitorPointsSent, numOfErrorsSending, pluginId, publishedMessages, THROTTLING_PROPNAME, throttlingTime

Constructor Summary

Constructors

Constructor	Description
KafkaPublisher(String pluginId, String monitoredSystemId, SimpleStringProducer producer, ScheduledExecutorService executorSvc)	Constructor

Method Summary

Modifier and Type	Method	Description
protected long	publish(MonitorPointData mpData)	Push a monitor point values in the kafka topic and partition.
protected void	shutdown()	Close the kafka producer: does nothing because the kafka producer is shared and the initialization and closed will be done by the owner
protected void	start()	Initializes the kafka producer: does nothing because the kafka producer is shared and the initialization and closed will be done by the owner

Methods inherited from class org.eso.ias.plugin.publisher.PublisherBase

getStats, isClosed, isStopped, mergeProperties, offer, sendMonitoredPointsToIas, setUp, startSending, stopSending, tearDown

Methods inherited from class java.lang.Object

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

Field Details

KAFKA_TOPIC_PROP_NAME

public static final String KAFKA_TOPIC_PROP_NAME

The name of the java property to set the kafka topic.

If not set, defaultTopicName is used.

See Also:

• Constant Field Values

defaultTopicName

public static final String defaultTopicName

The topic name for kafka publisher (in the actual implementation all the plugins publish on the same topic but each one has its own partition).

See Also:

• Constant Field Values

topicName

public static final String topicName

The topic name red from the passed property if exists, or the default.

Constructor Details

KafkaPublisher

public KafkaPublisher(String pluginId,
 String monitoredSystemId,
 SimpleStringProducer producer,
 ScheduledExecutorService executorSvc)

Constructor

Parameters:

pluginId - The identifier of the plugin

monitoredSystemId - The identifier of the system monitored by the plugin

producer - The shared kafka producer

executorSvc - The executor service

Method Details

publish

protected long publish(MonitorPointData mpData)
                throws PublisherException

Push a monitor point values in the kafka topic and partition.

Specified by:

publish in class PublisherBase

Parameters:

mpData - The monitor point data to send to the core of the IAS

Returns:

The number of bytes sent to the core of the IAS

Throws:

PublisherException - In case of error publishing

start

protected void start()
              throws PublisherException

Initializes the kafka producer: does nothing because the kafka producer is shared and the initialization and closed will be done by the owner

Specified by:

start in class PublisherBase

Throws:

PublisherException - Exception returned by the implementer

shutdown

protected void shutdown()
                 throws PublisherException

Close the kafka producer: does nothing because the kafka producer is shared and the initialization and closed will be done by the owner

Specified by:

shutdown in class PublisherBase

Throws:

PublisherException - In case of error shutting down