This document provides a detailed, step-by-step guide for installing and configuring IANN Monitor 6.4. It ensures the seamless deployment of all core components, including Elasticsearch, Kibana, UI modules, and IANN Monitor agents.

By following this guide, you will be able to:

1. Install and configure the IANN Monitor server components
2. Set up and integrate all necessary client agents
3. Enable essential alerting and monitoring capabilities

Before proceeding, please review the Prerequisites section to verify that your environment satisfies all requirements for a successful installation.

1. Prerequisites and System Requirements

Before installing IANN Monitor 6.4 lite, ensure that your environment meets all system requirements, and that all required packages, files, and user permissions are in place.
Failure to meet these prerequisites may lead to installation failures or unexpected runtime issues.

The following requirements are mandatory to successfully install and operate the IANN Monitor solution in your environment.

1.1 Deployment Architecture

IANN Monitor requires two Servers, each with specific roles and responsibilities:

1.2 Operating System Requirements (both servers)

1. Windows 8,10 ,11

1.3 IANN Monitor Server and Client Specifications

1.4 Pre-requisites

1.5 Network & Port Requirements

The following ports must be open and accessible between the IANN Monitor components and any required database or application integrations:

1.6 Required Packages and Files:

Before proceeding with the installation of IANN Monitor, ensure that the following software packages and security files are available and verified.

 Note: Ensure these files are present in the target environment with proper ownership and permissions before beginning installation.

1.7 Prerequisite – NSSM Installation:

NSSM (Non-Sucking Service Manager) is a free and open-source utility for Windows that lets you run any non-service application (like a .jar, .exe, .bat, or a script) as a Windows Service.

Here are the steps to install NSSM (Non-Sucking Service Manager) on Windows:

Step 1: Download NSSM

1. Go to the official NSSM download page:
   1. https://nssm.cc/download

2. Choose the correct version for your OS:
   1. For most users, download the 64-bit version (e.g., nssm-2.24.zip).

Step 2: Extract the ZIP File

1. Right-click the downloaded ZIP file.
2. Select Extract All… and extract it to a location like C:\nssm.

Step 3: Verify NSSM Installation

To check if NSSM is installed and working:

1. Navigate to win64 in nssm installed folder from command prompt and enter the command below.

     2. You should see output like below along with usage details.

 NSSM: The non-sucking service manager

 Version 2.24 64-bit, 2014-08-31

     This confirms that NSSM is installed correctly.

2. Windows Installation Steps

This section outlines the step-by-step procedure for installing and configuring IANN Monitor 6.4 lite. Please follow the instructions carefully to ensure a successful deployment.

Extract Installation Package

Step 1: Right-click on the IANN_Monitor.zip file and select “Extract All…”. Choose a destination folder and click “Extract” to unzip and extract its contents.

Once extracted, you will find two primary archives under the IANN_Monitor directory:

IANN_Monitor/

└── IANN_Monitor_Client.zip

3. Client Deployment

This section outlines the steps for deploying the IANN Monitor client components and configuring their respective beats.

The client server will be the same server where Sterling Integrator is installed. Ensure that all client agents are uploaded to this server before you begin the configuration (section 3.2).

IANN Monitor Client Directory Structure

After extraction, the IANN_Monitor_Client directory will contain the following files and folders:

IANN_Monitor_Client/

• IANN_Monitor_API.jar
• application.yml
• config.ini
• monitor-agent-vm.zip
• encryptInput.zip

Client Components & What They Collect:

3.1 Upload Client Package and Unzip IANN_Monitor_Client.zip

Step 1: Upload IANN_Monitor_Client.zip to the designated Server machine.
The directory path where IANN_Monitor_Client.zip is uploaded will be referred to as <Client_Install_dir> throughout this Client deployment.

Step 2: From < Client_Install_dir>, extract the package.

3.2 Encrypting Password

