ddf.catalog.metrics.source

Class SourceMetricsImpl

java.lang.Object

ddf.catalog.metrics.source.SourceMetricsImpl

All Implemented Interfaces:

PostFederatedQueryPlugin, PreFederatedQueryPlugin

public class SourceMetricsImpl
extends Object
implements PreFederatedQueryPlugin, PostFederatedQueryPlugin

This class manages the metrics for individual CatalogProvider and FederatedSource Sources. These metrics currently include the count of queries, results per query, and exceptions per Source.

The metrics and their associated JmxCollectors are created when the Source is created and deleted when the Source is deleted. (The associated RRD file remains available indefinitely and accessible from the Metrics tab in the Web Admin console unless an administrator manually deletes it).

If a Source is renamed, i.e., its ID changed, then the Source's existing metrics' MBeans and JmxCollectors are deleted and new metrics created using the new Source 's ID. However, the RRD file for the Source's previous source ID remains available and accessible from the Metrics tab in the Web Admin console unless an administrator manually deletes it.

Author:

rodgersh, ddf.isgs@lmco.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SourceMetricsImpl.SourceMetric Inner class POJO to maintain details of each metric for each Source.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COUNT_MBEAN_ATTRIBUTE_NAME
static String	DERIVE_DATA_SOURCE_TYPE
static String	EXCEPTIONS_SCOPE Name of the JMX MBean scope for source-level metrics tracking exceptions while querying a specific Source
static String	GAUGE_DATA_SOURCE_TYPE
static String	MBEAN_PACKAGE_NAME Package name for the JMX MBean where metrics for Sources are stored.
static String	MEAN_MBEAN_ATTRIBUTE_NAME
protected Map<String,SourceMetricsImpl.SourceMetric>	metrics
static String	QUERIES_SCOPE Name of the JMX MBean scope for source-level metrics tracking query count while querying a specific Source
static String	QUERIES_TOTAL_RESULTS_SCOPE Name of the JMX MBean scope for source-level metrics tracking total results returned while querying a specific Source

Constructor Summary

Constructors

Constructor and Description
SourceMetricsImpl()

Method Summary

Modifier and Type	Method and Description
void	addingSource(Source source, Map props) Creates metrics for new CatalogProvider or FederatedSource when they are initially created.
void	deletingSource(Source source, Map props) Deletes metrics for existing CatalogProvider or FederatedSource when they are deleted.
void	destroy()
List<CatalogProvider>	getCatalogProviders()
List<FederatedSource>	getFederatedSources()
protected String	getRrdFilename(String sourceId, String collectorName)
void	init()
QueryResponse	process(QueryResponse input) Processes a QueryResponse after the execution of the Federated Query.
QueryRequest	process(Source source, QueryRequest input) Processes a QueryRequest prior to execution of the Federated Query.
void	setCatalogProviders(List<CatalogProvider> catalogProviders)
void	setFederatedSources(List<FederatedSource> federatedSources)
void	updateMetric(String sourceId, String name, int incrementAmount)

Methods inherited from class java.lang.Object

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

Field Detail

MBEAN_PACKAGE_NAME

public static final String MBEAN_PACKAGE_NAME

Package name for the JMX MBean where metrics for Sources are stored.

See Also:

Constant Field Values

EXCEPTIONS_SCOPE

public static final String EXCEPTIONS_SCOPE

Name of the JMX MBean scope for source-level metrics tracking exceptions while querying a specific Source

See Also:

Constant Field Values

QUERIES_SCOPE

public static final String QUERIES_SCOPE

Name of the JMX MBean scope for source-level metrics tracking query count while querying a specific Source

See Also:

Constant Field Values

QUERIES_TOTAL_RESULTS_SCOPE

public static final String QUERIES_TOTAL_RESULTS_SCOPE

Name of the JMX MBean scope for source-level metrics tracking total results returned while querying a specific Source

See Also:

Constant Field Values

DERIVE_DATA_SOURCE_TYPE

public static final String DERIVE_DATA_SOURCE_TYPE

See Also:

Constant Field Values

GAUGE_DATA_SOURCE_TYPE

public static final String GAUGE_DATA_SOURCE_TYPE

See Also:

Constant Field Values

COUNT_MBEAN_ATTRIBUTE_NAME

public static final String COUNT_MBEAN_ATTRIBUTE_NAME

See Also:

Constant Field Values

MEAN_MBEAN_ATTRIBUTE_NAME

public static final String MEAN_MBEAN_ATTRIBUTE_NAME

See Also:

Constant Field Values

metrics

protected Map<String,SourceMetricsImpl.SourceMetric> metrics

Constructor Detail

SourceMetricsImpl

public SourceMetricsImpl()

Method Detail

getCatalogProviders

public List<CatalogProvider> getCatalogProviders()

setCatalogProviders

public void setCatalogProviders(List<CatalogProvider> catalogProviders)

getFederatedSources

public List<FederatedSource> getFederatedSources()

setFederatedSources

public void setFederatedSources(List<FederatedSource> federatedSources)

init

public void init()

destroy

public void destroy()

process

public QueryRequest process(Source source,
                            QueryRequest input)
                     throws PluginExecutionException,
                            StopProcessingException

Description copied from interface: PreFederatedQueryPlugin

Processes a QueryRequest prior to execution of the Federated Query.

Specified by:

process in interface PreFederatedQueryPlugin

Parameters:

source - the Source the query will be sent to

input - the QueryRequest to process

Returns:

the value of the processed QueryRequest to pass to the next PreFederatedQueryPlugin, or if this is the last PreFederatedQueryPlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs while processing the QueryRequest

StopProcessingException - thrown to halt processing when a critical issue occurs during processing. This is intended to prevent other plugins from processing as well.

process

public QueryResponse process(QueryResponse input)
                      throws PluginExecutionException,
                             StopProcessingException

Description copied from interface: PostFederatedQueryPlugin

Processes a QueryResponse after the execution of the Federated Query.

Specified by:

process in interface PostFederatedQueryPlugin

Parameters:

input - the Federated QueryResponse to process

Returns:

the value of the processed QueryResponse to pass to the next PostFederatedQueryPlugin, or if this is the last PostFederatedQueryPlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs while processing the QueryResponse

StopProcessingException - thrown to halt processing when a critical issue occurs during processing. This is intended to prevent other plugins from processing as well.

updateMetric

public void updateMetric(String sourceId,
                         String name,
                         int incrementAmount)

addingSource

public void addingSource(Source source,
                         Map props)

Creates metrics for new CatalogProvider or FederatedSource when they are initially created. Metrics creation includes the JMX MBeans and associated ddf.metrics.collector.JmxCollector.

Parameters:

source -

props -

deletingSource

public void deletingSource(Source source,
                           Map props)

Deletes metrics for existing CatalogProvider or FederatedSource when they are deleted. Metrics deletion includes the JMX MBeans and associated ddf.metrics.collector.JmxCollector.

Parameters:

source -

props -

getRrdFilename

protected String getRrdFilename(String sourceId,
                                String collectorName)