Child pages
  • opEvents 2.4.x - Customising Table Columns
Skip to end of metadata
Go to start of metadata

Feature Description

This is an advanced feature that allows customers to modify the data presented in tables.  The default table content has been carefully selected based on Opmantek's numerous years of network management experience.  This said there are cases where customers would like to alter the table data to display information that is important to their organisation.  Most opEvents pages with table data can be customised to display different content.  This feature allows table columns to be removed or added as required.

If when following these steps the View that is being modified does not behave normally; remove the custom configuration file and normality should be restored.


Views That Support Custom Columns

  • Actions
  • Raw Logs
  • Archive Logs
  • Nodes
  • Summary Reports
  • Edit Nodes
  • Dashboard
  • Events
  • Event Context (Node Summary)

Available Columns

Columns properties that may be added can found here:  opEvents Normalised Event Properties

Configuration

Configuration Files

Each view has a separate configuration file that will be found in the following directory (by default this directory does not exist; reference the next step):

/usr/local/omk/conf/table_schemas

ViewConfiguration file
ActionsopEvents_action-log.json
Raw LogsopEvents_raw-log.json
Archive LogsopEvents_archive-log.json
NodesopEvents_node-log.json
Summary ReportsopEvents_summary-reports.json
Edit NodesopEvents_node-ip.json
Current Events

opEvents_current-events.json

opEvents_active-events.json

Events by Node (Dashboard)opEvents_index_events.json
EventsopEvents_current-events.json

Enabling the Feature

In order to enable this feature the following must be done.

  • Create a directory called /usr/local/omk/conf/table_schemas
  • Copy the specific view configuration file that requires modification from /usr/local/omk/lib/json/opEvents/table_schemas/ into /usr/local/omk/conf/table_schemas.
    • Only the necessary json files should be copied to the /usr/local/omk/conf/table_schemas directory as having unecessary config files in this directory will result in future upgrades being unpredictable.

Caution!

Enable this feature with care. 

Future opEvents upgrades will need to be watched carefully as tables and event properties can change across versions.  Based on this an upgrade has the potential to break the functionality of a custom table configuration.  If this feature is enabled it is highly recommend to upgrade in a test environment prior to upgrading the production environment.


Configuration

The configuration files are json files that have a specific syntax that must be observed.  Add the desired property to the json file in the order it should appear in.  The table will be constructed left to right based on attributed that are read from the top down.

Property Attributes

Each property that is added will require a set of attributes.  This is an example of the attributes that belong to the 'comment' property.

  {
    "name": "comment",
    "label": "Comment",
    "cell": "string",
    "search": false,
    "editable": false
  }

Attribute Descriptions

Adding and Removing Columns

To remove a column simply remove the associated section from the applicable json file.  To add a column add a new section in the json file.  The column placement will be relative to the order it is put in the json file.

The example below is the opEvents_action-log.json file.  The version on the left is the default version.  The version on the right adds an Event ID column between the data and event columns, it also removes the comment column.

// VERSION=0.4.0                                 // VERSION=0.4.0
[                                                [
  {                                                {
    "name": "date",                                  "name": "date",
    "label": "Date",                                 "label": "Date",
    "search": false,                                 "search": false,
    "cell": "string",                                "cell": "string",
    "direction": "descending",                       "direction": "descending",
    "editable": false                                "editable": false
  },                                               },
  {                                                {
    "name": "event",                                 "name": "eventid",
    "label": "Event",                                "label": "Event ID",
    "cell": "string",                                "cell": "string",
    "search": false,                                 "search": false,
    "editable": false,                               "editable": false
    "cell": "LookupUrl",                           
    "replace_name": "id",                          },
    "base_url_stash_key": "event_base_url"         {
  },                                                 "name": "event",
  {                                                  "label": "Event",
    "name": "node",                                  "cell": "string",
    "label": "Node",                                 "search": false,
    "search": false,                                 "editable": false,
    "editable": false,                               "cell": "LookupUrl",
    "cell": "LookupUrl",                             "replace_name": "id",
    "base_url_stash_key": "node_base_url"            "base_url_stash_key": "event_base_url"
  },                                               },
  {                                                {
    "name": "action",                                "name": "node",
    "label": "Action",                               "label": "Node",
    "cell": "string",                                "search": false,
    "search": false,                                 "editable": false,
    "editable": false                                "cell": "LookupUrl",
  },                                                 "base_url_stash_key": "node_base_url"
  {                                                },
    "name": "details",                             {
    "label": "Details",                              "name": "action",
    "cell": "string",                                "label": "Action",

    "editable": false                                "search": false,
  },                                                 "editable": false
  {                                                },
    "name": "comment",                             {
    "label": "Comment",                              "name": "details",
    "cell": "string",                                "label": "Details",
    "search": false,                                 "cell": "string",
    "editable": false                                "search": false,
  }                                                  "editable": false
]                                                  }
                                                  ]