The IANN Monitor application does not store sensitive values like passwords in plain text. Instead, it uses an encryption tool, so these values are saved in a secure, encoded format.

For example, instead of writing:

password: mysecretpassword

you’ll store something like:

password: TtjVcSpUPstVC3BYUTbGRrg1+4UKaeZJZd+KUF5mjkA=

This makes it harder for anyone to misuse your passwords even if they get access to your configuration files.

How to encrypt your sensitive values

Step 1: Go to the IANN Monitor installation directory. This is where your encryptInput.zip file is located.

Step 2: Unzip the Encryption Tool

Right-click on the encryptInput.zip file.

Select “Extract All…” from the context menu.

Step 3: Run the encryption tool

Navigate to the IANN Monitor Server folder from command prompt and run the following command.     

                     encryptInput/encryptInput.exe

Step 4: Follow the prompt to encrypt your value

When you run the tool, it will ask you:

Enter password:

       type the value you want to encrypt

       Example : 

       Enter password: mysecretpassword

       It will give you an encrypted string like:

EQHGuVfEHaxJQLfiXSgunZfYfjJqErrPBrmQTdTSuhNUpxG6to8YQOwp8yGqFIg2

3.3 Configure application.yml and Deploy IANN_Monitor_API.jar

Step 1: Go to IANN_Monitor_Client and locate application.yml for updating the configurations.          

Step 2: update the application.yml to define API port and database connectivity details

server:
  port: 8180    # Port on which jar needs to be run
 
spring:
  servlet:
    multipart:
      max-file-size: 1GB
      max-request-size: 1GB
  datasource:
    type: com.zaxxer.hikari.HikariDataSource
    url: <SI_database_url>
   username: <SI_db_user>
    password: ${PASSWORD}
    driver-class-name: <driver_class>
    hikari:
      connection-timeout: 120000
      minimum-idle: 5
      maximum-pool-size: 15
      auto-commit: false
  jpa:
    show_sql: false
    open-in-view: false
    database-platform: org.hibernate.dialect.OracleDialect

    properties:
      id:
        new_generator_mappings: true

Details to update in your application.yml:

1. Port:
   This is the HTTP port on which your Spring Boot application will run.

Example:

     server.port = 8180

2. URL:
    This is the JDBC connection URL that tells your application how to connect to the database.

You will need to update:

1.    Host: the database server hostname or IP

2.    Port: the port number on which your database is listening

3.    Database Name: the name of your database or service

4.    Schema: the schema application will be used.

This table shows how the JDBC URL differs for each supported database. Adjust the URL accordingly for the Sterling Integrator database.

3. Username:
   This is the database username that your application will use to connect to the database.

Example:

            username = my_db_user

4. Password:

For security reasons, the encrypted database password should not be stored directly in the YAML configuration file. Instead, it must be passed securely through environment variables.

Note: To encrypt the password, refer to section 3.2 – Encrypting Password in the documentation.

Before running the IANN_Monitor_API.jar, make sure to export the encrypted SI database password as an environment variable.
 For now, proceed with encrypting the SI database password and store it securely so it can be exported in Step 3.

5. driver-class-name:

           Update the driver class name as per the table below.

Step 3: To install the jar, Open Command Prompt from NSSM Folder

1. Navigate to the nssm folder.
2. Open the win64 subfolder.
3. Click on the address bar, type cmd, and press Enter to open the Command Prompt window in that directory.

Step 4: In the Command Prompt window, to export the encrypted SI database password run the command below.

set PASSWORD=Encrypted_SI_DB_Password

enter the following command to begin installing the IANN_Monitor_API service:

nssm install IANN_Monitor_API

1. In the NSSM service installer window that appears, click on the three dots next to the Path field.
2. In the “Path” field, browse and select the java.exe file (usually located inside the Java/bin directory).
3. In the “Startup directory” field, select the folder where the IANN Monitor API JAR file is located.
4. Provide “–jar” in arguments field of NSSM
5. Click OK to confirm.

