io.apiman.manager.api.core.noop

Class NoOpMetricsAccessor

java.lang.Object

io.apiman.manager.api.core.noop.NoOpMetricsAccessor

All Implemented Interfaces:

IMetricsAccessor

@ApplicationScoped
@Alternative
public class NoOpMetricsAccessor
extends Object
implements IMetricsAccessor

A no-op implementaiton of IMetricsAccessor. Useful for situations where no metrics are available.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
NoOpMetricsAccessor() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
io.apiman.manager.api.beans.metrics.AppUsagePerServiceBean	getAppUsagePerService(String organizationId, String applicationId, String version, org.joda.time.DateTime from, org.joda.time.DateTime to) Query the metrics store for # of requests made to a service broken down by plan.
io.apiman.manager.api.beans.metrics.ResponseStatsHistogramBean	getResponseStats(String organizationId, String serviceId, String version, io.apiman.manager.api.beans.metrics.HistogramIntervalType interval, org.joda.time.DateTime from, org.joda.time.DateTime to) Query the metrics store for a histogram of response statistics, including total number of responses, # of error responses,
io.apiman.manager.api.beans.metrics.ResponseStatsPerAppBean	getResponseStatsPerApp(String organizationId, String serviceId, String version, org.joda.time.DateTime from, org.joda.time.DateTime to) Query the metrics store for response type stats (total, errors, failures) for a given service over a specified time range per application.
io.apiman.manager.api.beans.metrics.ResponseStatsPerPlanBean	getResponseStatsPerPlan(String organizationId, String serviceId, String version, org.joda.time.DateTime from, org.joda.time.DateTime to) Query the metrics store for response type stats (total, errors, failures) for a given service over a specified time range per plan.
io.apiman.manager.api.beans.metrics.ResponseStatsSummaryBean	getResponseStatsSummary(String organizationId, String serviceId, String version, org.joda.time.DateTime from, org.joda.time.DateTime to) Query the metrics store for response type stats (total, errors, failures) for a given service over a specified time range.
io.apiman.manager.api.beans.metrics.UsageHistogramBean	getUsage(String organizationId, String serviceId, String version, io.apiman.manager.api.beans.metrics.HistogramIntervalType interval, org.joda.time.DateTime from, org.joda.time.DateTime to) Query the metrics store for the total # of requests made to the service per time period within the date range.
io.apiman.manager.api.beans.metrics.UsagePerAppBean	getUsagePerApp(String organizationId, String serviceId, String version, org.joda.time.DateTime from, org.joda.time.DateTime to) Query the metrics store for # of requests made to a service broken down by Application.
io.apiman.manager.api.beans.metrics.UsagePerPlanBean	getUsagePerPlan(String organizationId, String serviceId, String version, org.joda.time.DateTime from, org.joda.time.DateTime to) Query the metrics store for # of requests made to a service broken down by plan.

Methods inherited from class java.lang.Object

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

Constructor Detail

NoOpMetricsAccessor

public NoOpMetricsAccessor()

Constructor.

Method Detail

getUsage

public io.apiman.manager.api.beans.metrics.UsageHistogramBean getUsage(String organizationId,
                                                              String serviceId,
                                                              String version,
                                                              io.apiman.manager.api.beans.metrics.HistogramIntervalType interval,
                                                              org.joda.time.DateTime from,
                                                              org.joda.time.DateTime to)

Description copied from interface: IMetricsAccessor

Query the metrics store for the total # of requests made to the service per time period within the date range. This will return an array with one entry per bucket in the requested interval, even if the bucket has zero results. So, for example, if the request is for the last 90 days with an interval of 'day', the result will be an array with 90 entries, each entry with a label and a value >= 0.

Specified by:

getUsage in interface IMetricsAccessor

See Also:

io.apiman.manager.api.core.IMetricsAccessor#getUsage(java.lang.String, java.lang.String, java.lang.String, io.apiman.manager.api.beans.metrics.HistogramIntervalType, java.util.Date, java.util.Date)

getUsagePerApp

public io.apiman.manager.api.beans.metrics.UsagePerAppBean getUsagePerApp(String organizationId,
                                                                 String serviceId,
                                                                 String version,
                                                                 org.joda.time.DateTime from,
                                                                 org.joda.time.DateTime to)

Description copied from interface: IMetricsAccessor

Query the metrics store for # of requests made to a service broken down by Application.

Specified by:

getUsagePerApp in interface IMetricsAccessor

See Also:

