Ceeview Sender

Description

The Ceeview sender plugin sends metrics, events and assets from 1Gateway into Ceeview. The messages get mapped to a format that the Ceeview sender plugin can process and converted to a JSON string that is sent to Ceeview through the Ceeview REST API.

In the CMDB use case, assets are also retrieved from Ceeview to create a replica collection. Pre-configured rules are used to match existing assets in the Ceeview replica to CI's in other systems. If a match is found, it is recorded in 1Gateway and updated in Ceeview. If its not, a new asset is created. Asset attributes can also be created.

Prerequisites

Ceeview version needs to be 2.3 or later
Ceeview token

To access the CeeView token, go to ceeview. Log in and go to Administration. Click on the user. The token is the authentication key shown.

Image 2. Get the token from Ceeview.

MongoDB installed and configured in 1Gateway (for CMDB use case only)

Installation

Make sure you have the Plugin zip file that has been provided to you with the installation files.

Login to 1gateway, and make sure you are in "Advanced mode". If this is the first time you log in, the default user and password are both 'admin' (without the quotes).

2 - System Maintenance

Click on the menu icon and choose the option "System maintenance"

3 - Upload file

In the System maintenance view you can either drag and drop the downloaded zip file or select it by clicking the "choose file" button.

Configuration

Open the main menu and click on "New plugin"

Select the plugin you want to configure. Use the Filter field if needed.

An example of a JSON metric sent to CeeView is shown below. This message shows the current temperature in Madrid.

{
    "apiToken": "545d0...",
    "options" : "redraw=false",
    "data" : [
        {
            "service": "MyService",
            "element": "Madrid",
            "qualifier": "temperature",
            "value" : "23.4"
        }
    ]
}

CODE

Main configuration

Field name	Supported values	Description
server	Valid IP address or hostname	CeeView server.
port number	Valid port number	CeeView port number.
apiToken	Api token	Token generated by CeeView for API authentication.

Metric configuration

Field name	Supported values	Description
Default asset	Any string	Default asset to associate metric with.
Default instance	Any string	Default name of metric instance.
Default category	Any string	Default metric category.
Default identifier	Any string	Default string that identifies the source of the metric.
Default unit	Any string	Default metric unit type.
Default type	Any string	Default metric data type.

Event configuration

Field name	Supported values	Description
Default monitor name	Any string	Default monitor name.
Default asset name	Any string	Default asset name.
Default account id	Any string	Default identifier for the sub-account.
Default asset group	Any string	Default name of the asset-group associated with the monitor.

All of the fields in the metric and event configurations are the defaults for the messages and will only be populated in the message if there isn't an existing one already.

CMDB configuration

Field name	Supported values	Description
Simulation mode	Tickbox	If in simulation mode, assets are saved in a simulation collection and are not sent to Ceeview.
CMDB replica collection	Any string	Name of the CMDB replica collectionwhere assets from Ceeview are stored. Used by matching rules to decide if there is a match between Ceeview assets and other systems CIs.
Outbound message processing	Tickbox
Outbound message types	Any string

CMDB configuration profiles

Poller profiles

Field name	Supported values	Description
Message type	Any string	Message type of the asset polled for. These assets are inserted in the replica collection and used for matching.
API suffix	Any string	URL suffix to use. Default value is /mgmt/assets.
Run interval in seconds	Any integer	Interval between two poll cycles.

Rule profiles

Field name	Supported values	Description
Message type	Any string	Message type in the replica collection to evaluate
Rule type*	Any string	Future use
Comma-separated list of fields	Any string	List of fields to match on. If the incoming asset has the same field value as the asset in Ceeview, it is considered the same asset.
Priority	Any integer	Rle priority. Rules are evaluated in ascending order until a match is found *