Skip to end of metadata
Go to start of metadata

Download PDF Document

2018-07-11

All Mediatrix Products

v. 42.3.986


1 Event Notifications

An event is something that happens in the system and that needs to be reported. Event notifications are formatted text messages issued by the DGW software to signal something of interest to the unit administrator.

Event Notifications are used to generate alarms in the customer's system and to monitor the system. It is possible to control:

  • for which service event notifications will be reported;
  • which event notifications will be reported based on the severity level of the event;
  • if a specific event notification should be reported or not;
  • where the event notifications will be logged.
For example, it is possible to log all event notifications raised for the Call Router (Crout) service, or to log only one specific event notification for the Certification (Cert) service.

Important

Unit performance is affected by the quantity of events that are reported.

Event Notifications can be sent to different destinations to be logged:


1.1 Logging Event Notifications

Before You Start

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Steps

  1. Go to System/Event Log.
  2. In the Service Notification Configuration table, click + located next to Services.
  3. For each service, choose the Severity level that will trigger the notifications.

    Note

    if you do not wish to log the event notifications of a service, select Disable.

    Note

    At this point, you have only enabled the possibility to log event notifications.

  4. In the Criteria field, enter All.
  5. From the Action drop-down list, select where and how the event notifications will be logged.
    1. Choose Log Locally to display the event notifications in the Local Log.
    2. Choose Log to File to send the event notifications to the DGW file management system (not available on the Mediatrix 4102 and C7 Series).
    3. Choose Send via Syslog to send the event notifications to a Syslog server.
  6. If you selected Send via Syslog in the previous step, make sure you have configured the address of the syslog server under Syslog Configuration/Remote Host field.
  7. Click .
  8. Click Apply.

Result

All event notifications with the appropriate selected Severity level of each selected service will be logged to the chosen destination.

1.2 Logging Specific Event Notifications

Context

Instead of logging all the event notifications, as specified in Logging Event Notifications, the Criteria can be refined to a subset of events.

Before You Start

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Steps

  1. In the Service Notification Configuration table, click + located next to Services.
  2. From the Severity drop-down list, for each service, choose the severity level that will trigger the notification.

    Note

    If you do not wish to log the event notifications of a service, select Disable.

    Note

    At this point, you have only enabled the possibility to log event notifications.

  3. In the Notification Events table, select a Service for which Event Notifications must be issued.
  4. From the Notification drop-down list, select one, or several, specific service notifications you wish to log.

    Note

    The Criteria field will be auto populated with the selection made in the Notification field.

    Note

    To log all the notifications of a specific service enter in the Criteria field the service code with all separated by a coma. For example: 200.all to log all the notifications of the Bni service. (The code can be found in the Service drop-down list.)

  5. From the Action drop-down list, select where and how the event notifications will be logged.
    1. Choose Log Locally to display the event notifications in the Local Log.
    2. Choose Log to File to send the event notifications to the DGW file management system. (not available on the Mediatrix 4102 and C7 Series).
    3. Choose Send via Syslog to send the event notifications to a Syslog server.
    4. Choose Send via SIP to send the event notifications to a SIP server.
  6. This step is not necessary if you chose Log To File in the previous step. In Syslog Configuration table, in the Remote Host field, enter the IP address of the server.
  7. Click .
  8. Repeat steps 4 to 7 for each notification you wish to publish.
  9. Click Apply.

Result

The selected service notifications with the corresponding Severity level will be published to the selected destination.

2 Destinations for Event Notifications


2.1 Send via Syslog

Event notifications can be logged by a Syslog server.

The event notifications will be sent over UDP in the syslog format, to the syslog server specified in the configuration. Alternatively, the syslog server address can be provided through DHCP. It is important to understand that if no syslog server address is provided by a DHCP server or specified by the administrator, no messages are sent.

Important

In some cases, Mediatrix devices can generate more information than the syslog server can handle. In these cases, it is preferable to capture the information with Wireshark.


2.2 Send via SIP

It is possible to send the event notifications to a SIP server.

The event notifications sent to a SIP server are included in the SIP Notify messages. When choosing to send event notifications to a SIP server, it is not allowed to send all notifications, i.e. select the All criteria when configuring event notifications. This has been implemented to avoid sending high volumes of traffic and risking the overload of the SIP server.

The destination can be configured with the parameter and the sipEp.maxNotificationsPerNotify parameter is used to define how many messages can be sent in a single "SIP NOTIFY" request the

For more details, refer to Reference Guide .


2.3 Log Locally

The DGW Local Log displays the Event Notifications related to the events occurring on the Mediatrix unit that are generated by the Mediatrix Notifications and Logging Manager (Nlm) service.

Notifications will be displayed in the Local Log Entries table of the DGW Web interface provided the issuing of events for a service is enabled, and if the event meets the selected severity level chosen to be reported.

The Local Log Entries table has the following characteristics:

  • Number of displayed event notifications is limited
  • Newer notifications replace older ones.
  • The routing criteria should be designed to avoid overloading the log.
  • The local log has no persistence. Its content is erased when the unit or the Nlm service is restarted.
  • The local log does not accept messages from the SNMP service with a ‘Debug’ severity level. This is to prevent an issue when reading the local log with SNMP. The SNMP walk through the table would not catch up with the increasing index because of the DEBUG events generated by the SNMP service itself.


2.4 Log to File

The event notifications can be logged in a file saved in the DGW File Management system.

