Skip to main content
Skip table of contents

Events Tracking

Contents

Fiorano Platform raises an event for any meaningful event that occurs in the system. These System events are collected and processed in the Enterprise Server, and thereby, the state of the artifacts (Event processes, components, server status, and so on) is determined by the sequence of such Events. If the component is configured to raise the monitoring events on the various performance metrics, then these events are also stored in the event repository. The default database is configured as H2 and the database is File-based.

Configuring Event Tracking

The Enterprise Server, by default, is configured to insert all System events into the default H2 Events database (specific database events can be configured for Event Tracking, see next section). If, at any point, the user decides to switch off event tracking, they can do so by opening the profile and navigating to Fiorano > Esb > Events > FESEventsManager (as shown in figure 1) and disabling the EnableSystemEventTracking property (clear the check box).


Figure 1:  EnableSystemEventTracking property 

Server must be stopped to make changes; it can be changed at runtime by logging into FES-JMX.

Another property named 'ListenForUserEvents' in the same property panel decides whether or not the Enterprise Server listens to the monitoring events published by component instances. This property, by default, is disabled. If monitoring is enabled for component instances (see Creating Mappings section), this property needs to be enabled so that these user events are recorded.

This property cannot be changed at runtime. Changing this property via FES-JMX connection would require a server restart for the change to take effect. If this property is enabled, EnableSystemEventTracking property decides whether these events will be inserted into the Events database or not.

Disabling Event Tracking

To disable Event Tracking globally, perform the following steps:

  1. Login to FES-JMX and navigate to Fiorano > Esb > Events > EventsManager > FESEventsManager > config.
  2. Disable EnableSystemEventTracking property.

Configuring Specific Database

The Event Tracking feature is configured as part of FES to track System and User events into the H2 database running within the Enterprise Server. This can be changed by customizing the eventsdb.cfg file present in: FIORANO_INSTALL_DIR\esb\server\profiles\<profilename>\FES\conf. This file contains all the DB-specific configurations used for event tracking. Depending on the type of database used, you might have to modify the <dbtype>_jdbc.cfg file, and this is set in the JDBC_PROPERTIES property of eventsdb.cfg file. The file <dbtype>_jdbc.cfg contains more database-specific configurations, for example, an error code used by the database to indicate whether a table is present in the database or not.

Additionally, this file also contains names of the data types that will be used by the database. These datatype names are mentioned against unique numbers. These numbers are the constants that are used to identify generic SQL types, called JDBC types (please refer to javadoc for java.sql.Types).

The default configuration shipped with the installer uses the H2 database.

  1. After configuring a profile to use a database other than the default database, jdbc driver for that database needs to be added under <java.classpath> tag in server startup configuration file (either $FIORANO_HOME/esb/server/bin/server.conf or $FIORANO_HOME/esb/fes/bin/fes.conf, whichever is applicable) prior to starting the Enterprise Server.
  2. You would have to use the same settings to connect to the DB when using a third-party tool. All database queries used for retrieving workflow related data is kept in events.sql file.
  3. When using MS SQL for events tracking, mssql_jdbc.cfg file may need to be configured according to the database driver being used. MSSql 2000 driver follows SQL 99 conventions which quote the SQLState string for table not found exception as '42S02'. On the other hand, MSSQL 2005 driver follows XOPEN SQLState conventions which quote the same SQLState string as 'S0002'. By default, all fes profiles are configured according to the standards followed by the MSSql 2000 driver. If someone uses MSSql 2005 database, or uses the MSSql 2005 driver for MSSql 2000 (2005 driver is backward compatible with 2000 driver and can be used), then the file has to be re-configured accordingly.

 It is strongly recommended that the User employ a commercial grade DB in a production system.

For File-based databases like apache and HSQL, the default location is in the ESB_USER_DIR (which is set in fiorano_vars script). The user has to give the complete path with these variables resolved when using the JDBC URL in a third-party tool.

Example

The default H2 DB JDBC URL is configured as ESB_DEFAULT_DB_DIR/events_db;create=true which resolves to ESB_USER_DIR/EnterpriseServers/<profilename>/FES/events_db and further into something like C:\Program Files\Fiorano\<Fiorano 10ProductVersion>\runtimedata\EnterpriseServers\<profileName>\FES\events_db depending on the actual settings.

Database Table Structure

The exact schema of the tables varies from database to database according to the configurations provided in <dbtype>_jdbc.cfg file. An explanation of the tables and the various fields is given below:

