Getting started with WombatOAM
by Zsolt Dudas
With the release of WombatOAM 3.0.0beta - our operations, monitoring, maintenance, and performance tool for Erlang OTP based systems, I thought it was time to recap how to install WombatOAM. Get a 45 day free trial.
Prerequisites
Before installing WombatOAM, ensure that the machine meets the prerequisites. The following is required before installing WombatOAM:
- - A UNIX operating system (WombatOAM has been tested on Linux and Mac OS X)
- - The Erlang run-time system, ERTS (R15B03 or later)
- - OpenSSL and libcrypto (already present on Mac OS X)
Installing WombatOAM
To install WombatOAM on your computer, retrieve the current WombatOAM package and run the installation script. To do this, execute the following commands:
0.tar.gz
tar xfz wombat-2.9.0.tar.gz
cd wombat-2.9.0
./upgrade.sh # copy the license key into the directory
The ./upgrade.sh command returns the following:
1) [path to old wombat installation]
2) Other
3) Skip upgrade
If you are installing WombatOAM for the first time, enter 3 at the prompt, skipping the upgrade. The upgrade.sh script will simply build a release and start WombatOAM for you.
Upgrading WombatOAM
To upgrade an existing installation of a previous version of WombatOAM, open the package for the new version and execute the following command:
1 ./upgrade.sh
At the prompt, enter 2 (Other) and follow further prompts to specify the WombatOAM installation to upgrade from and perform the upgrade.
The upgrade.sh script will preserve your collected data and custom configuration (in your old rel/wombat/files/wombat.config file).
The WombatOAM web dashboard
To access the web dashboard, go to http://localhost:8080 in your browser. Log in with the user name admin and password admin.
Running WombatOAM
You can start and stop WombatOAM with the following commands, if necessary:
./start.sh # start Wombat
./stop.sh # stop Wombat
Keep in mind that the upgrade.sh script will start Wombat automatically. To check whether Wombat is actually running, check whether you can access the WombatOAM web dashboard on http://localhost:8080.
Using WombatOAM
To see how WombatOAM handles nodes, you can install the WombatOAM node itself into WombatOAM:
1. Select the Topology tab and click on the + button.
WombatOAM’s Topology page, illustrating the + buttons
2. Enter the following:
- - Node name:
wombat@127.0.0.1 - - Cookie:
wombat
Add a new node pop-up
3. Click the Add node button. The WombatOAM node should come up in a few seconds. If it doesn’t, check the following log file: rel/wombat/wombat/log/wombat.log
Click Done and you will be redirected to your node’s frontpage. From here, you have an overview of the metrics and active alarms associated with your node.
Node frontpage
Click the Metrics tab, select the node, and then select a metric. For example, click Memory → Process memory. You should see the measurements made on that node.
Process memory metrics for a specific node
Interested in seeing how WombatOAM can give you full visability of your Erlang or Elixir system? Get a 45 day free trial, on us!