ddf.catalog.source

Interface SourceMetrics

public interface SourceMetrics

The interface SourceMetrics used by the FederationStrategy to update metrics on individual Sources as queries and exceptions occur when the Source is accessed.

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

Author:

rodgersh

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXCEPTIONS_SCOPE Name of the JMX MBean scope for source-level metrics tracking exceptions while querying a specific Source
static String	MBEAN_PACKAGE_NAME Package name for the JMX MBean where metrics for Sources are stored.
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

Method Summary

Modifier and Type	Method and Description
void	updateMetric(String sourceId, String metricName, int incrementAmount) Update a source-level metric.

Field Detail

MBEAN_PACKAGE_NAME

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

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

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

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

Method Detail

updateMetric

void updateMetric(String sourceId,
                  String metricName,
                  int incrementAmount)

Update a source-level metric.

Parameters:

sourceId - ID of the Source to update metrics for

metricName - name of the metric to update

incrementAmount - amount to increment the metric's count by