C.6 MetricsManager MBean API

The MetricsManager facility exposes a small number of methods for disabling and enabling a RRD file creation and update, and for query of both instantaneous and aggregated metric values. The facility also allows a UI to query for information needed for populating a pull-down list that could include, for example, valid metric names for a specified resource or valid aggregation periods for such a metric. The API also currently provides a way to fetch a “running average” of the raw datapoints for a metric (a cached value that does not require a fetch operation from an RRD) and server-side generation of a simple graph of metric data (requires a fetch from an RRD file).

This section includes the following information:

C.6.1 MBean Methods Exposed by the MetricsManager Facility

The following table lists the MBean methods that are exposed by the MetricsManager Facility.

Table C-2 MBean Methods Exposed by the MetricsManager Facility

MBean Method

Description

setMetricsEnabled()

A parameter of false disables the creation or update of RRD files.

getObjectNames()

Returns a list of current deployed metric definitions

update()

Updates RRDs with instantaneous values collected by the Metrics Facility.

getFact()

Given the fully qualified fact name, fetches the value of a specified resource’s fact.

getMetricNames()

Fetches the metric names relevant for a specified resource .

getPeriodNames()

Fetches the names of periods (RRAs) defined for a specified metric.

getRunningAverage()

Fetches the running average of a metric for a specified resource.

getRrdGraphic()

Used by the Orchestration Console to fetch a server-generated ImageIconInfo object.

C.6.2 The MetricsDeployer Facility

The MetricsDeployer deployment facility parses the .metric definition files and creates the associated grid objects that are used to maintain the metadata related to the RRD used for aggregation.