io.apiman.manager.api.core.IMetricsAccessor#getUsagePerApp(java.lang.String, java.lang.String, java.lang.String, java.util.Date, java.util.Date)

getUsagePerPlan

public io.apiman.manager.api.beans.metrics.UsagePerPlanBean getUsagePerPlan(String organizationId,
                                                                   String serviceId,
                                                                   String version,
                                                                   org.joda.time.DateTime from,
                                                                   org.joda.time.DateTime to)

Description copied from interface: IMetricsAccessor

Query the metrics store for # of requests made to a service broken down by plan. For exclusively public services this will return no data.

Specified by:

getUsagePerPlan in interface IMetricsAccessor

See Also:

io.apiman.manager.api.core.IMetricsAccessor#getUsagePerPlan(java.lang.String, java.lang.String, java.lang.String, java.util.Date, java.util.Date)

getResponseStats

public io.apiman.manager.api.beans.metrics.ResponseStatsHistogramBean getResponseStats(String organizationId,
                                                                              String serviceId,
                                                                              String version,
                                                                              io.apiman.manager.api.beans.metrics.HistogramIntervalType interval,
                                                                              org.joda.time.DateTime from,
                                                                              org.joda.time.DateTime to)

Description copied from interface: IMetricsAccessor

Query the metrics store for a histogram of response statistics, including total number of responses, # of error responses,

Specified by:

getResponseStats in interface IMetricsAccessor

See Also:

IMetricsAccessor.getResponseStats(java.lang.String, java.lang.String, java.lang.String, io.apiman.manager.api.beans.metrics.HistogramIntervalType, org.joda.time.DateTime, org.joda.time.DateTime)

getResponseStatsSummary

public io.apiman.manager.api.beans.metrics.ResponseStatsSummaryBean getResponseStatsSummary(String organizationId,
                                                                                   String serviceId,
                                                                                   String version,
                                                                                   org.joda.time.DateTime from,
                                                                                   org.joda.time.DateTime to)

Description copied from interface: IMetricsAccessor

Query the metrics store for response type stats (total, errors, failures) for a given service over a specified time range. Returns a total summary of stats.

Specified by:

getResponseStatsSummary in interface IMetricsAccessor

See Also:

IMetricsAccessor.getResponseStatsSummary(java.lang.String, java.lang.String, java.lang.String, org.joda.time.DateTime, org.joda.time.DateTime)

getResponseStatsPerApp

public io.apiman.manager.api.beans.metrics.ResponseStatsPerAppBean getResponseStatsPerApp(String organizationId,
                                                                                 String serviceId,
                                                                                 String version,
                                                                                 org.joda.time.DateTime from,
                                                                                 org.joda.time.DateTime to)

Description copied from interface: IMetricsAccessor

Query the metrics store for response type stats (total, errors, failures) for a given service over a specified time range per application.

Specified by:

getResponseStatsPerApp in interface IMetricsAccessor

See Also:

IMetricsAccessor.getResponseStatsPerApp(java.lang.String, java.lang.String, java.lang.String, org.joda.time.DateTime, org.joda.time.DateTime)

getResponseStatsPerPlan

public io.apiman.manager.api.beans.metrics.ResponseStatsPerPlanBean getResponseStatsPerPlan(String organizationId,
                                                                                   String serviceId,
                                                                                   String version,
                                                                                   org.joda.time.DateTime from,
                                                                                   org.joda.time.DateTime to)

Description copied from interface: IMetricsAccessor

Query the metrics store for response type stats (total, errors, failures) for a given service over a specified time range per plan.

Specified by:

getResponseStatsPerPlan in interface IMetricsAccessor

See Also:

IMetricsAccessor.getResponseStatsPerPlan(java.lang.String, java.lang.String, java.lang.String, org.joda.time.DateTime, org.joda.time.DateTime)

getAppUsagePerService

public io.apiman.manager.api.beans.metrics.AppUsagePerServiceBean getAppUsagePerService(String organizationId,
                                                                               String applicationId,
                                                                               String version,
                                                                               org.joda.time.DateTime from,
                                                                               org.joda.time.DateTime to)

Description copied from interface: IMetricsAccessor

Query the metrics store for # of requests made to a service broken down by plan. For exclusively public services this will return no data.

Specified by:

getAppUsagePerService in interface IMetricsAccessor

See Also:

IMetricsAccessor.getAppUsagePerService(java.lang.String, java.lang.String, java.lang.String, org.joda.time.DateTime, org.joda.time.DateTime)