Course13:IT Connect - 06.1 Alarms, Events and Logging

From innovaphone wiki
Jump to navigation Jump to search

Using the Events and Alarms App

Alarms, Events and Logging

innovaphone devices will generate three types of messages related to runtime issues:
  • Alarms describe an error situation that is still present
    If a device detects an error, it will raise an alarm. When the error condition is gone, the alarm will be cleared. So in an ideal world, there should be no Alarms at all at any time
  • Events describe notable events detected during runtime
    They do not necessarily indicate a real problem but they might serve as indicators
  • Log messages can be generated for all kinds of activities (such as for example calls made in the PBX). In contrast to alarms and events, log messages for specific activities can be turned on and off on demand
In case of issues, the usual work flow for an administrator is to consult the current alarms and if there are some that need to be fixed, consult the events to see if something suspicious happened before the alarm was raised.

When the issue can be reproduced, it often makes sense to first have a look at the log messages to see what exactly is going on.

All such messages from all devices known to Devices are sent to a central site so they can be checked at a single place (we have discussed how this is configured in the Device Configuration/Alarm server chapter of the Managing Devices book before). To do this, there are three Apps available, not that surprisingly called Logging, Alarms and Events.

Logging

The Logging App simply shows incoming log messages in real time.

We can try that out and see what happens, when a phone is rebootet:
  • open the Logging App
  • power cycle your IP232 (simplest to unplug the Ethernet cable for a moment)
  • when the phone reboots, screenshot.png log messages begin to appear
The newest message is always on top. In our re-boot example, we see

2019/05/21 11:24:22 IP232-30-0d-ad NTP 0 Time Initialized to 21.05.2019-09:24:22 UTC

At 2019/05/21 11:24:22 there was a log message sent by IP232-30-0d-ad (which is the serial number of the IP232) which says NTP 0 Time Initialized to 21.05.2019-09:24:22 UTC. The phone has successfully queried its time server for the current date and time.

Then
2019/05/21 11:24:22 IP411-40-00-b3 GK 0 REGISTER-OK(172.31.31.6:2049),H323=ckl,E164=10
At 2019/05/21 11:24:22 a log messages from IP411-40-00-b3 (which is our PBX) was sent saying GK 0 REGISTER-OK(172.31.31.6:2049),H323=ckl,E164=10. A device with IP address 172.31.31.6 (which is the IP232) successfully registered with the PBX for name ckl and extension 10.

Finally, we see the corresponding incoming registration request:

2019/05/21 11:24:22 IP411-40-00-b3 GK 0 REGISTER-IN(172.31.31.6:2049),GK-ID=dvl-ckl2.net,H323=009033300dad,Certificate=IP232s-30-0d-ad

At 2019/05/21 11:24:22 there was another log message from IP411-40-00-b3 (which is our PBX) saying GK 0 REGISTER-IN(172.31.31.6:2049),GK-ID=dvl-ckl2.net,H323=009033300dad,Certificate=IP232s-30-0d-ad. So there was an incoming register from the IP232 with 009033300dad as name and authenticated by a certificate with subject IP232s-30-0d-ad.


The Install has turned on some standard log flags. They can be changed and we'll discuss how this can be done later.

Events

Events are generated only when a device detects a suspicious situation. As opposed to log messages, you do not need to enable events (you only need to configure the URL your devices shall send them to). Also in contrast to log messages, Events are kept persistent. Even in a stable installation, this can happen quite often. As a result, the list displayed in Events is usually quite long.

To manage this large amount of information you can search for events that contain a certain string. Just type it into the search field on the upper right. Or you can define filters and apply them to the list of events.

Cleanup

Events are deleted after some time. The Install has configured a timeout of 30 days but you can change this using the screenshot.png burger menu on the upper right (Delete events after n days).

As mentioned before, Logging and Alarms are service provided by the Events App to. This is why you can also set the cleanup strategy for log messages here (Delete logs after n days and Keep the latest n logs). Note that logs messages are removed if they are either older than n days or there are more than n messages stored.

Alarms are cleared automatically as soon as the alarm condition disappears. So there is no cleanup strategy for alarms and hence no configuration.

Alarms

The Alarms App is quite similar to the Events app. Like with events, there is no need to enable specific type of alarms. However, in contrast to events, alarms are kept until they are gone (that is, when the issue is rectified). So there is no need to configure a time frame to keep them.

Exporting

You can export alarms, events and log messages in to text files easily by clicking on the screenshot.png events-export on the upper right edge of the Alarms, Events and Logging App.

Logs are not saved by default. In order to save logs in the database you need to activate the option screenshot.png Save logs on database in the burger menu of the events app. If you do not activate this check mark, exported logs will be empty.

These files can be valuable input when you need to contact innovaphone support or presales. So you should include all 3 with any support ticket you open!

We will come back to this topic later in more detail.