ddf.catalog.metrics

Class CatalogMetrics

java.lang.Object

ddf.catalog.metrics.CatalogMetrics

All Implemented Interfaces:

PostIngestPlugin, PostQueryPlugin, PostResourcePlugin, PreQueryPlugin

public final class CatalogMetrics
extends Object
implements PreQueryPlugin, PostQueryPlugin, PostIngestPlugin, PostResourcePlugin

Catalog plug-in to capture metrics on catalog operations.

Author:

Phillip Klinefelter, ddf.isgs@lmco.com

Field Summary

Fields

Modifier and Type	Field and Description
protected com.codahale.metrics.Meter	comparisonQueries
protected com.codahale.metrics.Meter	createdMetacards
protected com.codahale.metrics.Meter	deletedMetacards
protected com.codahale.metrics.Meter	exceptions
protected static String	EXCEPTIONS_SCOPE
protected com.codahale.metrics.Meter	federatedQueries
protected com.codahale.metrics.Meter	federationExceptions
protected com.codahale.metrics.Meter	functionQueries
protected com.codahale.metrics.Meter	fuzzyQueries
protected static String	INGEST_SCOPE
protected com.codahale.metrics.MetricRegistry	metrics
protected com.codahale.metrics.Meter	queries
protected static String	QUERIES_SCOPE
protected com.codahale.metrics.JmxReporter	reporter
protected static String	RESOURCE_SCOPE
protected com.codahale.metrics.Meter	resourceRetrival
protected com.codahale.metrics.Histogram	resultCount
protected com.codahale.metrics.Meter	sourceUnavailableExceptions
protected com.codahale.metrics.Meter	spatialQueries
protected com.codahale.metrics.Meter	temporalQueries
protected com.codahale.metrics.Meter	unsupportedQueryExceptions
protected com.codahale.metrics.Meter	updatedMetacards
protected com.codahale.metrics.Meter	xpathQueries

Constructor Summary

Constructors

Constructor and Description
CatalogMetrics(FilterAdapter filterAdapter)

Method Summary

Modifier and Type	Method and Description
CreateResponse	process(CreateResponse input) Processes the CreateResponse.
DeleteResponse	process(DeleteResponse input) Processes the DeleteResponse.
QueryRequest	process(QueryRequest input) Processes a QueryRequest prior to execution of the Query.
QueryResponse	process(QueryResponse input) Processes a QueryResponse after the execution of the Query.
ResourceResponse	process(ResourceResponse input) Processes a ResourceResponse after the execution of a getResource operation.
UpdateResponse	process(UpdateResponse input) Processes the UpdateResponse.

Methods inherited from class java.lang.Object

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

Field Detail

EXCEPTIONS_SCOPE

protected static final String EXCEPTIONS_SCOPE

See Also:

Constant Field Values

QUERIES_SCOPE

protected static final String QUERIES_SCOPE

See Also:

Constant Field Values

INGEST_SCOPE

protected static final String INGEST_SCOPE

See Also:

Constant Field Values

RESOURCE_SCOPE

protected static final String RESOURCE_SCOPE

See Also:

Constant Field Values

metrics

protected final com.codahale.metrics.MetricRegistry metrics

reporter

protected final com.codahale.metrics.JmxReporter reporter

resultCount

protected final com.codahale.metrics.Histogram resultCount

exceptions

protected final com.codahale.metrics.Meter exceptions

unsupportedQueryExceptions

protected final com.codahale.metrics.Meter unsupportedQueryExceptions

sourceUnavailableExceptions

protected final com.codahale.metrics.Meter sourceUnavailableExceptions

federationExceptions

protected final com.codahale.metrics.Meter federationExceptions

queries

protected final com.codahale.metrics.Meter queries

federatedQueries

protected final com.codahale.metrics.Meter federatedQueries

comparisonQueries

protected final com.codahale.metrics.Meter comparisonQueries

spatialQueries

protected final com.codahale.metrics.Meter spatialQueries

xpathQueries

protected final com.codahale.metrics.Meter xpathQueries

fuzzyQueries

protected final com.codahale.metrics.Meter fuzzyQueries

functionQueries

protected final com.codahale.metrics.Meter functionQueries

temporalQueries

protected final com.codahale.metrics.Meter temporalQueries

createdMetacards

protected final com.codahale.metrics.Meter createdMetacards

updatedMetacards

protected final com.codahale.metrics.Meter updatedMetacards

deletedMetacards

protected final com.codahale.metrics.Meter deletedMetacards

resourceRetrival

protected final com.codahale.metrics.Meter resourceRetrival

Constructor Detail

CatalogMetrics

public CatalogMetrics(FilterAdapter filterAdapter)

Method Detail

process

public QueryResponse process(QueryResponse input)
                      throws PluginExecutionException,
                             StopProcessingException

Description copied from interface: PostQueryPlugin

Processes a QueryResponse after the execution of the Query.

Specified by:

process in interface PostQueryPlugin

Parameters:

input - the QueryResponse to process

Returns:

the value of the processed QueryResponse to pass to the next PostQueryPlugin, or if this is the last PostQueryPlugin 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.

process

public QueryRequest process(QueryRequest input)
                     throws PluginExecutionException,
                            StopProcessingException

Description copied from interface: PreQueryPlugin

Processes a QueryRequest prior to execution of the Query.

Specified by:

process in interface PreQueryPlugin

Parameters:

input - the QueryRequest to process

Returns:

the value of the processed QueryRequest to pass to the next PreQueryPlugin, or if this is the last PreQueryPlugin 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 CreateResponse process(CreateResponse input)
                       throws PluginExecutionException

Description copied from interface: PostIngestPlugin

Processes the CreateResponse.

Specified by:

process in interface PostIngestPlugin

Parameters:

input - the CreateResponse to process

Returns:

the value of the processed CreateResponse to pass to the next PostIngestPlugin, or if this is the last PostIngestPlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs during processing

process

public UpdateResponse process(UpdateResponse input)
                       throws PluginExecutionException

Description copied from interface: PostIngestPlugin

Processes the UpdateResponse.

Specified by:

process in interface PostIngestPlugin

Parameters:

input - the UpdateResponse to process

Returns:

the value of the processed UpdateResponse to pass to the next PostIngestPlugin, or if this is the last PostIngestPlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs during processing

process

public DeleteResponse process(DeleteResponse input)
                       throws PluginExecutionException

Description copied from interface: PostIngestPlugin

Processes the DeleteResponse.

Specified by:

process in interface PostIngestPlugin

Parameters:

input - the DeleteResponse to process

Returns:

the value of the processed DeleteResponse to pass to the next PostIngestPlugin, or if this is the last PostIngestPlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs during processing

process

public ResourceResponse process(ResourceResponse input)
                         throws PluginExecutionException,
                                StopProcessingException

Description copied from interface: PostResourcePlugin

Processes a ResourceResponse after the execution of a getResource operation.

Specified by:

process in interface PostResourcePlugin

Parameters:

input - the ResourceResponse to process

Returns:

the value of the processed ResourceResponse to pass to the next PostResourcePlugin, or if this is the last PostResourcePlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs while processing the ResourceResponse

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