Module description

The PMC/PMP gateway must be monitored via SNMP (Simple Network Management Protocol). 

This module must send notifications (traps) related to its operation to the centralized SNMP server. 

The system notifications (traps) (CPU, RAM, disk consumption, network, etc...) do not concern this plugin. They will be sent directly by the system SNMP agent to the monitoring tool.

This plugin must use the net-snmp library proposed by the host OS. 

The notifications to expect are:

1. Iec104 server connection status (offline, in progress, established)
2. Iec104 client connection status (offline, in progress, established)
3. Iec104 north service status (stopped, starting, shutting down, running)
4. Iec104 south service status (stopped, starting, shutting down, running)
5. Fledge system start (START)
6. Stop the Fledge system (FSTOP)
7. Configuration update (CONCH)
8. Service failure (SRVFL)
9. SNMP v3 authentication failure (SNMPAuthenficationFailure)
10. INFO event (eventinfo)
11. WARNING event (eventwarning)
12. FATAL event (eventfatal)

The plugin must be able to link audit messages with SNMP traps only by configuration.

Message Reception

The plugin will receive a number of audit messages. These audits represent states, logs, or actions reported by the various services. These messages are to be transferred as a trap via the SNMP protocol.

These received audits respect the following description:

(1) "nameService" the name of the service must show :

• The name of the service type (north or south)
• The instance name of the service
• The name of the protocol

Sending messages via SNMP

All the audits are converted and transferred as a trap to the SNMP server.

The definition of the trap event is as follows:

Common fields for all traps:

• "nameGateway" = hostname of the gateway
• Date
• Severity

Correspondence with audit variables

Configuration

The configuration of the plugin allows the link between the audit variables and the SNMP trap objects. 
It also allows to fill in the following information:

• OID of the objects
• The origin of the data:
  • audit : data retrieved from the audit message
  • env : data retrieved from an environment variable
  • static : data entered statically in the configuration 
• The value of data 
• The destination in trap message

Configuration :

{

   "link_audit_trap": {
      "description":"Correspondence between audit and trap",
      "type":"json",
      "default":"",
      "order":"1",
      "displayName":"Link audit trap"
   }
}

The content of the config.json file will be the default value of the link_audit_trap parameter.

Example for an audit :

{ "stateLink " : {
        "oid" : "1.3.6.1.4.1.39059.1.1.1.1",
        "1" : {
            "oid" :"1.3.6.1.4.1.39059.1.1.1.1.1",
            "dest": "nameGateway",
            "origin" : "env",
            "value":"hostname"
        }
        "2" : {
            "oid" :"1.3.6.1.4.1.39059.1.1.1.1.2",
            "dest": "nameService",
            "origin" : "audit",
            "value":"detail.nameService"
        },
        "3" : {
            "oid" :"1.3.6.1.4.1.39059.1.1.1.1.3",
            "dest": "nameEvent",
            "origin" : "audit",
            "value":"source"
        },
        "4" : {
            "oid" :"1.3.6.1.4.1.39059.1.1.1.1.4",
            "dest": "libelleVariable",
            "origin" : "audit",
            "value":"detail.nameLink"
        },
        "5" : {
            "oid" :"1.3.6.1.4.1.39059.1.1.1.1.5",
            "dest": "valueVariable",
            "origin" : "audit",
            "value":"detail.valueLink"
        },
        "6" : {
            "oid" :"1.3.6.1.4.1.39059.1.1.1.1.6",
            "dest": "severity",
            "origin" : "audit",
            "value":"severity"
        },
        "7" : {
            "oid" :"1.3.6.1.4.1.39059.1.1.1.1.7",
            "dest": "date",
            "origin" : "audit",
            "value":"timestamp"
        }
    }
}

The MIB to load on the SNMP server is PMC-MIB.txt.