Skip to main content

Ceeview

Sender Description

The Ceeview sender plugin sends metrics, events, and assets from 1Gateway into Ceeview. The messages are mapped to a format that the Ceeview sender plugin can process and converted to a JSON string, which is then 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.

An example of a JSON metric sent to CeeView:

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

This message shows the current temperature in Madrid.

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 CIs (Configuration Items) in other systems. If a match is found, it is recorded in 1Gateway and updated in Ceeview. If it's not, a new asset is created. Asset attributes can also be configured.

Prerequisites

  • MongoDB installed and configured in 1Gateway (for CMDB use case only).
  • 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.

Ceeview token Get the token from Ceeview.

Sender Configuration

The Ceeview Sender Plugin consists of four configuration types, main, metric, event, and cmdb.

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.

Main

Field nameSupported ValuesDescription
serverValid IP address or hostnameCeeView server
port numberValid port numberValid port number
apiTokenValid API tokenToken generated by CeeView for API authentication

Metric

FieldSupported ValuesDescription
Message type for metricsAny string1Gateway message type for CeeView metrics. Needs to be the same as in the metric2ceeview mapper
Default Ceeview assetAny stringDefault asset to associate metric with.
Default Ceeview instanceAny stringDefault name of metric instance.
Default categoryAny stringDefault metric category.
Default Ceeview identifierAny stringDefault string that identifies the source of the metric.
Default unitAny stringDefault metric unit type.
Default Ceeview typeAny stringDefault metric data type.

Event

FieldSupported ValuesDescription
Message type for eventsAny string1Gateway message type for CeeView events. Needs to be the same as in the state2ceeview mapper.
Default Ceeview monitor nameAny stringDefault monitor name.
Default Ceeview asset nameAny stringDefault asset name.
Default account idAny stringDefault identifier for the sub-account.
Default Ceeview asset groupAny stringDefault name of the asset-group associated with the monitor.
info

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

FieldSupported ValuesDescription
Do not insert new CIsBooleanIf TRUE, the plugin won't create new CIs and will only update existing CIs based on the match found.
Simulation modeBooleanIf TRUE, assets are saved in a simulation collection and are not sent to Ceeview.
CMDB replica collectionAny stringName of the CMDB replica collection where assets from Ceeview are stored. Used by matching rules to decide if there is a match between Ceeview assets and other systems CIs.
Replica expiration (in hours)Any integerExpiration time of the replica collection. If expired, the replica collection will be rebuilt.

Main

Field nameSupported ValuesDescription
Message typeAny stringMessage type of the asset polled for. These assets are inserted in the replica collection and used for matching
API suffixAny stringURL suffix to use. The default value is /mgmt/assets
Run interval in secondsAny stringInterval between two poll cycles

Rule profiles

Field nameSupported ValuesDescription
ScriptGroovy scriptGroovy script to evaluate the CI content and search for a match in the replica
Run interval in secondsAny stringRule priority. Rules are evaluated in ascending order until a match is found