org.hawkular.agent.monitor.storage

Class HawkularStorageAdapter

java.lang.Object

org.hawkular.agent.monitor.storage.HawkularStorageAdapter

All Implemented Interfaces:

AvailStorage, InventoryListener, InventoryStorage, MetricStorage, StorageAdapter

public class HawkularStorageAdapter
extends Object
implements StorageAdapter

Constructor Summary

Constructors

Constructor and Description
HawkularStorageAdapter()

Method Summary

Modifier and Type	Method and Description
AvailDataPayloadBuilder	createAvailDataPayloadBuilder()
MetricDataPayloadBuilder	createMetricDataPayloadBuilder()
MetricTagPayloadBuilder	createMetricTagPayloadBuilder()
<L> void	discoveryCompleted(DiscoveryEvent<L> event) Notifies this listener that a discovery scan has completed.
MonitorServiceConfiguration.StorageAdapterConfiguration	getStorageAdapterConfiguration()
void	initialize(String feedId, MonitorServiceConfiguration.StorageAdapterConfiguration config, Diagnostics diag, HttpClientBuilder httpClientBuilder) Initializes the storage adapter.
<L> void	resourcesAdded(InventoryEvent<L> event) Notifies this listener that the resources in InventoryEvent.getPayload() were added to the monitored endpoint.
<L> void	resourcesRemoved(InventoryEvent<L> event) Notifies this listener that the resources in InventoryEvent.getPayload() were removed from the monitored endpoint.
void	shutdown() Clean up and stop whatever the storage adapter is doing.
void	store(AvailDataPayloadBuilder payloadBuilder, long waitMillis) Stores the availability data found in the given builder.
void	store(MetricDataPayloadBuilder payloadBuilder, long waitMillis) Stores the metric data found in the given builder.
void	store(MetricTagPayloadBuilder payloadBuilder, long waitMillis) Stores the metric tags found in the given builder.
void	storeAvails(Set<AvailDataPoint> datapoints, long waitMillis) Stores the given availability check data points.
void	storeMetrics(Set<MetricDataPoint> datapoints, long waitMillis) Stores the given collected metric data points.

Methods inherited from class java.lang.Object

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

Constructor Detail

HawkularStorageAdapter

public HawkularStorageAdapter()

Method Detail

initialize

public void initialize(String feedId,
                       MonitorServiceConfiguration.StorageAdapterConfiguration config,
                       Diagnostics diag,
                       HttpClientBuilder httpClientBuilder)

Description copied from interface: StorageAdapter

Initializes the storage adapter.

Specified by:

initialize in interface StorageAdapter

Parameters:

feedId - identifies the feed that is storing data

config - the configuration of the storage adapter

diag - the object used to track internal diagnostic data for the storage adapter

httpClientBuilder - used to communicate with the storage server

getStorageAdapterConfiguration

public MonitorServiceConfiguration.StorageAdapterConfiguration getStorageAdapterConfiguration()

Specified by:

getStorageAdapterConfiguration in interface StorageAdapter

Returns:

the storage adapter's configuration settings

createMetricDataPayloadBuilder

public MetricDataPayloadBuilder createMetricDataPayloadBuilder()

Specified by:

createMetricDataPayloadBuilder in interface MetricStorage

Returns:

a builder object suitable for wrapping metric data in a proper payload message format to be sent to the storage backend.

createAvailDataPayloadBuilder

public AvailDataPayloadBuilder createAvailDataPayloadBuilder()

Specified by:

createAvailDataPayloadBuilder in interface AvailStorage

Returns:

a builder object suitable for wrapping availability data in a proper payload message format to be sent to the storage backend.

createMetricTagPayloadBuilder

public MetricTagPayloadBuilder createMetricTagPayloadBuilder()

Specified by:

createMetricTagPayloadBuilder in interface MetricStorage

Returns:

a builder object suitable for wrapping metric tags in a proper payload message format to be sent to the storage backend.

storeMetrics

public void storeMetrics(Set<MetricDataPoint> datapoints,
                         long waitMillis)

Description copied from interface: StorageAdapter

Stores the given collected metric data points. This is an asynchronous call. But if a waitMillis is provided, it indicates the caller is willing to wait up to that amount of milliseconds for the store to complete before returning. Note that if the given data points contain data across multiple tenants, the waitMillis will be the wait time for each storage attempt per tenant (in other words, if you ask to wait 1000 milliseconds and pass in data points for two different tenants, the wait time could be up to 2000 milliseconds because you will wait 1000 for storing the data for tenant 1 and 1000 for storing data for tenant 2).