Table name: TPS_EVENTS & TES_EVENTS
Column NameTypeDescription

EVENT_ID

INTEGER

Auto Generated

EVENT_CATEGORY

VARCHAR(255)

Category of event i.e. Information, Warning or Error

GENERATION_DATE

TIMESTAMP

Time at which the event was generated

EVENT_SOURCE

VARCHAR(255)

Server name which generated the event

EVENT_SCOPE

VARCHAR(255)

Scope of the event

EVENT_MODULE

VARCHAR(255)

Module to which the event belongs

DESCRIPTION

VARCHAR(255)

Short description of the event

EVENT_STATUS

VARCHAR(255)

Event constant representing the type of event

EXPIRY_TIME

TIMESTAMP

Event expiry time

Table name: SERVICE_EVENTS
Column NameTypeDescription

EVENT_ID

INTEGER

Auto Generated

EVENT_CATEGORY

VARCHAR(255)

Category of event i.e. Information, Warning or Error

GENERATION_DATE

TIMESTAMP

Time at which the event was generated

EVENT_SOURCE

VARCHAR(255)

Server name which generated the event

EVENT_SCOPE

VARCHAR(255)

Scope of the event

EVENT_MODULE

VARCHAR(255)

Module to which the event belongs

DESCRIPTION

VARCHAR(255)

Short description of the event

EVENT_STATUS

VARCHAR(255)

Event constant representing the type of event

EXPIRY_TIME

TIMESTAMP

Event expiry time

SERVICE_GUID

VARCHAR(255)

The GUID of the service to which the event belongs

SERVICE_VERSION

VARCHAR(255)

The service version to which the event belongs

SERVICE_INST_NAME

VARCHAR(255)

Service Instance name

APP_GUID

VARCHAR(255)

Application Name

Table name: APPLICATION_EVENTS
Column NameTypeDescription

EVENT_ID

INTEGER

Auto Generated

EVENT_CATEGORY

VARCHAR(255)

Category of event i.e. Information, Warning or Error

GENERATION_DATE

TIMESTAMP

Time at which the event was generated

EVENT_SOURCE

VARCHAR(255)

Server name which generated the event

EVENT_SCOPE

VARCHAR(255)

Scope of the event

EVENT_MODULE

VARCHAR(255)

Module to which the event belongs

DESCRIPTION

VARCHAR(255)

Short description of the event

EVENT_STATUS

VARCHAR(255)

Event constant representing the type of event

EXPIRY_TIME

TIMESTAMP

Event expiry time

APP_GUID

VARCHAR(255)

The Event Process GUID

APP_NAME

VARCHAR(255)

The Event Process Name

Table name: SECURITY_EVENTS
Column NameTypeDescription

EVENT_ID

INTEGER

Auto Generated

EVENT_CATEGORY

VARCHAR(255)

Category of Event, that is, Information, Warning or Error

GENERATION_DATE

TIMESTAMP

Time at which the Event was generated

EVENT_SOURCE

VARCHAR(255)

Server name which generated the Event

EVENT_SCOPE

VARCHAR(255)

Scope of the Event

EVENT_MODULE

VARCHAR(255)

Module to which the Event belongs

DESCRIPTION

VARCHAR(255)

Short description of the Event

EVENT_STATUS

VARCHAR(255)

Event constant representing the type of event

EXPIRY_TIME

TIMESTAMP

Event expiry time

USER_NAME

VARCHAR(255)

Name of the user for which the Event was generated

Table name: USER_EVENTS
Column NameTypeDescription

EVENT_ID

INTEGER

Auto Generated

EVENT_CATEGORY

VARCHAR(255)

Category of event, that is, Information, Warning or Error

GENERATION_DATE

TIMESTAMP

Time at which the Event was generated

EVENT_SOURCE

VARCHAR(255)

Server name which generated the Event

EVENT_SCOPE

VARCHAR(255)

Scope of the Event

EVENT_MODULE

VARCHAR(255)

Module to which the Event belongs

DESCRIPTION

VARCHAR(255)

Short description of the Event

EVENT_STATUS

VARCHAR(255)

Event constant representing the type of Event

EXPIRY_TIME

TIMESTAMP

Event expiry time

SERVICE_GUID

VARCHAR(255)

The service instance GUID

TPS_NAME

VARCHAR(255)

The Peer Server name

TEXT_DATA

VARCHAR(255)

Event Text

BYTES_DATA

IMAGE

BLOB field representing user event data

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.