Event notifications logged to a file will be available in the DGW Web interface, under Management/File tabs. The log to file feature is not available on the Mediatrix 4102 and C7 Series as they do not have more than 1MB or more user storage. The number of files stored in the unit is limited. When the maximal number is reached, the oldest stored file is deleted. The limit is configured in the LogFileMaxNb Mib parameter.


3 Diagnostic Traces

Diagnostic Traces are specifically used for troubleshooting purposes. As for Event Notifications, they report errors, warnings, or system information.

Diagnostic Traces do not need to be activated, except at the specific demand of Media5 Technical Assistance Center.


3.1 Logging Diagnostic Traces

Before You Start

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Steps

  1. Go to System/Event Log.
  2. In the Remote Host field, enter the static IP address or domain name and port number of the device that archives the log entries sent by syslog transport.

    Note

    Specifying no port, or port 0, sends notifications to port 514.

  3. From the Diagnostic Traces field, select Enable.
  4. Click Edit.
  5. In the Diagnostic Traces table, select the level of severity an event should have to be reported by the syslog.

    Important

    Enabling all the traces will reduce the performance of the Mediatrix unit and may cause it to no longer respond.

  6. Click Apply.
  7. Click Apply again.

Result

The traces generated by the Mediatrix unit with the selected severity level, will be sent to the specified address.

4 Basic tasks


4.1 Clearing the Local Logs

Before You Start

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Steps

  1. Go to System/Local Log.
  2. Click Clear Local Log.

Result

The entries in the Local Log Entries table will be permanently deleted.

4.2 Updating the Local Logs

Before You Start

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Steps

  1. Go to System/Local Log.
  2. Click Refresh Local Log.

Result

All new entries generated by the Notifications and Logging Manager (NLM) of your Mediatrix unit will be displayed in the Local Log Entries table.

4.3 Disabling Event Notification Reporting for a Service

Before You Start

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Steps

  1. Go to System/Event Log.
  2. In the Service Notification Configuration table, from the drop-down list located next to a service name, select Disable.

Result

No event notifications will be issued for the service.

4.4 Modifying the Severity Level Triggering the Reporting of a Notification

Before You Start

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Steps

  1. Go to System/Event Log.
  2. In the Service Notification Configuration table, from the drop-down list located next to a service name, select the severity level an event should have to issue a notification.

Result

Notifications will be issued for the service only if the severity level matches the selection.

5 Command Line Interface (CLI)

The Command Line Interface (CLI) provides an access to interactively configure all the Mediatrix unit parameters.

The CLI is accessed through either a secure SSH session (default) or an unsecure TELNET session. When using a secure SSH session, all communications between Client and server are encrypted before being sent over the network, thus packet sniffers are unable to extract user names, passwords, and other potentially sensitive data. This is the default and recommended way to access the Command Line Interface.

The command interpreter interface of the CLI allows the user to browse the unit parameters, write the command lines, and display the system's notification log.


5.1 Parameters

When using the Send via SIPdestination the following CLI parameters can be used:
  • sipEp.sipNotificationsGateway to define the gateway that will be used.
  • sipEp.maxNotificationsPerNotify to define how many messages can be sent in a single "SIP NOTIFY" request.
When using theLog to File destination, the following CLI parameter can be used:
  • LogFileMaxNb to set the maximum number of files stored in the file management system.
For compelte details on parameters, refer to the Reference Guide published on the Media5 documentation portal.

6 Documentation

Mediatrix units are supplied with an exhaustive set of documentation.

Mediatrix user documentation is available on the Documentation Portal .

Several types of documents were created to clearly present the information you are looking for. Our documentation includes:

  • Release notes: Generated at each GA release, this document includes the known and solved issues of the software. It also outlines the changes and the new features the release includes.
  • Configuration notes: These documents are created to facilitate the configuration of a specific use case. They address a configuration aspect we consider that most users will need to perform. However, in some cases, a configuration note is created after receiving a question from a customer. They provide standard step-by-step procedures detailing the values of the parameters to use. They provide a means of validation and present some conceptual information. The configuration notes are specifically created to guide the user through an aspect of the configuration.
  • Technical bulletins: These documents are created to facilitate the configuration of a specific technical action, such as performing a firmware upgrade.
  • Hardware installation guide: They provide the detailed procedure on how to safely and adequately install the unit. It provides information on card installation, cable connections, and how to access for the first time the Management interface.
  • User guide: The user guide explains how to customise to your needs the configuration of the unit. Although this document is task oriented, it provides conceptual information to help the user understand the purpose and impact of each task. The User Guide will provide information such as where and how TR-069 can be configured in the Management Interface, how to set firewalls, or how to use the CLI to configure parameters that are not available in the Management Interface.
  • Reference guide: This exhaustive document has been created for advanced users. It includes a description of all the parameters used by all the services of the Mediatrix units. You will find, for example, scripts to configure a specific parameter, notification messages sent by a service, or an action description used to create Rulesets. This document includes reference information such as a dictionary, and it does not include any step-by-step procedures.


7 Copyright Notice

Copyright © 2018 Media5 Corporation.

This document contains information that is proprietary to Media5 Corporation.

Media5 Corporation reserves all rights to this document as well as to the Intellectual Property of the document and the technology and know-how that it includes and represents.

This publication cannot be reproduced, neither in whole nor in part, in any form whatsoever, without written prior approval by Media5 Corporation.

Media5 Corporation reserves the right to revise this publication and make changes at any time and without the obligation to notify any person and/or entity of such revisions and/or changes.