Specified by:

storeMetrics in interface StorageAdapter

Parameters:

datapoints - the data to be stored

waitMillis - the amount of milliseconds to wait for the store to complete before returning (0==no wait).

store

public void store(MetricDataPayloadBuilder payloadBuilder,
                  long waitMillis)

Description copied from interface: MetricStorage

Stores the metric data found in the given builder. This is an asynchronous call. But if a waitMillis is provided, it indicates the caller is willing to wait up to that amount of milliseconds for the store to complete before returning.

Specified by:

store in interface MetricStorage

Parameters:

payloadBuilder - contains the metric data to store

waitMillis - the amount of milliseconds to wait for the store to complete before returning (0==no wait)

storeAvails

public void storeAvails(Set<AvailDataPoint> datapoints,
                        long waitMillis)

Description copied from interface: StorageAdapter

Stores the given availability check data points. This is an asynchronous call. But if a waitMillis is provided, it indicates the caller is willing to wait up to that amount of milliseconds for the store to complete before returning. Note that if the given data points contain data across multiple tenants, the waitMillis will be the wait time for each storage attempt per tenant (in other words, if you ask to wait 1000 milliseconds and pass in data points for two different tenants, the wait time could be up to 2000 milliseconds because you will wait 1000 for storing the data for tenant 1 and 1000 for storing data for tenant 2).

Specified by:

storeAvails in interface StorageAdapter

Parameters:

datapoints - the data to be stored

waitMillis - the amount of milliseconds to wait for the store to complete before returning (0==no wait).

store

public void store(AvailDataPayloadBuilder payloadBuilder,
                  long waitMillis)

Description copied from interface: AvailStorage

Stores the availability data found in the given builder. This is an asynchronous call. But if a waitMillis is provided, it indicates the caller is willing to wait up to that amount of milliseconds for the store to complete before returning.

Specified by:

store in interface AvailStorage

Parameters:

payloadBuilder - contains the availability data to store

waitMillis - the amount of milliseconds to wait for the store to complete before returning (0==no wait)

store

public void store(MetricTagPayloadBuilder payloadBuilder,
                  long waitMillis)

Description copied from interface: MetricStorage

Stores the metric tags found in the given builder. This is an asynchronous call. But if a waitMillis is provided, it indicates the caller is willing to wait up to that amount of milliseconds for the store to complete before returning.

Specified by:

store in interface MetricStorage

Parameters:

payloadBuilder - contains the metric tags to store

waitMillis - the amount of milliseconds to wait for the store to complete before returning (0==no wait)

resourcesAdded

public <L> void resourcesAdded(InventoryEvent<L> event)

Description copied from interface: InventoryListener

Notifies this listener that the resources in InventoryEvent.getPayload() were added to the monitored endpoint. Note that these resources need to be flushed to persistent storage by calling InventoryListener.discoveryCompleted(DiscoveryEvent) after all resources have been added (or removed).

Specified by:

resourcesAdded in interface InventoryListener

Parameters:

event - the InventoryEvent

resourcesRemoved

public <L> void resourcesRemoved(InventoryEvent<L> event)

Description copied from interface: InventoryListener

Notifies this listener that the resources in InventoryEvent.getPayload() were removed from the monitored endpoint. Note that these resources need to be flushed to persistent storage by calling InventoryListener.discoveryCompleted(DiscoveryEvent) after all resources have been added (or removed).

Specified by:

resourcesRemoved in interface InventoryListener

Parameters:

event - the InventoryEvent

discoveryCompleted

public <L> void discoveryCompleted(DiscoveryEvent<L> event)

Description copied from interface: InventoryListener

Notifies this listener that a discovery scan has completed. The resource tree in DiscoveryEvent.getResourceManager() were updated as part of the completed discovery scan. Make sure you call this after you add and remove resources.

Specified by:

discoveryCompleted in interface InventoryListener

Parameters:

event - the DiscoveryEvent

shutdown

public void shutdown()

Description copied from interface: StorageAdapter

Clean up and stop whatever the storage adapter is doing.

Specified by:

shutdown in interface StorageAdapter