opCharts 3 Administration Guide

Overview

opCharts has dashboards built into the heart of it's engine. Dashboards have the ability to display components, components can load data from many different sources and display it as a graph/table/pie/chart/etc. Right now only graphs are supported.

Customising the opCharts GUI contains some tips for GUI customisation.

Users, Roles, Privileges and Objects ( Portal mode / RBAC)

See this documentation

Charts

Data Sources

/usr/local/omk/conf/data_sources.json defines the data sources that the system will make available to the charts. Currently only SQL external data sources are supported. The default configuration in data_sources.json file ships with examples for MSSQL and MySQL servers. Here is an example a data source definition:

{
         "name" : "mssql_example",  # name used to access this data source in charts.json
         "type" : "sql", # fixed, no other types are currently available
         "data_models" : [ "sql_query" ], # also fixed.
         "parameters" : {
            "scheme" : "dbi", # fixed
            "driver" : "ODBC:DRIVER=FreeTDS", # dbi options that have been installed are available, only MSSQL and MySQL are tested
            "host" : "mani.opmantek.com", # SQL server host/ip
            "port" : "1433", # port SQL can be found on
            "database_name" : "testdb", # database to pull data from
            "username" : "sa", # username
            "password" : "password" #password
         }
},

The name specified for your data source will be used in other configuration files to access the data from this data source.

Dashboards

Dashboards can be created and set as the default view after logging in.

- defined application wide (not stored per user)
- names are unique, cannot be changed after creation (because they are used to link into other places, like default dashboards
- care should to be taken to ensure that a dashboard that is visible to a customer does not contain graphs that the customer should not see
  - the inclusion of components in a dashboard means any user who is allowed to see and load those components
- if a dashboard is deleted which is also set to a users default dashboard the user will just see the regular index page because the one picked cannot be found.

Configuration Options

After making any configuration changes you must restart the omkd daemon:

/etc/init.d/omkd restart

Panel View Options

KPI Based
Resource Based

In order to toggle between these two options adjust the /usr/local/omk/opCommon.nmis file.

For KPI based panels use the following setting:

    'opcharts_gui_node_panel_display' => 'kpi',

For Resource based panels use the following setting:

    'opcharts_gui_node_panel_display' => 'resource',

These two options are mutually exclusive, it must be one or the other. For an explanation of these two options see opCharts User Guide#Panelview

Remember to restart the omkd daemon after making configuration changes.

Node List Options

The node list displays nodes in two formats, panel and list/table. The default view shown is defined in the the /usr/local/omk/opCommon.nmis file:

'opcharts_gui_node_list_view_type' => 'table', #options: 'table' or 'panel'

Table view options

Columns displayed in the node list table view can be customized, existing columns can be removed/hidden and the order of the columns can be re-arranged. The config item 'opcharts_gui_node_list_table_columns' defines which columns will be displayed as we as the order of the columns are displayed.

The order the columns are defined is the order they will be displayed.

Available columns:

All node properties in the nodesum (/usr/local/nmis8/var/nmis-nodesum.json), prefixed with node_summary.
All node properties in the summary8h (/usr/local/nmis8/var/nmis-summary8h.json), prefixed with node_summary8.

You may wish to refer to Config.nmis to select what fields are seen in nmis-nodesum.json through : 'node_summary_field_list' => 'uuid,host,host_addr,customer,myRole,ServerRoles,businessService,serviceStatus,snmpdown',

Column definition:

name - the name of the data property
label - the name in the header of the column, this will be localized if the translation is available
cell - the type of data in the cell, 'String', 'Number', 'Integer', 'Percent' are all valid. To make a column become a link to the node set to 'NodeLinkCell' on that column, eg: cell => 'NodeLinkCell'.
formatter - in most cases this does not need to be defined. If the value is in epoch time set this to 'UnixTimeFormatter' to get a string date/time display.
renderable - set this to 0 to keep the column in the config but not show it, by default this is 1 which is to show the column

Example column entry:

'opcharts_gui_node_list_table_columns' example

{ 
        name=> "node_name",
        label => "Name",
        cell=> 'NodeLinkCell',
        renderable => 1,
        comment => "must be present for NodeLinkCell to work on any column, use renderable => 0 to hide"
},