Chat now with support
Chat with Support

Foglight 5.9.2 - Web Component Guide

Introducing the Web Component Framework The Web Component Framework Configuring Views and Context Queries Functions Bindings Additional Components

Configuration details

The following diagrams indicate the components of the Alarm dialog box that need to be configured in the alarm association. Use the guidelines provided below when configuring these components in an alarm association.

Figure 45. Alarm dialog box

1
This text comes from the first line of the alarm description. The description is parsed up until the first space following a period. The second line is the text that comes after the first space following a period.
 
* 
IMPORTANT: Keep this in mind when writing alarm descriptions. An alarm description should follow this format and have at least two sentences.
2
The object in this image is the topologyObject property of the alarm. If the object does not have a parent (if it is the Domain Root, which is the parent that appears), then only that object appears in the centre of the space.
3
The Recent History view is the view to which the Small Detail View property is mapped. There is no default if this is not specified. The space allows for a small detail view whose height should be no more than 130 px.
4
The elements affected here are determined by the parents and services to which the topologyObject belongs.
5
The alarm association description. There is no default if this is not specified.
6
These diagnostics are customizable associations. You must provide a name and description for each. It is best to provide a few diagnostics, but too many can result in an overhead and as such be counter-productive. The Diagnose button takes its view from the Diagnosis property. If none is provided, the button does not appear. This property is optional.
Figure 46. Recent History view, History table, and Notes table
7
The Recent History view on the History/Notes tab is the view to which the Large Detail View property is mapped. It has similar height restrictions to the Small Detail View (130 px, see Step 3), but can be wider. This can be the same view as the Small Detail View, or a different view containing alarm metrics. The contents of the selected view should be compatible with the title (Recent History). In cases where the small view is flexible then the view to which the small view is mapped can be mapped to the large detail view as well. The large view should also be compatible with the title (Recent History).
8
The History table is the standard list containing alarm instances, and appears by default.
9
The Notes table is the standard list containing user-defined notes, and appears by default.
Figure 47. History and Notes tables
10
On the Source tab, the Agent and Agent Type entries in the Agent view contain the agent name and its type, and appear by default. The section containing the Running State, Health State, and Host entries also appears by default, and can be replaced by setting the Agent Detail View property. To populate this view, ensure that the agent is set as the monitoring agent for each entity it monitors.
 
* 
TIP: The Alarm dialog box looks for the agent under <alarm>/topologyObject/monitoringAgent.
11
The Rule view appears by default.

Configuration example

The following images show a sample configuration of an alarm association.

Figure 48. Alarm association example, General tab

 
* 
TIP: Context help is optional, but often very useful.
Figure 49. Alarm association example, Context tab

 
* 
TIP: Passing the alarm is useful in most cases, especially when you link the alarm to specified views.
Figure 50. Alarm association example, Configuration tab

 
* 
TIP: The Rule ID is mandatory, otherwise the browser interface fails to match up the association to its alarm.
 
* 
NOTE: The Description property is useful for verbose background information.

The Small Detail View maps to the Recent History view appearing on the Summary tab.

The Large Detail View maps to the Recent History view appearing on the History/Notes tab.

This example contains a mix of required and optional settings. Not all of the optional settings are set. For example, the Agent Detail View property is not set, which results in the Agent view showing the default entries.

Renderers

Configuring how data is displayed in a dashboard is determined in the view definition, but relies on the existence of renderers, icons, and mappings that are configured separately from the view.

Renderers are created and configured in the Renderers tab in the Module Contents pane. Renderers determine the display of data. For example, the number of decimal places shown by a value inside a table cell is decided by a Number Renderer instance, the display of data as an icon is determined by an Icon Renderer instance, and the display of a metric as a time plot chart is configured using a Sparkline Renderer instance.

At runtime, how data in a Foglight™ dashboard displays depends on which renderers are set in the view definition and which renderer has been mapped to a data value's type, property, or unit. Renderers can be mapped to types and properties in the Types tab or to units in the Units tab. Mapped renderers are looked up automatically at runtime if no specific renderer has been set in the view definition.

Default Renderer can be Overridden

All the units and also some types supported by Foglight Core are associated with a default renderer. These associations can be found in the Module Definitions pane modules under the Units and Types tabs. For example, a percent unit is associated with the Percent Renderer.

To define a new renderer:
1
In the Module List pane, select the module that should contain the renderer.
2
Select the Renderers tab in the Module Contents pane.
3
Click the Add button and choose either a Blank renderer or a Copy of an existing renderer.
If you choose a blank renderer, select one from the Type drop-down list.
A New Renderer tab appears in the Definitions pane.
4
In the General tab, give the new renderer a name and supply an appropriate description.
5
Select the Configuration tab and set the appropriate properties for the new renderer.
6
Click Save.
The new renderer is added to the selected module.
 
* 
IMPORTANT: You can define a new renderer to override the default settings an existing renderer. For example, the default text renderer has the Support Newlines property set to false. If you need newlines, set the property to true. The cost is a slight slowdown in rendering.
To associate the renderer with a data type:
1
In the Module List pane, select the module that should contain the renderer.
2
Select the Types tab in the Module Contents pane.
3
Click the Add button.
The New Type Mapping dialog box appears.
4
Select the desired data type in the drop-down list, and then click OK.
A New Type Mapping tab appears in the Definitions pane.
5
Select its Renderers tab.
6
In the left pane underneath this tab, select the same renderer type that you chose in the previous procedure.
7
In the Renderer drop-down list, select from the Available Renderers dialog box the renderer that you defined previously. Click Save in the dialog box.
8
Click Apply in the editor pane.
9
Click Save.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating