Metrics
extends CloudApiBase
in
implements
CloudApiInterface
Class Metrics
Table of Contents
| $client | ClientInterface | |
|---|---|---|
| getAggregateData() | Retrieves aggregate usage data for an application. | MetricsResponse |
| getAggregateUsageMetrics() | Retrieves aggregate usage metric data for an application. | MetricResponse |
| getDataByEnvironment() | Retrieves usage data for an application, broken down by environment. | MetricsResponse |
| getViewsByEnvironment() | Retrieves views data for an application, broken down by environment. | MetricsResponse |
| getVisitsByEnvironment() | Retrieves visits data for an application, broken down by environment. | MetricsResponse |
| getStackMetricsData() | Returns StackMetrics data for the metrics specified in the filter paramater (e.g., apache-access, web-cpu). | MetricsResponse |
| getStackMetricsDataByMetric() | Returns StackMetrics data for the metric (e.g., apache-access). | MetricResponse |
| __construct() | Client constructor. | mixed |
Properties
$client
protected
ClientInterface
$client
Methods
getAggregateData()
Retrieves aggregate usage data for an application.
public
getAggregateData(
$applicationUuid :
string
)
: MetricsResponse
Parameters
- $applicationUuid : string
Return values
MetricsResponsegetAggregateUsageMetrics()
Retrieves aggregate usage metric data for an application.
public
getAggregateUsageMetrics(
$applicationUuid :
string
, $usageMetric :
string
)
: MetricResponse
Parameters
- $applicationUuid : string
- $usageMetric : string
Return values
MetricResponsegetDataByEnvironment()
Retrieves usage data for an application, broken down by environment.
public
getDataByEnvironment(
$applicationUuid :
string
)
: MetricsResponse
Parameters
- $applicationUuid : string
Return values
MetricsResponsegetViewsByEnvironment()
Retrieves views data for an application, broken down by environment.
public
getViewsByEnvironment(
$applicationUuid :
string
)
: MetricsResponse
Parameters
- $applicationUuid : string
Return values
MetricsResponsegetVisitsByEnvironment()
Retrieves visits data for an application, broken down by environment.
public
getVisitsByEnvironment(
$applicationUuid :
string
)
: MetricsResponse
Parameters
- $applicationUuid : string
Return values
MetricsResponsegetStackMetricsData()
Returns StackMetrics data for the metrics specified in the filter paramater (e.g., apache-access, web-cpu).
public
getStackMetricsData(
$environmentUuid :
string
)
: MetricsResponse
Parameters
- $environmentUuid : string
Return values
MetricsResponsegetStackMetricsDataByMetric()
Returns StackMetrics data for the metric (e.g., apache-access).
public
getStackMetricsDataByMetric(
$environmentUuid :
string
, $metricType :
string
)
: MetricResponse
Parameters
- $environmentUuid : string
- $metricType : string
Return values
MetricResponse__construct()
Client constructor.
public
__construct(
$client :
ClientInterface
)
: mixed
Parameters
- $client : ClientInterface