Step 5: To start IANN_Monitor_API, Go to services in task manager and search for IANN_Monitor_API. Right click on the IANN_Monitor_API and then start it, it will come to running state.

3.4 Client Agents Config Setup

The config.ini file is required for all agents. It provides essential configurations such as Elasticsearch connection details, Client DB Connector settings, and scheduling intervals for collecting various data points. This ensures that the agents know where to send the collected data, how to connect to the database, and how frequently to gather each type of metric.

Make sure to make the following changes in the config file by following the steps below.

1. Elasticsearch Configuration [elasticsearch]
2. Logfile configuration [log_file]
3. Enable Monitoring configuration [enable_monitoring]
4. Heartbeat Configuration [heartbeat]
5. appdata Configuration [appdata]
6. Database Health Check Configuration ([db_healthcheck])
7. Sterling Reports Configuration ([sterling_reports])
8. PCM Stats Configuration ([pcm_stats])
9. Queue Watcher Configuration
10. Systemstats configuration([systemstats])
11. Silogparser Configuration([silogparser])

Step 1: Go to IANN_Monitor_Client installation directory.

Step 2: Open the config.ini file to update the required settings.

Step 3: Configure Elasticsearch settings.

In the [elasticsearch] section of your config.ini, you only need to

update the following fields:

index, url, port,username, and password.

1. Index – This is the index prefix used to differentiate Elasticsearch indices across various environments.

Example: index = iann_test_qa

2. Url -This is the complete HTTPS URL (or HTTP if SSL is not used) to reach your Elasticsearch cluster.

Example: url = https://0.0.0.120:9200/

3. Port – This is the network port on which your Elasticsearch instance is listening.

Example: port = 9200

4. username – The Elasticsearch username that the agent will use to

              authenticate.

 Example: username = elastic_user

5. password – The encrypted password for the Elasticsearch user.

              Example: password = DTwZ0UoOt056TyX4hxQAb5h4=

Note: To encrypt password refer to – 3.2 Encrypting Password

Step 4: Configure Logfile Configuration [log_file].

[log_file]
log_file_path =

This setting defines the directory where log files will be stored.
 By default, it is left empty, meaning all log files will be created in the directory where the agent is executed.
 If a specific path is provided, the logs will be generated at the specified location instead.

Example:

Log_file_path = /opt/IANN_Monitor/logs/

Step 5: Configure Enable Monitoring Configuration [enable_monitoring].

[enable_monitoring]
application_monitoring=true
vm_metrics_monitoring=true
log_monitoring=true

1. application_monitoring includes SI application checks, DB health check, Sterling reports, queue watcher, heartbeat, and PCM stats.
2. vm_metrics_monitoring includes server metrics monitoring.
3. log_monitoring checks for error logs.

To disable any of these, set the value to false.

Example:

log_monitoring=false

Step 6: Configure Heartbeat configuration .

By configuring url and server ip here one can monitor the status of application and server.

