Package de.iip_ecosphere.platform.monitoring

Class MonitoringReceiver

java.lang.Object

de.iip_ecosphere.platform.monitoring.MonitoringReceiver

public abstract class MonitoringReceiver
extends Object

Observes IIP-Ecosphere standard transport channels and prepares the information for feeding it into the monitoring system. This class assumes that Transport is set up.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	MonitoringReceiver.Exporter	An instance holding meters for update performing the export when needed, e.g., upon request or by timer.
private class	MonitoringReceiver.MeterReceptionCallback	A meter reception callback for receiving meter information from services or ECS runtime.
private class	MonitoringReceiver.StatusReceptionCallback	Receives status messages such as starting/stopping devices, containers, services.

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String,MonitoringReceiver.Exporter>	registry

Constructor Summary

Constructors

Constructor	Description
MonitoringReceiver()

Method Summary

Modifier and Type	Method	Description
protected abstract MonitoringReceiver.Exporter	createExporter(String id)	Creates an exporter instance.
Iterable<MonitoringReceiver.Exporter>	exporters()	Returns the exporters.
protected void	notifyExporterAdded(MonitoringReceiver.Exporter exporter)	Notifies about a added exporter.
protected void	notifyExporterRemoved(MonitoringReceiver.Exporter exporter)	Notifies about a removed exporter.
protected void	notifyMeterAdded(de.iip_ecosphere.platform.support.metrics.Meter meter)	Is called when a meter was added.
protected void	notifyMeterReception(String stream, String id, de.iip_ecosphere.platform.support.json.JsonObject obj)	Is called when a meter information was received via transport.
protected void	notifyStatusReceived(de.iip_ecosphere.platform.transport.status.StatusMessage msg)	Is called when a status information was received via transport.
protected MonitoringReceiver.Exporter	obtainExporter(String id)	Obtains an exporter for the given source id.
void	start()	Starts the exporter.
void	stop()	Stops the exporter.

Methods inherited from class java.lang.Object

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

Field Details

registry

private Map<String,MonitoringReceiver.Exporter> registry

Constructor Details

MonitoringReceiver

public MonitoringReceiver()

Method Details

obtainExporter

protected MonitoringReceiver.Exporter obtainExporter(String id)

Obtains an exporter for the given source id. Creates and registers a new one if required.

Parameters:

id - the object id

Returns:

the exporter

createExporter

protected abstract MonitoringReceiver.Exporter createExporter(String id)

Creates an exporter instance.

Parameters:

id - the id of origin

Returns:

the exporter instance

notifyMeterReception

protected void notifyMeterReception(String stream,
 String id,
 de.iip_ecosphere.platform.support.json.JsonObject obj)

Is called when a meter information was received via transport. [testing, debugging]

Parameters:

stream - the transport stream/channel

id - the id

obj - the received object

notifyStatusReceived

protected void notifyStatusReceived(de.iip_ecosphere.platform.transport.status.StatusMessage msg)

Is called when a status information was received via transport. [testing, debugging]

Parameters:

msg - the status message

notifyMeterAdded

protected void notifyMeterAdded(de.iip_ecosphere.platform.support.metrics.Meter meter)

Is called when a meter was added. [testing, debugging]

Parameters:

meter - the meter

notifyExporterAdded

protected void notifyExporterAdded(MonitoringReceiver.Exporter exporter)

Notifies about a added exporter.

Parameters:

exporter - the exporter

notifyExporterRemoved

protected void notifyExporterRemoved(MonitoringReceiver.Exporter exporter)

Notifies about a removed exporter.

Parameters:

exporter - the exporter

start

public void start()

Starts the exporter.

stop

public void stop()

Stops the exporter.

exporters

public Iterable<MonitoringReceiver.Exporter> exporters()

Returns the exporters.

Returns:

the exporters