Heatmap

The heatmap visualization displays either unacknowledged alarms or ongoing outages, depending on its configuration. You can apply each of these visualizations to categories, foreign sources, or node services.

The size of an entity is calculated by counting the services inside of the entity. Thus, a node with fewer services is displayed as a smaller box than one with more services.

The heatmap feature is deactivated by default, and is configured in opennms.properties.

Figure 1. Heatmap visualization of outages; the smallest entity reports an ongoing outage

Configuration properties

Name Description Type Default

Name	Description	Type	Default
org.opennms.heatmap.defaultMode	The default visualization mode for the heatmap. There are two options: `alarms` and `outages.`	String	`alarms`
org.opennms.heatmap.defaultHeatmap	The default category for the heatmap. There are three options: `categories`, `foreignSources`, and `monitoredServices`.	String	`categories`
org.opennms.heatmap.categoryFilter	The category filter for the heatmap. This parameter uses the Java regular expression syntax. By default, all categories are displayed.	String	`.*`
org.opennms.heatmap.foreignSourceFilter	The foreign source filter for the heatmap. This parameter uses the Java regular expression syntax. By default, all foreign sources are displayed.	String	`.*`
org.opennms.heatmap.serviceFilter	The services filter for the heatmap. This parameter uses the Java regular expression syntax. By default, all services are displayed.	String	`.*`
org.opennms.heatmap.onlyUnacknowledged	Controls the scope of alarms to be taken into account when generating the alarms heatmap. By default, only unacknowledged alarms are evaluated.	Boolean	`false`
org.opennms.web.console.centerUrl	Defines the URL for the heatmap. You can place the heatmap on the landing page by setting this parameter to `/heatmap/heatmap-box.jsp`.	String	`/surveillance-box.jsp`

org.opennms.heatmap.defaultMode

The default visualization mode for the heatmap. There are two options: alarms and outages.

String

alarms

org.opennms.heatmap.defaultHeatmap

The default category for the heatmap. There are three options: categories, foreignSources, and monitoredServices.

String

categories

org.opennms.heatmap.categoryFilter

The category filter for the heatmap. This parameter uses the Java regular expression syntax. By default, all categories are displayed.

String

.*

org.opennms.heatmap.foreignSourceFilter

The foreign source filter for the heatmap. This parameter uses the Java regular expression syntax. By default, all foreign sources are displayed.

String

.*

org.opennms.heatmap.serviceFilter

The services filter for the heatmap. This parameter uses the Java regular expression syntax. By default, all services are displayed.

String

.*

org.opennms.heatmap.onlyUnacknowledged

Controls the scope of alarms to be taken into account when generating the alarms heatmap. By default, only unacknowledged alarms are evaluated.

Boolean

false

org.opennms.web.console.centerUrl

Defines the URL for the heatmap. You can place the heatmap on the landing page by setting this parameter to /heatmap/heatmap-box.jsp.

String

/surveillance-box.jsp

You can use negative lookahead expressions to exclude categories from the heatmap. For example, use ^(?!XY).* to filter out entities with names starting with XY.