. . .


ApiOmat provides monitoring capabilities at all layers. For most methods, a Nagios compartible monitoring system is required.

Checking the YAMBAS service

After running, each application server provides a simple ping-like REST method to check if the service is alive (usable for load balancers, etc):


YAMBAS will respond with a version number.

Furthermore, it is recommended that you create a simple app for monitoring, storing some sample data in it and use a REST call to test if data is retrieved properly.

Monitoring via ApiOmat Dashboard

Using the ApiOmat Dashboard to monitor your servers is an easy way to get an overview on different aspects of your servers like CPU and RAM usage (see screenshots). Only the SuperAdmin has access to the monitoring page.

  1. Install ApiOmat monitoring services on your servers

  2. If you need to change one of the following config values, create a config file at /opt/application-default.yml which includes the following yaml file used for the service configuration:

    monitoring service config
    # specify passwort for monitoring user
    password: secret
    # specify tomcat access here when tomcat JMX values should be parsed
    # url: http://localhost:8080
    # service registry URL
    defaultZone: http://localhost:8761/eureka
    # JMX port
    # switch to use MongoDB or memory storage
    useMongo: true
    serverNames: localhost
    # MBean names to query and store
    names: java.lang:type=OperatingSystem,java.lang:type=Runtime,java.lang:type=Threading
    # Request timeout (ms) when collecting data from other monitoring nodes (max value = Integer.MAX_VALUE = 2 147 483 647)
    requestTimeout: 50000
  3. configure apiomat.yaml:

    apiomat.yaml monitoring settings
    # URL of the service registry
    eurekaHost: http://localhost:8761
    user: user
    # Use the same password as configured for monitoring service
    password: secret
    yambas.conf monitoring settings

    When the monitoring settings are configured in the yambas.conf, the option "Monitoring" is automatically added to the dashboard menu in the admin panel:


  4. log into ApiOmat Dashboard with the SuperAdmin Account and open the monitoring page

A restart of yambas or dashboard is not necessary.

More about running the monitoring service can be found within the article Configure Monitoring Extras


images/download/attachments/13271718/monitoring_02.png images/download/attachments/13271718/monitoring_05.png images/download/attachments/13271718/monitoring_09.png

Checking the Apache Tomcat

The jolokia plugin monitors the status of the application container. Several parameters of a web application can be observed, like

  • track the number and rate of in coming requests per second

  • number of current connections

or common checks like memory and CPU usage of the whole Tomcat.

The plugin requires Jolokia and the agent plugin on the monitored server. Jolokia works with JMX.

Checking the MongoDB

MongoDB has its own Nagios/Check_MK plugin ( check_mk_active-mongodb) where e.g.

  • replication data

  • number of connections

  • current lock

  • database size

can be monitored.

Furthermore, mongo contains several command line tools to check performance and load: http://docs.mongodb.org/manual/administration/monitoring/

Configuration Details

Further configuration details to set up the monitoring service (e.g. running monitoring service on several nodes) are described within the article 'Configure Monitoring Extras' .

* link only available in Enterprise Documentation