io.apiman.manager.api.core

Interface IMetricsAccessor

All Known Implementing Classes:

NoOpMetricsAccessor

public interface IMetricsAccessor

An interface used to access metrics information. Typically metrics are recorded at runtime by the API Gateway into some sort of data store (e.g. a time series database like influxdb). Implementations of this interface must know how to extract the metrics information in useful and common ways from that data store. So for example there should be an Elasticsearch implementation of this interface that is able to extract metrics recorded in ES.

Author:

eric.wittmann@redhat.com

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.

Method Detail

getUsage

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

Parameters:

organizationId -

serviceId -

version -

interval -

from -

to -

getUsagePerApp

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.

Parameters:

organizationId -

serviceId -

version -

from -

to -

getUsagePerPlan

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. For exclusively public services this will return no data.

Parameters:

organizationId -

serviceId -

version -

from -

to -

getResponseStats

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,

Parameters:

organizationId -

serviceId -

version -

interval -

from -

to -

getResponseStatsSummary

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. Returns a total summary of stats.

Parameters:

organizationId -

serviceId -

version -

from -

to -

getResponseStatsPerApp

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.

Parameters:

organizationId -

serviceId -

version -

from -

to -

getResponseStatsPerPlan

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.

Parameters:

organizationId -

serviceId -

version -

from -

to -

getAppUsagePerService

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. For exclusively public services this will return no data.

Parameters:

organizationId -

applicationId -

version -

from -

to -