OpenNMSPlugin/

OpenNMSPlugin

The OpenNMSPlugin is a command line application that monitors the PM/FM directories where the mediator collector stores response and converts the PM/FM data to OpenNMS readable format and pushes it to OpenNMS data collection path.

Prerequisites

OpenNMSPlugin is compatible with only Unix/Linux system.

Project Structure

.  
├── resources               # Resource files  
    └── resource.conf  
├── src                     # Source files  
├── Makefile  
├── Dockerfile  
└── README.md  

Installation steps

OpenNMSPlugin's binary should be built by running make all command followed by make build_package command.
It will create binary named as opennmsplugin inside bin directory and package containing the binary and resource file, named as OpenNMSPlugin.zip inside package directory.

Please follow below procedure to install OpenNMSPlugin.zip in your home directory:

$ mkdir mediator
$ cp OpenNMSPlugin.zip mediator/
$ cd mediator/
$ unzip OpenNMSPlugin.zip

OpenNMSPlugin directory structure after installation will be as shown below:

    .
    ├── OpenNMSPlugin.zip
    ├── bin
        └── opennmsplugin
    ├── log
        └── OpenNMSPlugin.log
    └── resources
        └── resource.conf

Usage

Usage: ./opennmsplugin [options]
Options:
        -h, --help
            Output a usage message and exit.
        -conf_file
            Config file path (default "../resources/conf.json")
        -log_dir
            Log Directory (default "../log"), logs will be stored in OpenNMSPlugin.log file.
        -log_level
            Log Level (default 4), logger level in OpenNMSPlugin.log file. Values: 0 (PANIC), 1 (FATAl), 2 (ERROR), 3 (WARNING), 4 (INFO), 5 (DEBUG)
        -v
            Prints OSSMediator's version

Configuration

OpenNMSPlugin reads all the collected PM/FM file to convert it to OpenNMS readable format and push it to OpenNMS data collection path.

• To convert PM/FM statistics, modify conf.json configuration file under the "resources" directory as shown in the example:

{
    "users_conf": [
        {
            "source_dir": "<SOURCE DIRECTORY PATH>",
            "pm_config": {
                "destination_dir": "<PM DIRECTORY PATH>",
                "foreign_id": "<FOREIGN ID>"
            },
            "fm_config": {
                "source": "NDAC",
                "node_id": "1",
                "host": "127.0.0.1",
                "service": "NDAC",
                "destination_dir": "<FM DIRECTORY PATH>"
            }
        },
        {
            "source_dir": "<SOURCE DIRECTORY PATH>",
            "pm_config": {
                "destination_dir": "<PM DIRECTORY PATH>",
                "foreign_id": "<FOREIGN ID>"
            },
                "fm_config": {
                "source": "NDAC",
                "node_id": "1",
                "host": "127.0.0.1",
                "service": "NDAC",
                "destination_dir": "<FM DIRECTORY PATH>"
            }
        }
    ],
    "opennms_address": "127.0.0.1:5817",
    "cleanup_duration": 60
}

• To start opennmsplugin, go to the installed path of the mediator bin directory and start by calling the following command:

./opennmsplugin

• OpenNMSPlugin logs can be checked in $OpenNMSPlugin_HOME/log/OpenNMSPlugin.log file.