Configure Sentinel

Datastore generates events on data injection, extraction, collections deleted, and partition management. A connection to Sentinel can be set up to supervise the entire process.

Sentinel provides:

  • Real-time business monitoring
  • Access to the event messages generated by Datastore and displayed in Sentinel dashboards. You can customize these messages to aggregate events in a business perspective.

To enable and configure Sentinel monitoring:

  1. Install Sentinel 4.0
  2. Import Tracked Objects and Request definitions into Sentinel
  3. Define the Sentinel component in Administration
  4. Connect with Sentinel

Import Tracked Objects and Request definitions into Sentinel

Start the Sentinel Server if it is not running and go to the <SentinelInstallationDirectory>/Sentinel/tools in the Sentinel installation directory. Execute the updateRepository script with the unlockImportMode argument:

  • On Windows: updateRepository.bat -unlockImportMode
  • On UNIX/Linux: ./updateRepository -unlockImportMode

Import the deployment package provided by Datastore:

  • On Windows: updateRepository.bat -import -path <DatastoreInstallationDirectory>/Datastore/extra/Sentinel/<language>/deploymentContainer, where <language> is French or English
  • On UNIX/Linux:./updateRepository -import -path <DatastoreInstallationDirectory>/Datastore/extra/Sentinel/<language>/deploymentContainer, where <language> is French or English

Tracked objects definition

The following is a list of Tracked Objects for Datastore and their attributes:

Common to all events

  • ProductName - Component name (Datastore)
  • CycleId - Cycle identifier used to link processes
  • EventDate - Date when the notification was sent (not available in Datastore API)
  • EventTime - Time when the notification was sent (not available in Datastore API)
  • IsException - 0 or 1
  • ReturnCode - Error code
  • ReturnMessage - Error message

Collection events

  • ApplicationName - Application name
  • CollectionTypeName - Collection type name
  • CollectionTypeVersion - Collection type version
  • CollectionIdentifier - Collection identifier (SYS.ID value formatted as a string)
  • Profile - Profiles parameter
  • Service - Dstools service name. INJECT / DELETE_COLLECTION.
  • Operation - Service = INJECT (IMPORTING, COMMITING)
  • Operation - Service = DELETE_COLLECTION (DELETING)
  • Step = STARTED / FAILED / ENDED
  • InputFile - The input file name path, or empty, in case of standard input
  • CollectionTypeIdentification - Defines how the collection is identified. NAME / NAME_VERSION / CONDITION
  • CollectionTypeConditionFile - Absolute path of the properties file used to compute collectionType conditions
  • CollectionProperties - Collection properties as a properties file
  • RecordCount - Number of injected records
  • RecordsPerType - Number of records per type
  • ObjectsPerType - Number of objects per type
  • ErrorCount - Number of DSErrors generated at import time

Partition events

  • ApplicationName - Application name
  • Partition - Partition identifier
  • Space - Space that contains partition
  • Operation - CREATE / CONTEXT UPDATE
  • Step - STARTED / FAILED / ENDED /[NONE]
  • Availability - Partition availability
  • CollectionDateStart - Collection date min value
  • CollectionDateEnd - Collection date max value
  • BusinessDateStart - Business date min value
  • BusinessDateEnd - Business date max value
  • RetentionPeriod - Retention period defined by the user
  • OnlinePeriod - Online period defined by the user

Extraction events

  • ApplicationName - Application name
  • Path - Query folder path / query name
  • Operation - EXTRACT
  • Step - STARTED / FAILED / ENDED
  • Parameters - All parameters including query settings
  • RecordNumber - The number of records in the output file
  • FileName - Output file name

Define the Sentinel component in Administration

In Administration, define an external component that corresponds to the Sentinel installation. For more details and instructions, refer to Manage external components.

Connect with Sentinel

Open the Datastore component in Administration and add a Sentinel connector to it. For more details and instructions, refer to Sentinel Monitoring.

Monitor Datastore using Sentinel

  1. Ensure that all components are started:
    • Sentinel server
    • Sentinel application server
    • Datastore Client application server
  2. Perform some actions using Datastore.
  3. Monitor actions using the Sentinel interface.
  4. In the Monitoring tab, execute queries from the Datastore folder to display the corresponding notifications.

Use a third-party monitoring tool

You can use a third-party monitoring tool to monitor Datastore Runtime activities.

In order to do that, you have to:

  • Develop a connector that implements the Datastore monitoring interface
  • Define this connector as the monitoring tool in the configuration

This process is detailed in the "Custom Monitoring Service" section of the file <Install>/Datastore/DatastoreRuntime/extra/java/readme.txt.

 

Related Links