org.hawkular.agent.monitor.storage

Interface StorageAdapter

All Superinterfaces:

AvailStorage, InventoryListener, InventoryStorage, MetricStorage

All Known Implementing Classes:

HawkularStorageAdapter

public interface StorageAdapter
extends MetricStorage, AvailStorage, InventoryStorage

Method Summary

Modifier and Type	Method and Description
MonitorServiceConfiguration.StorageAdapterConfiguration	getStorageAdapterConfiguration()
void	initialize(String feedId, MonitorServiceConfiguration.StorageAdapterConfiguration config, Diagnostics diag, HttpClientBuilder httpClientBuilder) Initializes the storage adapter.
void	shutdown() Clean up and stop whatever the storage adapter is doing.
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 interface org.hawkular.agent.monitor.api.MetricStorage

createMetricDataPayloadBuilder, createMetricTagPayloadBuilder, store, store

Methods inherited from interface org.hawkular.agent.monitor.api.AvailStorage

createAvailDataPayloadBuilder, store

Methods inherited from interface org.hawkular.agent.monitor.api.InventoryListener

resourcesAdded, resourcesRemoved

Method Detail

initialize

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

Initializes the storage adapter.

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

shutdown

void shutdown()

Clean up and stop whatever the storage adapter is doing.

getStorageAdapterConfiguration

MonitorServiceConfiguration.StorageAdapterConfiguration getStorageAdapterConfiguration()

Returns:

the storage adapter's configuration settings

storeMetrics

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

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).

Parameters:

datapoints - the data to be stored

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

storeAvails

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

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).

Parameters:

datapoints - the data to be stored

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