For example, the image below shows the default menu bar for the Actions view in opEvents.

After editing the opEvents_action-log.json file the extra column was added to the end of the row labeled "New Custom Column". This process can be replicated to display custom information in as many columns as you would like on this page.

Verification

It is not necessary to restart any daemons.  After editing the associated json file simply load (or reload) the view in question.  

Event Context Panel

The Event Context Panel has some default properties and some customisable properties, by default the following are displayed:

  • Authority (only displayed if event contains data in the authority and location field)
  • Time
  • Node Summary Table (see Node Summary Table Customisation)
  • Event Status (see Event Status Customisation)
  • Related Events
  • Event
  • Details
  • Priority
  • Last Updated
  • Escalation

Additional properties can be displayed as well.

By default the Event Context Panel will look like this, providing essential contextual information about the event.

Node Summary Table Configuration

In the Event Context Panel there are two customisable lists for displaying extra data, the first is the Node Summary List, which is the horizontal list and the Event Properties which is the vertical list, asillustrated in screenshot.  The Event Status can also be configured which is described below.

To change which node properties are displayed you can modify opevents_gui_event_node_summary_list config option in opCommon.nmis

By default these properties are displayed in the gui, any changes will require the omkd daemon to be restarted.  If the node has any notes, these will also be displayed.

'opevents_gui_event_node_summary_list' => ["name","group","location","customer","businessService","host"]

Additional Event Context Items

To display or change the additional event properties, modify opevents_gui_event_context_summary_list in opCommon.nmis change the properties as required.


By default no additional properties are displayed, to include them just add them to the array as below, any changes will require the omkd daemon to be restarted.

    'opevents_gui_event_context_summary_list' => [
      'stateful',
      'type'
    ],

Event Status Configuration

To provide support for event management workflows, opEvents includes the ability to define the event status, because almost all operational teams will have a slightly different event status, this is completely configurable.  The Event Status feature makes opEvents into a Technical Service Desk, which is a service desk for the technical teams to use, while your Service Desk is where your customers and users will open tickets.

When an engineer or operator receives the event, they would acknowledge the event to stop the escalations and automated actions and update the Event Status with where they are in the process of managing the event.  Every time the Event Status is changed this is logged into the event for tracking activities, audit trials and possibly Service Level Agreements.

First enable the feature by changing opevents_event_status_enabled  => 'true' in opCommon.nmis

'opevents_event_status_enabled' => 'true',

Values which the operator can select are defined in opevents_event_status_values in opCommon.nmis, if enabled or the event has the status property, a select box will be rendered in the event context panel.

To configure to work for your team, decide on what fields you want to include in your status, we include the following:

     'opevents_event_status_values' => [
            {
                'status' => 'Detected'
            },
            {
                'status' => 'Investigating'
            },
            {
                'status' => 'Resolved'
            },
        ],

By default, no value is set in the event, if you require a value to be set, you just update opevents_event_status_default_value in opCommon.nmis and restart the Opmantek and opEvents Daemons.

'opevents_event_status_default_value' => 'Detected',

Restarting Daemons

Restart the Opmantek Daemon (for the GUI)

sudo service omkd restart


Restart the opEvents Daemon which Processes Events.

sudo service opeventsd restart