[heartbeat]
ip = [“0.0.0.0;server1”]
schedule_heatbeat_seconds = 60
urls = [“https://host_ip:port;test_application”]
timeout_seconds = 3

In the [heartbeat] section of your config.ini, you need to update

ip,urls,schedule_heatbeat_seconds and timeout_seconds

1. ip = [“<IP>;Server Name”]
    Specify the server IP address and its name.

Example:
 ip = [“127.0.0.1:1;WebServer1”, “127.0.0.2.11;DatabaseServer”, “127.0.0.1.12;CacheServer”]

2. urls = [“url;Application Name”]
   Provide the application URL along with a descriptive name.

Example:
urls = [“https://webapp.company.com;WebApp“, “http://api.company.com;APIService“, http://auth.company.com;AuthService]

3. schedule_heatbeat_seconds = 60
   This sets how often (in seconds) the heartbeat checks run. The default is 60 seconds, but you can update it if you want health checks to run more or less frequently.

Example:

Schedule_heatbeat_seconds=300

   4. timeout_seconds=3

 This sets how long (in seconds) the agent waits for a response from the server.
 If no response is received within this time, the URL is marked as down (status = 0).

Example:

timeout_seconds=5

Step 7: Configure appdata settings.

[appdata]
si_version = <si_version>
username = iann_monitor
password = Ae9gUiEB/y1N5vs1zOkimYu9RDpwBdBBvqhUcFMwntUQFX3B2cocH9SzmJE=
api_host = http://<api_host>:<port>
db_type =<db_type>
halted_count_seconds=60
adapter_status_seconds=60
purge_seconds=60
schedulers_status_seconds=60
adapter_list =(‘adapter1′,’adapter2’)
schedulers_list = (‘scheduler1′,’scheduler2’)In the [appdata] section of your config.ini, you only need to update

si_version,api_host,username,password,db_type,adapter_list,schedulers_list

1. si_version:

Set the Sterling Integrator Version.

Example:

si_version = 6.1.0.0

2.api_host:

The api_host IANN_Monitor_API.jar to which the agents connect to and fetch the data.

Example:

api_host = http://apiurl:9090

2.username & password :

Credentials to authenticate with the IANN_Monitor_API.

Set default username – iann_monitor

Set the default password to ‘password’ and ensure it is encrypted.

Note : To encrypt password refer to – 3.1 Encrypting Password

Example:

username = iann_monitor

password = 8o3DjuRtTlvaqzbehivjk75p

3.db_type:

Specify the database type used by Sterling Integrator:

1. set db2 for DB2,
2. oracle for Oracle,
3. and sql_server for SQL Server

Example:

db_type = DB2

4. adapter_list, schedulers_list:

adapter_list – provide any 2 adapters which need to be monitored.

Example:

adapter_list = (‘FileAdapter’,’FTPAdapter’)

schedulers_list – provide any 2 scheduler which need to be monitored.

Example:

schedulers_list = (‘NightlyCleanupScheduler’,’DataSyncScheduler’)

5. Scheduling:

Configure the schedule for the following data points so that the agent collects data at the specified intervals.

halted_count_seconds, adapter_status_seconds, purge_seconds, schedulers_status_seconds

Example:

halted_count_seconds=60
adapter_status_seconds=60
purge_seconds=60
schedulers_status_seconds=60

Step 8: Configure Database Health Check Configuration [db_healthcheck]

[db_healthcheck]
cpu_util_seconds=60
database_check_seconds=60
ram_util_seconds=60
db_response_time_seconds=60
active_sessions_seconds=60
inactive_sessions_seconds=60
total_sessions_seconds=60
mailboxes_with_unextracted_messages_seconds=60

Configure the schedule for the following data points so that the agent collects data at the specified intervals.

cpu_util_seconds, database_check_seconds, ram_util_seconds, db_response_time_seconds, active_sessions_seconds, inactive_sessions_seconds, total_sessions_seconds, mailboxes_with_unextracted_messages_seconds

Example:

cpu_util_seconds=60

database_check_seconds=60

ram_util_seconds=60

db_response_time_seconds=60

active_sessions_seconds=60

inactive_sessions_seconds=60

total_sessions_seconds=60

mailboxes_with_unextracted_messages_seconds=60

Step 9: Configure sterling_reports settings.

[sterling_reports]
long_running_bp_seconds=60
ca_certs_seconds=60
system_certs_seconds=60
long_bp_time_seconds=60

1. Configure how often (in seconds) the agent collects each of these data points.

long_running_bp_seconds, ca_certs_seconds, system_certs_seconds

Example:

long_running_bp_seconds=60

ca_certs_seconds=60

system_certs_seconds=60

2. long_bp_time_seconds – Retrieves business processes that have been running longer than the specified number of seconds.

Step 10: Configure pcm_stats settings.

[pcm_stats]
application_ref_query_seconds=60
tp_ref_query_seconds=60

Configure how often (in seconds) the agent collects each PCM stats data point.

application_ref_query_seconds, tp_ref_query_seconds

Example:

application_ref_query_seconds=60

tp_ref_query_seconds=60

Step 11: Configure queuewatcher_node settings.

Configuration Parameters to be updated:

[queuewatcher_node1]
index = node1
queue_url = http://<queuewatcher-host>:<queuewatcher-port>/queueWatch/
username = <queuewatcher_username>
password = <queuewatcher_encrypted_password>

queue_names=q1,q2

pool_names=CM_FRAMEWORK,db2Pool

schedule_threads_seconds = 60
schedule_queuewatcher_seconds = 60
[queuewatcher_node2]
index = node2
queue_url = http://<queuewatcher-host>:<queuewatcher-port>/queueWatch/
username = <queuewatcher_username1>
password = <queuewatcher_encrypted_password>

1. index = node1
   Name of the queuewatcher node – node1 or node2
2. queue_url = http://120.0.0.0:50000/queueWatch/ 

The endpoint URL that the agent polls to fetch queue data.

3. username = user1
    Username used for authenticating requests to the queue_url endpoint.
4. password = aBc123XyZ456+==sDfGhJkLmN0
    Password used for authenticating requests. (Should ideally be stored securely or encrypted.)
5. Queue_names = q1,q2

specify the names of queues separated by commas to track their queue depths.
 Note: Monitoring is restricted to a maximum of two queues.

6.  pool_names=CM_FRAMEWORK,db2Pool

specify the names of pools separated by commas to track their used connections and total connections.
Note: Monitoring is restricted to a maximum of two pools.

7. schedule_threads_seconds = 60
    Interval (in seconds) at which the agent schedules general thread-related tasks.
8. schedule_queuewatcher_seconds = 60
    Interval (in seconds) at which the agent polls the queue_url to collect queue data.

You will configure a separate block for each node.

If you have 1 node, add only this section:

Example:

[queuewatcher_node1]

index = node1

queue_url = http://120.0.0.0:50000/queueWatch/ 

username = user1

password = aBc123XyZ456+==sDfGhJkLmN0

schedule_threads_seconds = 60

schedule_queuewatcher_seconds = 60

If you have 2 nodes, add both sections:

[queuewatcher_node1]

index = node1

queue_url = http://120.0.0.0:50000/queueWatch/ 

username = user1

password = aBc123XyZ456+==sDfGhJkLmN0

schedule_threads_seconds = 60

schedule_queuewatcher_seconds = 60

[queuewatcher_node2]

index = node2

queue_url = http://120.0.0.1:50000/queueWatch/ 

username = user2

password = zYx987WvU654/TuRqPoLmNkJiHg

Step 9: Configure systemstats configuration [systemstats].

[systemstats]
metrics_seconds = 60
server_name=node1
environment=general
os=linux

metrics_seconds – Defines how often (in seconds) the agent collects metrics data.

server_name – Specifies the name of the Sterling Integrator server node (e.g., node1 or node2).

environment – Indicates the environment name; default is general.

os – Specifies the operating system of the server (either linux or windows).

Step 10: Configure silogparser settings.

[silogparser]
logs = [{‘path’: “/opt/IBM/SterlingIntegrator/logs/.log”, ‘application’: “si”}]
log_modified_milliseconds = 31536000000
schedule_logparser_seconds = 1800
error_list = [“ERROR”, “Error”, “error”, “ERRORDTL”, “OutOfMemory”, “outofmemory”, “Outofmemory”, “OUTOFMEMORY”, “errors”]
Configuration Parameters to be updated:

1. logs: List of log file paths and the application name.
    You can add multiple entries to monitor different logs, for example:

logs = [
  {‘path’: “/path/to/logs1/*.log*”, ‘application’: “si”}
   ]

Note : here the list of log path monitored is restricted to only one.

2. log_modified_milliseconds: The time window (in milliseconds) to consider a log file as recently modified (here set to 1 year).
3. schedule_logparser_seconds: Frequency in seconds to run the log parser.
4. error_list: List of keywords to look for in logs to catch errors.

3.5 Installation of monitor-agent-vm Agent:

Step 1: Extract monitor-agent-vm.zip and Open Command Prompt from the NSSM Folder

1. Go to the IANN_Monitor_Client path where the monitor-agent-vm.zip file is located. Right-click on monitor-agent-vm.zip and select Extract All
2. Navigate to the nssm folder.
3. Open the win64 subfolder.
4. Click on the address bar, type cmd, and press Enter to open the Command Prompt window in that directory.

Step 2: Install the monitor-agent-vm Package

In the Command Prompt window, enter the following command to begin installing the monitor-agent-vm service:

nssm install monitor-agent-vm

1. In the NSSM service installer window that appears, click on the three dots next to the Path field.
2. Browse and select the monitor-agent-vm.exe located in the server folder.
3. Click OK to confirm.

Step 3: To start monitor-agent-vm, Go to services in task manager and search for monitor-agent-vm. Right click on the monitor-agent-vm and then start it, it will come to running state.

Step 4:

Go to the monitor-agent-vm package location and open the “monitor-agent.log” text document and verify the logs for any errors or exceptions and then validate the time of the logs with the current time.

2025-08-05 19:14:52 INFO     Reading configurations completed
2025-08-05 19:14:52 INFO     DB Configured is Oracle
2025-08-05 19:14:52 INFO     sending the api request of database_response
2025-08-05 19:14:53 INFO     Response of db_response_time api 200
2025-08-05 19:14:53 INFO     Db_response_time Data Sent to the elasticssearch
2025-08-05 19:14:53 INFO     sending the api request of active_sessions
2025-08-05 19:14:54 INFO     Response of active_sessions api 200
2025-08-05 19:14:54 INFO     Active_sessions Data Sent to the elasticssearch
2025-08-05 19:14:54 INFO     sending the api request of inactive_sessions
2025-08-05 19:14:55 INFO     Response of inactive_sessions api 200
2025-08-05 19:14:56 INFO     Inactive_sessions Data Sent to the elasticssearch
2025-08-05 19:14:56 INFO     sending the api request of total_sessions
2025-08-05 19:14:57 INFO     Response of total_sessions api 200
2025-08-05 19:14:57 INFO     Total_sessionsData Sent to the elasticssearch
2025-08-05 19:14:57 INFO     Inside long_running_bp method
2025-08-05 19:14:58 INFO     Response of long_running_bp api 200
2025-08-05 19:14:58 INFO     Long running bp has no data
2025-08-05 19:14:58 INFO     sending the api request of mailbox_with_unextracted_messages
2025-08-05 19:14:59 INFO     Response of mailboxes_with_unextracted_messages api 200
2025-08-05 19:14:59 INFO     Mailboxes_with_unextracted_messages  has no data
2025-08-05 19:14:59 INFO     sending the api request of HaltedCount
2025-08-05 19:15:00 INFO     Response of halted count api 200
2025-08-05 19:15:00 INFO     Halted countData Sent to the elasticssearch
2025-08-05 19:15:00 INFO     sending the api request of adapterstatus
2025-08-05 19:15:01 INFO     Response of adapter_status api 200
2025-08-05 19:15:01 INFO     Adapter statusData Sent to the elasticssearch
2025-08-05 19:15:01 INFO     sending the api request of schedulers_status
2025-08-05 19:15:02 INFO     Response of schedulers_status api 200
2025-08-05 19:15:02 INFO     Schedulers_statusData Sent to the elasticssearch
2025-08-05 19:15:02 INFO     Inside ca_cert method
2025-08-05 19:15:03 INFO     Response of ca_cert api 200
2025-08-05 19:15:04 INFO     ca certs Data Sent to the elasticssearch