Metric Configuration files can be a very useful tool to predefine the metric charts or scoreboard alerts you want to show on your custom dashboards. (see the famous One Click Cluster Capacity Dashboard)
First of all you need to create a custom XML file that will contain the metrics you want to display. This can include a combination of data sources, i.e. VM, Host, Cluster, etc. The widgets are clever enough to only display back the information that the source is filtered on, if any widget interaction is created on your dashboard
Each file needs to have the exact metric name, which can often be different from the display name, so this needs to be discovered. I have detailed one way below using the vROps API. This does not need any real programming experience in using APIs the commands can easily put into your browser to return the results.
First Step is to create a new custom xml that will be used on your dashboard.
The standard format is
- <AdapterKind adapterKindKey=”VMWARE”> (defined by the adapter the metric is collected from this is the standard vcenter one)
- <ResourceKind resourceKindKey=”HostSystem”> (defined as the object type you want to get the metrics from)
- <Metric attrkey=”@”( This is the metrics you want to report on ) label=”@” (label used to display free text), unit=”@” (How you want to report can be used to convert KB metric to display in GB), yellow.orange,red, values when in a scoreboard widget the object changes colour, value is dependent on metric collected and your own SLAs>
- </AdapterKind >
- </AdapterKinds >
You can multiple metric values and resource kinds in one file. The same file can be used in metric charts and scoreboards. Scoreboards will only show the colours.
CREATING THE XML FILE
With vROps 6.03 and above this can be created in the User Interface
- Under Content | Manage Metric Config
- Open up the folder ReskandMetric and highlight it
- Copy the content of sample.xml to give the base template for further editing.
- Create a file “test.xml” by clicking on the small Green Plus Symbol (test.xml, can be replaced with any text easier to remember, the .xml bit is important!)
- Then past the content from the sample.xml into the Text.xml file, and save the change (Save is in the bottom right corner). If you need to edit this file, then highlight it and click on the small pencil icon.
FIND THE ADAPTERKIND AND RESOURCEKIND VALUES
To get the AdapterKinds kindkey and resource kindkey you can use the following URL. In the example below you see
<ops:resourceKinds=“subojects of VMWARE”>
FIND THE METRIC ATTRKEY VALUES
If you want to find the display name of any metric , in vROps through Environment, browse to a object in this case a host system | CPU Usage %
- Then under the TroubleShooting tab, All metrics, then find the relevant metric, in this case CPU Usage %
Then back to the API View we need to find the statkeys for this object. So use the following URL
- Then do a search for the UI Name in this case CPU|Usage
- You will see the <ops:name> is the name displayed in the UI
- The <ops:key> is the true metric key used the XML File
- <ops:unit> shows the unit the metric is measured on.
Then edit your text.xml file to remove unrequired lines to just show the following
CREATE A DASHBOARD USING THE XML FILE
To use the file create a new dashboard.
In this example create
- An Object List and filtered by HostSystem
- Then add metric chart and select the test.xml file as the Metric Configuration value
- Then add a Scoreboard and select the test.xml file as the Metric Configuration value, it can be formated as required with the options to the right, I normally show the sparkline and use the new Visual Theme
- Select the Widget interaction, so Metric Chart and Scoreboard are updated with values from the Object list, so the CPU Usage is updated on the metric chart and the scoreboard when one host is selected from the Object list.