Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column

Introduction

The Data-Exporter Addon is a daemon which collects ever occurring events (such as ALERTS, NOTIFICATIONS; DOWNTIMES, …) and all performance data. The collected data is saved locally on the SONARPLEX device. The data will then be uploaded to the configured FTP server. All the configuration happens through "Host Properties".

The data export format can be either XML or CSV, it can be configured (see below).

The Data-Exporter enables you to import historical data in on-premise reporting tools for in-deep analyzation.

Installation

Insert excerpt
_AdminInstallExtension
_AdminInstallExtension
nopaneltrue

You will see that a host object plus service objects for the Self-Monitoring are automatically created during installation. See Data Exporter - Export raw event and performance data Self-Monitoring for reference.

Column
width300px
Panel
bgColor#f4f4f4
borderStylesolid

On this page:

Table of Contents

Configuration

Setting a unique Location Identifier

Info

The default location name is set to local. It is recommended to change it as it helps identifying one SONARPLEX in a setup of multiple ones and the exported archives include the location identifier.

  1. Insert excerpt
    _OpenAdminWeb
    _OpenAdminWeb
    nopaneltrue
     > Configuration >  My Properties 
    and scroll down to the bottom
  2. Open the resource LOCATION
  3. Set Ressource Value to the desired location name, e,g, Cologne
  4. Click  to save the configuration

Configuring the Data Export Settings

Info

Version previous to 1.0.437 used Host Properties for the basic configuration. Versions starting from 1.0.437 and higher offer all Settings as part of the

Insert excerpt
_AdminWeb
_AdminWeb
nopaneltrue
which makes the setup easier. Make sure to use the latest version.

...

Setting
Description
FTP server addressLoaded automatically from the host object DATA_EXPORT_SERVER
Data Export Interval in minutes1-9999 (upload interval in minutes)
Data Export FormatXML / CSV (default CSV)
Data Export ItemType Blacklistperfdata/events (excludes configured itemtype from export)
FTP UsernameUsername
FTP PasswordPassword
FTP PortUDP Port, defaults to 21
FTP Directory

Upload directory on the server

Note

Make sure this directory exists on the FTP server, otherwise the upload will fail.

FTP Timeout in seconds5-30 (defaults to 30)
Suppress Soft EventsYes / No, activate to only log HARD events and suppress SOFT ones.
FTP Debug levelDebug level

Troubleshooting 

Enable the Logging

All problems are logged in the data_exporter.log, that can be found in  

Insert excerpt
_AdminWeb
_AdminWeb
nopaneltrue
 > Status > Logs > Data Exporter [data_exporter.log].

...

Tip

Always make sure to disable the logging when you're done with troubleshooting as writing logfiles has significant impact on the overall I/O performance, especially for less powerful hardware.

Self-Monitoring

The data exporter features so called self-monitoring. During installation the configured hosts are checked if one is considered to be a data export server (_data_export_server property is set). If not a new host object is created with two new service checks, which are explained below. Of course the service checks are attched to an existing host if found.

Data Export Server Ping

This service check pings the ip address of the configured Data Export server. 

Data Export Server Problems

The service check shows all processing and upload problems as soon as those occurr, such as ftp login problems, non existing ftp upload directories or wrong ftp ports.

...