Skip to content

WombatOAM Dashboard

WombatOAM's monitoring features are accessible from the web dashboard. You can use the dashboard to manage nodes, and view metrics, notifications and alarms. The following is an overview of WombatOAM's monitoring features, with details about how to access these features, where relevant.

Topology

Topology is an entry point for all tools that allow you to inspect and monitor a node as a whole.

  • Add nodes: Topology+ button. If you select the "Discover connected nodes" checkbox, after adding the node a popup window will appear where you can chose which nodes you want to add to WombatOAM. Only those nodes appear which are in the same cluster as the previously added node.
  • View node information: Topology → select a node → Node infromation.
  • View family information: Topology → select a node family → Family information.
  • View Agents information, agent state, and turn agents on or off.
  • Remove nodes or node families: TopologyManage nodes

Metrics

Metrics are useful for recognising trends and troubleshooting systems if failure occurs. Nodes are grouped by families, so you can view metrics for a family or for individual nodes. Different metrics can be combined on the same graph.

  • View metrics: Metrics → select a node → select a metric. A new data point in the total memory graph arrives every 60 seconds (configurable). If you select a node family, the metrics of the nodes are stacked onto each other.
  • WombatOAM has 90 built-in metrics; it also collects folsom and exometer metrics created on the node, as well as metrics from custom plugins, allowing you to combine business and system metrics.
  • WombatOAM can push the metrics to other OAM tools. This means that you can integrate WombatOAM metrics with other metrics that aren't Erlang-related. See the "Integration with third-party tools" section.

Logs

With Logs, you can view important crash and error reports from all nodes in one place. When a crash occurs, this should be the first port of call. All alarms raised and cleared are also shown under Logs, along with all shell interactions, modules loaded and purged, and so forth.

  • View logs: Logs → select a node. WombatOAM displays logs created with error_logger or lager from the managed nodes.
  • Search logs: Logs → click on the filter summary panel above the log list → enter a value in the search box.
  • Popup notifications are shown for events that are at "error" level or higher.
  • The level of log entries to be collected is configurable.

Alarms

You should check alarm logs regularly, and address them if necessary. All alarms raised and cleared are also logged under Notifications, in case you miss an alarm being raised and cleared.

  • View alarms: Alarms. This shows the alarms raised by WombatOAM (for example, if a node went down). Alarms can also be cleared by WombatOAM (for example, when a node comes up again).
  • Users can acknowledge, unacknowledge, clear, and comment on alarms.
  • The web dashboard displays popup notifications for new alarms.
  • WombatOAM generates logs from alarm events (displayed in the Logs tab).

Dashboard

If you click on the WombatOAM icon or WombatOAM text, you will see the default dashboard page with selected information (metrics, alarms, node statistics). Users can create their own dashboard pages with the following constraints:

  • Every page has a name which is unique.
  • Users can create, modify or delete pages.
  • It is not allowed to modify or delete a page that is not owned by the user, except if it is not owned by anyone.
  • The admin user can create, modify or delete any page, but even the admin cannot delete the default page.
  • When a user is deleted, the admin can decide whether to delete the user's pages too. If they are not deleted, they will not be owned by anyone.
  • If authentication is switched off, users have the same rights as admins when authentication is on.

Tools

This page contains the Process Manager and the Table Visualizer tools:

  • View the running processes: Tools → select a node → Process Manager.
  • View the ETS tables: Tools → select a node → Table Visualizer.
  • View more information about a process: Tools → select a node → Process Manager → click on the process pid.
  • View the ETS table contents: Tools → select a node → Table Visualizer → click on the id of the table.