IANN Monitor Windows Installation

Introduction to the Guide

This installation guide provides detailed, step-by-step instructions for setting up the IANN (Intelligent Artificial Neural Network) platform and its associated components. The purpose of this guide is to ensure a smooth and error-free installation process, enabling users to quickly configure the environment and start leveraging the system’s capabilities.

What is IANN?

IANN (Intelligent Artificial Neural Network) is Pragma Edge’s AI-powered unified platform designed to bring intelligence, automation, and predictive analytics into business operations. It combines file tracking, monitoring, and AI-driven insights to ensure end-to-end visibility, operational efficiency, and proactive issue resolution

IANN plays a key role in driving digital transformation across industries by turning traditional data exchanges into intelligent, insight-driven processes.

IANN is built as a modular system with three primary components:

  1. FileGPS – Tracks and monitors file transactions across systems for visibility and SLA compliance.
  2. Monitor – Provides real-time monitoring of processes, system health, and metrics with alerts.
  3. AI – Adds intelligence through predictive analytics, anomaly detection, and GenAI insights.

Who should use this Installation Guide?

This installation guide is designed for a wide range of technical users involved in deploying, maintaining, or supporting IANN solutions. The intended audience includes:

  1. System Administrators / DevOps Engineers
  • Primary audience.
  • Responsible for deploying, configuring, and maintaining the software in different environments (development, staging, production).
  • Use the guide to ensure all prerequisites, system settings, and deployment steps are correctly followed.
  1. IT Support Teams / Technical Support Engineers
  • Use the guide to troubleshoot installation-related issues reported by end users or internal teams.
  • May use it to replicate the installation process for issue diagnosis.
  1. Software Developers
  • Particularly when working in teams or setting up the project locally.
  • Use the guide to set up their development environments and test deployments.
  1. Customers / End Users (for On-Premises Software)
  • If the product is delivered for self-hosting, customers’ technical teams use the installation guide.
  • Often non-developers with technical backgrounds follow these instructions.
  1. Consultants / System Integrators
  • Third-party professionals who assist organizations in setting up and customizing the product.
  1. QA Engineers / Testers
  • Use the guide to install and configure the software in test environments to validate features or bug fixes.

What this Installation Guide Covers?

This guide serves as a comprehensive manual for deploying and configuring the IANN platform in various environments (Linux, Windows, OpenShift). It covers the following:

  1. Purpose and Overview of IANN
  • Clarifies the objective of the document and introduces the IANN FileGPS platform.
  1. System Architecture and Deployment Models
  • Details the architecture of IANN FileGPS and how it integrates with the broader ecosystem.
  1. Step-by-Step Installation Instructions
  • Linux Installations: Covers UI, Server, Rest Consumer, and Client Server deployments.
  • Windows Installations: Includes setup with NSSM, password encryption, component deployments, and validation.
  • OpenShift Installations: Provides detailed guidance on Helm charts, UI/backend configurations, and deployment steps.
  1. Anomalies Detection Modules
  • Deployment instructions for File Anomalies and Transaction Anomalies, supporting both Linux and Windows environments.
  1. IANN Monitor Deployment
  • Instructions for installing IANN Monitor on Linux, Windows, and OpenShift.
  • Includes pre-requisites, system validation, Helm-based deployments, and anomaly detection features.
  1. IANN File Transaction Search
  • Covers deployment and configuration of the File Transaction Search module across platforms.

Each section includes detailed prerequisites, component-level configuration, and post-deployment validation steps to ensure successful setup and operation of IANN in production and non-production environments.

1. Introduction to IANN Monitor

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.1 Context Diagram of IANN Monitor:

The IANN Monitor Context Flow illustrates how the core components within the Monitor module interact with each other and with external systems to deliver real-time monitoring and alerting capabilities. It explains the structure of Monitor and the sequence of operations that enable proactive system health tracking and anomaly detection.

A screenshot of a computer AI-generated content may be incorrect.

IANN Monitor Context Flow Description:

1.    User Interaction & Visualization via IANN Monitor UI:

Users interact with the IANN Monitor UI to visualize real-time alerts and periodic weekly reports. The UI acts as the frontend layer and retrieves data directly from Elasticsearch over port 9200. This enables users to monitor system health, application performance, and recent alert history in an intuitive dashboard.

2.    UI Functional Components & Notification Channels

The UI is structured into two major functional components:

  •  Alerts Processing: Responsible for detecting critical events and initiating alert notifications as soon as data breaches configured thresholds.
  •   Weekly Reports Module Automatically generates weekly summaries from stored monitoring data for review and audit purposes.

Once alerts are processed, they are dispatched via integrated outbound channels:

a.     Microsoft Teams via channel email ID

b.    Slack via webhook URL

c.     Email alerts via SMTP

d.    Incident management tools like PagerDuty, X Matters, and ServiceNow using HTTP POST APIs

3.    Elasticsearch – Central Data Processing and Storage Layer

Elasticsearch serves as the core data indexing engine. It receives logs and metrics from all connected clients and stores them for analysis and retrieval. It supports both live queries from the UI and backend alert rule evaluation.

All communication with Elasticsearch occurs over port 9200, enabling secure and consistent data ingestion and querying.

4.    IANN Monitor Clients – Data Ingestion and Processing Pipeline

The data collection clients are composed of the API Jar and multiple client binaries. These components operate as follows

a.     Establish a connection with the SI Oracle Database using port 1521

b.    Collect live performance metrics through application endpoints via port 8180

c.     Parse and structure the collected data

d.    Forward the formatted data into Elasticsearch over port 9200 for storage and monitoring

5.    SI Application Integration & Log Monitoring

The SI Application writes logs into the underlying Linux File System.

a.     A log monitoring agent continuously scans and parses new log entries

b.    Structured log data is pushed to Elasticsearch

Alerts are triggered based on log-based thresholds or anomaly detection rules

2. IANN Monitor - Windows Installation Guide

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, 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:

Server Role

Description

  Server

Hosts the IANN Monitor UI, Elasticsearch, Kibana, and all supporting UI integrations.

  Client

Deployed on the server where Sterling Integrator is installed. Hosts the IANN Monitor client agents and API JAR module.

 

1.2 Operating System Requirements (both servers)

1.    Windows 8,10 ,11

1.3 IANN Monitor Server and Client Specifications

 

Instance Type

Components

Cores

RAM

Disk Space

IANN Monitor Server

Elasticsearch (v8.x or higher), Kibana (v8.x or higher), UI v6.x

4 Core

16 GB

C Drive-100GB/Application- 300GB

IANN Monitor Client

API, Appdata, DB healthcheck, Sterlingreports, PCMstats ,queuewatcher,systemstats

4 Core

8 GB

D Drive- 100 GB / Application- 100 GB

 

1.4 Pre-requisites

Software / Certificate

Specific Version

Required

Installation Instructions / Notes

Java

IBM Semeru OpenJDK 17.0.8+7 (LTS)

Yes

Installation Setup Guide

Elasticsearch

Elasticsearch v.8.x.x or higher

Yes

Refer to Section – (3. Installation Steps) in this document

Kibana

Kibana v.8.x.x or higher

Yes

Refer to Section – (3. Installation Steps) in this document

NSSM

NSSM v.2.24

Yes

Refer to Section – (2.7 Prerequisite – NSSM Installation) in this document

 

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:

Port

Description

Required On

9200

Elasticsearch HTTP/HTTPS

Server

5601

Kibana HTTP/HTTPS

Server

8080

IANN Monitor UI (default, configurable)

Server

9090

IANN Monitor API (default, configurable)

Client

8444, 10000

SSP Adapter / DB ports (as defined in config.ini)

Client / As needed

 

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.

 

File / Package

Description

Source

IANN_Monitor.zip

Complete IANN Monitor installation bundle

Download from the designated S3 bucket provided by the IANN Monitor Team.

Security certificates (.crt, .key,.ca-bundle)

TLS/SSL certificates, private keys, and CA bundles are required for secure HTTPS communication.

Supplied by the customer or enterprise security team.

 

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:

a.     https://nssm.cc/download

 

2.    Choose the correct version for your OS:

a.    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.

nssm version


     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. Installation Steps

This section outlines the step-by-step procedure for installing and configuring IANN Monitor 6.4. 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_ Server.zip

└── IANN_Monitor_Client.zip

 

2.1 Upload Server Package and Extract IANN_Monitor_Server.zip

Step 1: Upload IANN_Monitor_Server.zip to the designated Server machine.

     The directory path where IANN_Monitor_Server.zip is uploaded will be referred to as <Install_dir> throughout this documentation.

Step 2: From <Install_dir>, extract the ZIP package using File Explorer:

1.    Right-click on IANN_Monitor_Server.zip Select “Extract All…”

IANN Monitor Server Directory Structure

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

IANN_Monitor_Server/

·       IANN_Monitor.jar

·       application.yml

·       config.ini

·       logo.png

·       nodata.png

·       default_dashboard.zip

·       encrypt.zip

·       Heartbeat.zip

·       systemstats.zip

·       teams.zip

·       slack.zip

·       weekly_report.zip

·       alerts.zip

·       send_mail.zip

Purpose of Each Server Component:

The following table provides an overview of key files and packages included in the IANN Monitor installation bundle. Each component serves a specific role in enabling monitoring, alerting, reporting, and automation functionalities.

Component

Description

IANN_Monitor.jar

The main IANN Monitor application JAR.

application.yml

Contains configuration settings for IANN_Monitor.jar.

config.ini

Configuration file for server agents (database, scheduling, etc.).

logo.png

Logo image displayed on the IANN Monitor UI.

nodata.png

Image used in weekly reports to indicate “no data”.

default_dashboard.zip

Used to create default dashboards in the IANN Monitor application.

encrypt.zip

Tool for encrypting passwords in your config files.

Heartbeat.zip

Agent to monitor server and application status (via URL checks).

systemstats.zip

Agent to collect server metrics like CPU, RAM, disk, and network.

teams.zip

Sends environmental health reports and critical alerts to Microsoft Teams.

slack.zip

Sends environmental health reports and critical alerts to Slack.

weekly_report.zip

Generates and sends automatic weekly reports showing trends.

alerts.zip

Responsible for managing and processing triggered alerts.

send_mail.zip

Sends alert notifications by email.

 

2.2 Installing and Setting Up Elasticsearch Without Security Certificates (SSL):

This section guides you through the initial setup and configuration of Elasticsearch.

Step 1: Download Elasticsearch from Elasticsearch 8.12.2 | Elastic

A screenshot of a computer  AI-generated content may be incorrect.

Step 2: After downloading, move the Elasticsearch file to the following location:
 <Install_dir>\IANN_Monitor_Server.

Step 3: Extract the Elasticsearch zip package.

Step 4: After extraction, go to the config folder located inside the Elasticsearch directory.

A screenshot of a computer  AI-generated content may be incorrect.

           A screenshot of a computer  AI-generated content may be incorrect.

   Step 5: Inside the config folder, open the elasticsearch.yml file using Notepad.

A screenshot of a computer  AI-generated content may be incorrect.

Step 6 :Update the following basic configuration settings in elasticsearch.yml file.

 

cluster.name: “<cluster_name>”

network.host: 0.0.0.0

http.port: 9200

discovery.seed_hosts: [“127.0.0.1”]  

discovery.type: single-node

xpack.security.enabled: true

 

 

 

Step 7 : To install Elasticsearch, navigate to the nssm folder and open the win64 directory. In the address bar, type cmd and press Enter to open the Command Prompt in that location.

Step 8 : In the Command Prompt, run the following command:

nssm install elasticsearch

 
This will open the NSSM service installer window.

Picture

 

Step 9: Click the three dots next to the Application Path field, then browse to the bin folder inside the Elasticsearch 8.12.2 directory and select the elasticsearch file. Then click on Install service. This will install Elasticsearch successfully.

Picture

Step 10 : To start Elasticsearch, open Task Manager and go to the Services tab. Find Elasticsearch, right-click on it, and select Start. The service will then show as Running.

Inserting image...

Step 11: Try accessing Elasticsearch in your browser.

           

http://localhost:9200

Step 12: Since we haven’t set up a username and password yet – you can simply ignore authentication.

2.3 Create or Reset the Elasticsearch Username and Password

To Reset the elastic user’s password, follow the steps below.

Step 1: Navigate to the bin directory in the command prompt.

Step 2: Run the password reset tool using the command below.

elasticsearch-reset-password -u elastic -i

 

Step 3: Follow the prompts

    The tool will display:

This tool will reset the password of the [elastic] user.
              Do you want to continue [y/N]?

Type y and press Enter to proceed.

 

Step 4: Set a new password

    You’ll then be prompted to enter a new password twice. Choose a strong, secure password.

Step 5: Verify access via browser

    After successfully resetting the password, you can test the login by opening a browser and navigating to:

http://localhost:9200/

When prompted, enter:

Username: elastic
              Password: <elasticsearch-password>

Step 6: Expected JSON output

Upon successful login, Elasticsearch will respond with JSON similar to the following:

{
 “name” : “<node-name>”,
 “cluster_name” : “<cluster-name>”,
 “cluster_uuid” : “<cluster-uuid>”,
 “version” : {
 “number” : “8.12.2”,
 “build_flavor” : “default”,
 “build_type” : “tar”,
 “build_hash” : “<build-hash>”,
 “build_date” : “2024-02-19T10:04:32.774273190Z”,
 “build_snapshot” : false,
 “lucene_version” : “9.9.2”,
 “minimum_wire_compatibility_version” : “7.17.0”,
 “minimum_index_compatibility_version” : “7.0.0”
 },
 “tagline” : “You Know, for Search”
 }

2.4 Enable SSL/TLS Encryption (Secure Connection) for Elasticsearch:

Now, to enable SSL/TLS encryption for Elasticsearch Secure access.

Step 1: Create a certs folder inside the Elasticsearch config folder of elasticsearch to store all your security certificates.

Step 2: Place your certificate files (.crt, .key, .ca-bundle) into this certs folder.

Step 3: Edit the elasticsearch.yml file, this file is located inside the config of elasticsearch folder.

Step 4: Add the following SSL settings to your elasticsearch.yml file:

xpack.security.http.ssl.enabled: true
xpack.security.http.ssl.key: /path/to/your/server.key
xpack.security.http.ssl.certificate: /path/to/your/server.crt
xpack.security.http.ssl.certificate_authorities: [“/path/to/your/ca-bundle.pem”]

Note: Replace /path/to/your/server.key, /path/to/your/server.crt, /path/to/your/ca-bundle.pem with the actual paths to your certificate files.         

Step 5: Restart Elasticsearch to apply the SSL changes.

Step 6: To restart Elasticsearch, Go to the services in task manager and search for Elasticsearch. Right click on Elasticsearch and then restart it, It will come to running state as shown below.

Inserting image...

Step 7: Finally Try to access https://localhost:9200/ from browser.  

Username: elastic

Password: <elasticsearch-password>      

2.5 Install and Configure Kibana

This section guides you through the steps to install, configure, and securely connect Kibana to Elasticsearch, including user creation and SSL configuration.

2.5.1 Extract Kibana

Step 1: Download Kibana 8.12.2 from the link below:
 https://artifacts.elastic.co/downloads/kibana/kibana-8.12.2-windows-x86_64.zip

Step 2: After downloading, move the Kibana file to the following location:
 <Install_dir>\IANN_Monitor_Server.

Step 3: Extract the kibana zip package.

2.5.2 Create Kibana User in Elasticsearch

To enable Kibana to communicate with Elasticsearch, create a dedicated user:

Step 1: In Task Manager, locate the running Elasticsearch service, right-click on it, and select Stop.

Step 2: Navigate to elasticsearch folder from the command prompt and run the following command.

/bin/elasticsearch-users useradd kibanauser -p password –r superuser,kibana_admin,kibana_system

The above command It creates a new user named kibanauser and Sets the password to password.

Step 3: Save the generated username and password securely. These credentials will be required in Section 3.5.4 to configure the elasticsearch.username and elasticsearch.password fields within the kibana.yml file.

Step 4: After creating the user, start Elasticsearch again from task manager.

 

2.5.3 Update Kibana Certificates

To enable secure HTTPS communication:

Step 1: Create the certs folder inside the kibana folder.

Step 2: move the security certificate files (.crt, .key, .ca-bundle) into this certs folder.

2.5.4 Configure kibana.yml

Edit the kibana.yml file to configure Elasticsearch URL, user credentials, and server host.

Step 1: Navigate to the config folder within the Kibana directory. This folder is located inside the extracted contents of the Kibana package.

Step 2: Update the following configuration settings in the kibana.yml file, located inside the config folder.

Picture

Note : The elasticsearch.username and elasticsearch.password are generated in section 3.5.2  

Step 3: Update the following configuration:

 

server.host: “0.0.0.0”

server.port: 5601

elasticsearch.hosts: [“https://<elasticsearch-host>:9200“]

elasticsearch.username: “kibanauser”

elasticsearch.password: “your_kibana_user_password”

Note : The elasticsearch.username and elasticsearch.password are generated in section 3.5.2  

Step 4: Add these lines for server SSL and Elasticsearch SSL verification in kibana.ym file.

server.ssl.enabled: true

server.ssl.certificate: /path/to/your/server.crt

server.ssl.key: /path/to/your/server.key

elasticsearch.ssl.certificateAuthorities: /path/to/your/ca-bundle

elasticsearch.ssl.verificationMode: certificate

And update the following settings.

1.    server.ssl.certificate with the path to the .crt file located at /config/certs inside kibana folder.

2.    server.ssl.key with the path to the .key file in the same directory.

3.    elasticsearch.ssl.certificateAuthorities with the path to the .ca-bundle file also found in this directory.

2.5.5 Start Kibana

Step 1: To install Kibana, navigate back to the nssm folder and open the win64 directory. In the address bar, type cmd and press Enter to open a Command Prompt window at that location and enter the command below.

             nssm install kibana

Step 2: Click on the three dots and select the kibana file located in the bin folder inside the kibana directory. This will install the Kibana service successfully.

To start Kibana, open Task Manager, go to the Services tab, find kibana, right-click on it, and select Start. The service status will change to Running as shown below.

Inserting image...

 

Step 3: Access the kibana URL in browser and enter username and password.

Username: elastic

Password: <provide the Elasticsearch password>

https://localhost:5601/drawing, Picture

A screenshot of a computer  AI-generated content may be incorrect.

 

2.6 IANN Monitor Application Installation

This section explains how to configure the application.yml file for the IANN Monitor application, highlighting the key settings you need to update for proper operation.

2.6.1 Generating Truststore and Keystore using Security Certificates

The IANN Monitor application uses security certificates to:

1.    Enable SSL (so that data sent over the network is encrypted)

2.    Securely connect to Elasticsearch (so it can trust the server it is talking to)

To do this, it needs two important files:

1.    A keystore, which holds the application’s own certificates used to enable SSL.

2.    A truststore, which holds certificates of systems (like Elasticsearch) the application needs to trust.

This section explains how to generate both the keystore and truststore using certificates you have already uploaded to the Elasticsearch folder.

Steps to generate truststore and keystore:

Step 1: Navigate to config/certs inside elasticsearch directory where you have placed your Security certificates from command prompt.

Step 2 :  Generate the truststore

 Run the following command from the certs directory:

keytool -import -file <your_certificate>.crt -keystore truststore.p12 -storepass password -noprompt -storetype pkcs12

 

 

What this does:

1.    keytool is a tool that comes with Java for managing certificates.

2.    -import -file <your_certificate>.crt tells it to import your certificate file (replace <your_certificate>.crt with your actual certificate file name).

3.    -keystore truststore.p12 creates a new file called truststore.p12.

4.    -storepass password sets the password to password (you can change this).

5.    -noprompt imports without asking for confirmation.

6.    -storetype pkcs12 specifies the format.

Step 3 : Generate the keystore

A keystore is used by your application to identify itself (hold its own private key and certificate) so it can enable SSL.

Run this command from the same certs directory:

openssl pkcs12 -export -out keystore-new.p12 -inkey ca.key -in ca.crt -passout pass:password -name “your_alias_name”

 

What this does:

1.    openssl pkcs12 -export creates a PKCS12 keystore file.

2.    -out keystore-new.p12 is the output file name.

3.    -inkey ca.key is your private key file.

4.    -in ca.crt is your certificate file.

5.    -passout pass:password sets the keystore password.

6.    -name “your_alias_name” is an alias you give to this entry (replace with something meaningful).

Note:

1.    Keep your truststore.p12 and keystore-new.p12 files safe.

2.    Remember the passwords you set here — you will use them in your application.yml file.

2.6.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

 

2.6.3 Default Dashboard

The Default Dashboard module in the IANN Monitor application automates the creation of dashboards and alert configurations for a given environment. This significantly reduces the manual effort required during setup and ensures a consistent, ready-to-use monitoring experience from the start — saving time and accelerating customer onboarding.

This default dashboard location needs to be specified in the application.yml file of the IANN Monitor application to enable automatic creation of dashboards and alerts.

Step 1: Before configuring the default_dashboard location in the application.yml file (as shown in later sections), you need to extract the default dashboard files to prepare it to use.

Step 2: To extract, go to IANN_Monitor_Server location.

Step 3: Extract the ZIP file by right-clicking and selecting “Extract All…”.

2.6.4 Configure application.yml  for IANN Monitor Application.

This section explains how to configure the application.yml file for the IANN Monitor application, highlighting the key settings you need to update for proper operation.

Key Sections to Update:

1.    SSL: Enable SSL for the IANN Monitor application.

2.    Port: Default is 8080. Change this if needed.

3.    FileLocation: Path to the default dashboard files, used to auto-create dashboards after installation.

4.    timeZone: Defaults to UTC. Change to CST, IST, EST, etc. as needed.

5.    defaultUser: Set the default user details like userId, firstName, and lastName.

6.    elasticSearch: Configure Elasticsearch credentials — username, password, host, port, and truststore.

7.    SMTP: SMTP settings for sending email notifications.

8.    Logo: Path to the logo file shown in the application.

9.    Saml:SSO and role mappings (if enabled)

Step 1: Go to IANN_Monitor_Server folder and open application.yml to update the configurations.

Step 2: SSL and Port Configuration:

To secure data transmission and protect sensitive information, the IANN Monitor application supports SSL.

Below is an example of how to configure SSL and set the server port in your application.yml file.

server:
  ssl:
    enabled: true
    key-store: <Install_dir>/IANN_Monitor_Server/elasticsearch-8.12.2/config/certs/keystore-new.p12
    key-store-password: <encrypted keystore password> # Replace with your encrypted keystore password
  port:  8080          # Change this if you want the application to run on a different port
  server-header: iann_monitor

 

 

1.    Make sure to replace <Install_dir> and <keystore password> with your actual values.

2.    Adjust the port if you want the application to listen on a different port.

Note : To encrypt Keystore password refer to – 3.6.2 Encrypting Password

Step 3: FileLocation Configuration:

1.    Set the default dashboard path to fileLocation under python.

python:
  fileLocation : <Install_dir>/IANN_Monitor_Server/default_dashboard/default_dashboard

 

Step 4: TimeZone Configuration:

1.    By default, the timeZoneFormat under timezone is set to UTC. Change it to CST or your preferred timezone if necessary.

timeZone:
  timeZoneFormat: UTC

 

Step 5: Default User Configuration:

Update the following in defaultUser section:

1.    userId: The unique login username for the default admin user (e.g., superadmin).

2.    firstName: First name of the user.

3.    lastName: Last name of the user.

4.    phNo: Contact phone number.

5.    emailId: Email address for this user account.

6.    status: Keep this as Y to indicate the user is active; otherwise, keep it to N.

7.    password: The password the user will use to log in (encrypted in the system after first use).

8.    role: The user’s role, typically SUPER_ADMIN for the default administrative user.

defaultUser:
  userId: <userid>
  firstName: <user_first_name>
  lastName: <user_last_name>
  phNo: <user_phone_number>
  emailId: <user_email_id>
  status: Y
  password: <superadmin_password>
  role: SUPER_ADMIN
  saml: N
  refreshToken:
  anomalies-indexName: temp_anomalies_2025

 

Step 6: Elasticsearch Configuration:

The Elasticsearch section in your application.yml file is used by the IANN Monitor application to connect securely to your Elasticsearch instance.

It includes all the necessary connection details like credentials, host, port, and truststore for SSL.

Note : To encrypt Elasticsearch and truststore passwords refer to – 3.4.2 Encrypting Password

 

elasticSearch:
  data:
    userName: <elasticsearch_username>
    password: <encrypted elasticsearch password>
    hostName: <elasticsearch host>
    port: <elasticsearch port>
    scheme: https
    trustStore: <Install_dir>/IANN_Monitor_Server/elasticsearch-8.12.2/config/certs/truststore.p12
    trustStorePassword: <encrypted trustore password>

 

What to update:

1.    userName: The Elasticsearch username with permissions to read and write data.

2.    password: The password for the Elasticsearch user. (Consider encrypting this using the provided encryptInput tool.)

3.    hostName: The fully qualified domain name (FQDN) or IP address where your Elasticsearch is hosted.

4.    port: The Elasticsearch port. Default is 9200.

5.    scheme: Use https for secure connections.

6.    trustStore: The full path to your truststore file (.p12), which ensures the application trusts your Elasticsearch server’s SSL certificate.

7.    trustStorePassword: The password you set when creating the truststore.(Consider encrypting this using the provided encryptInput tool.)

Step 7: SMTP Configuration:

The spring.mail section in your application.yml file allows the IANN Monitor application to send email notifications.

spring:
  main:
    allow-bean-definition-overriding: true
  mail:
    host: <smtp_host>
    port: <smtp_port>
    username: <username>
    password: <encrypted-password>
    app-contact-mail: <app_contact_email_id>
    mail-signature: Iann Monitor support team.
    properties:
      mail:
        smtp:
          auth: true
          starttls:
            enable: true
          ssl:
            trust: “*”

    protocol: smtp
    test-connection: false

 

 

What to update

1.    host: Your SMTP server hostname (for example, smtp.gmail.com, smtp.office365.com, or your internal SMTP server).

2.    port: The SMTP server port. Usually 587 for TLS/STARTTLS or 465 for SSL.

3.    username: The SMTP username used to authenticate (often an email address or SMTP access key).

4.    password: The SMTP password or access key. Encrypt this using the encryptInput tool before putting it here.

Step 8: Logo Configuration:

The logoPath setting in your application.yml file specifies the path to the logo image that will be displayed in the IANN Monitor application UI.

logo:
  logoPath: <Install_dir>/IANN_Monitor_Server/logo.png

 

How to update the logo:

By default, the Pragmaedge logo is used. To replace it with your own brand logo, follow these steps:

1.    Delete the existing logo.png file from the IANN_Monitor_Server folder.

2.    Upload your desired logo.png file to the same IANN_Monitor_Server folder.

3.    Rename your uploaded file to logo.png.

4.    Ensure that logoPath in your configuration points to:
 IANN_Monitor_Server\logo.png

Step 9: Saml Configuration:

To integrate SAML Single Sign-On (SSO) with the IANN Monitor application.

saml:
  sso-url: <SSO_URL>
  slo-url: <SLO_URL>
  idp:
    metadata: <Install_dir>/IANN_Monitor_Server/metadata.xml
    registration-id: <registration-id>
  idp-groups-role-mapper: SuperAdmin-SUPER_ADMIN, Admin-ADMIN,BusinessAdmin-BUSINESS_ADMIN, BusinessUser-BUSINESS_USER

 

What to update

1.    sso-url:

Update this to point to your Identity Provider’s Single Sign-On (SSO) URL.

2.    slo-url:
Set this to your Identity Provider’s Single Logout (SLO) URL.

3.    idp.metadata:

 Upload your IdP metadata XML file to the server (for example, under <Install_dir>/IANN_Monitor_Server/) and update this field with the full path to that file.

4.    registration-id:

Change this to the unique registration identifier configured for your SAML integration.

5.    idp-groups-role-mapper:
Update this mapping to reflect your IdP groups and their corresponding application roles.

SuperAdmin-SUPER_ADMIN,Admin-ADMIN,BusinessAdmin-BUSINESS_ADMIN,BusinessUser-BUSINESS_USER

The above mapping follows the format:

<SAML IdP Group> – <IANN Monitor Application Role>

Add accordingly based on your setup.

For example:

SuperAdmin-SUPER_ADMIN,Admin-ADMIN,BusinessAdmin-BUSINESS_ADMIN,BusinessUser-BUSINESS_USER

Left side (SuperAdmin, Admin, etc.) are your SAML IdP groups.

Right side (SUPER_ADMIN, ADMIN, etc.) are your IANN Monitor application roles.

Update or add mappings as needed to reflect your organization’s SAML groups and their corresponding application roles

2.6.5 Deploy IANN Monitor Application

Once application.yml changes are done.

Step 1: Navigate to win64 folder in nssm from command prompt. Picture

Step 2: Enter the below command.

  nssm install IANNMonitorUI

         

After running the command, the following User Account Control (UAC) prompt will appear:

Click “Yes” to allow NSSM to make changes to your system. This is required to install the IANNMonitorUI service.

Picture

Step 3: You will get a pop up of nssm for creating a service

Picture

Step 4: Install the IANN Monitor Application

1.    Under the “Application” tab:

a.     In the “Path” field, browse and select the java.exe file (usually located inside the Java/bin directory).

b.    In the “Startup directory” field, select the folder where the IANN Monitor UI JAR file is located.

c.     In the “Arguments” field, enter the following for without saml:

-Dspring.profiles.active=IANN_monitor  -jar IANNMonitorUI.jar

d.    To run the application with the SAML configuration, replace the iann_monitor profile in the arguments with the saml profile. The updated “Arguments” will be:

-Dspring.profiles.active=saml  -jar IANNMonitorUI.jar

2.    Once all fields are filled correctly, click on the “Install service” button to complete the setup.

Picture
Step 5: To start IANN_Monitor_UI, open Task Manager and go to the Services tab. Find IANN_Monitor_UI, right-click on it, and select Start. The service will then show as Running.

Picture

Step 6: Accessing the Application UI:   

1.    Once the application has started successfully, open your browser and search with

 

https://localhost:9200

A screenshot of a computer login page  AI-generated content may be incorrect.

2.    Use the username and password set in application.yml to log in for the first time:

Default credentials:


username:superadmin

Password: Expl0re

A screenshot of a computer  AI-generated content may be incorrect.

2.7 Send Mail and Alert Configuration:   

1.    alerts: Monitors for critical and warning conditions, evaluates if any alert thresholds are triggered, and records these alerts in Elasticsearch.

2.    send_mail: Retrieves the stored alerts from Elasticsearch and sends alert notification to the configured reporting systems.

2.7.1 Extract alerts.zip and Send_mail.zip

Step 1: Go to the IANN_Monitor folder we can see alerts and send mail packages as shown in the below and extract the zip files one after the other.

Picture

2.7.2 Edit config.ini file for Elasticsearch and SMTP Details

Step 1: Go to the IANN_Monitor_Server folder and check config.ini.

 

Step 2: Update the following sections for Alerts and Send Mail.

[elasticsearch] Section

 

[elasticsearch]
port = <elasticsearch_port>
url = https://<elasticsearch_host>:<elasticsearch_port>
username = <elastic_username>
password = <encrypted_password>
use_ssl = true

1.    Replace <elasticsearch_host> with the hostname or IP address of your Elasticsearch server.

2.    Set username to your Elasticsearch username.

3.    Update password with your encrypted Elasticsearch password.

4.    Confirm port matches your Elasticsearch port (default is 9200).

5.    Ensure use_ssl is true if you are using HTTPS.

Note : To encrypt Elasticsearch password refer to – 3.6.2 Encrypting Password

[email] Section

 

[email]
port = <smtp_port>
host  = <smtp_host>
from =  <smtp_sender_email_id>
username = <smtp_user>
password = <smtp_encrypted_password>

1.    host: Set this to your SMTP server address (e.g., smtp.office365.com, smtp.gmail.com, or your internal SMTP server).

2.    port: Usually 587 for TLS; change if your SMTP provider uses a different port.

3.    from: The sender email address that will appear in outgoing emails.

4.    username: Your SMTP username (often the email address or an SMTP access key).

5.    password: encrypted smtp password.

Note : To encrypt Elasticsearch password refer to – 3.6.2 Encrypting Password

2.7.3 Start Alerts and Send Mail Agents

Step 1: To Install alerts and send mail package, go back to the nssm folder and open win64 folder. Now select the path and type cmd, it will take you to the command prompt.

Step 2: Enter the below command to install alerts.

nssm install alerts

Step 3: Set the Application Path to the location of alerts.exe and click Install Service.

Picture

Step 4: To start alerts, Go to services in task manager and search for alerts . Right click on the alerts and then start it, it will come to running state as shown below.

Step 5: Enter the command below to install send mail.

nssm install send_mails

Step 6: Set the Application Path to the location of send_mails.exe and click Install Service.

Picture

Step 7: To start send_mails, Go to services in task manager and search for alerts . Right click on the alerts and then start it, it will come to running state as shown below.

Step 8: Go to the alerts and send mail package location and open the “alert.log” and “send_mail.log” text document and verify the logs for any errors or exceptions and then validate the time of the logs with the current time

 

 

 

 

 

A close-up of a text  AI-generated content may be incorrect.

2.8 Configure Heartbeat and System Stats

Heartbeat:
Heartbeat monitors the health and availability of servers and applications by regularly checking their status through configured URLs and IP’s . It ensures that critical services are up and running and promptly detects any downtime or connectivity issues

[heartbeat]
ip = [“<IP>:Server_name”]
urls = [“url:application_name”]
schedule_heatbeat_seconds = 60

 

What to Update

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

For 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.

For 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

Systemstats:
Systemstats collects key server metrics, including CPU usage, memory (RAM) utilization, disk space consumption, and network activity. This helps in continuously tracking the resource performance and capacity of the server infrastructure.

 

[systemstats]
schedule_system_stats_seconds = 300
os = windows
environment = general
swap = false

 

What to Update

1.    schedule_system_stats_seconds = 300
 This sets how often (in seconds) the system statistics are collected. The default is 300 seconds (i.e., every 5 minutes). You can change this value to run the checks more or less frequently, for example schedule_system_stats_seconds = 120 to collect stats every 2 minutes.

2.    os = windows
 Specify the operating system of the servers being monitored. For example:
 os = windows for Windows servers.

3.    environment = general
 Label the environment type for easier identification in logs and dashboards. For example:
 environment = production, environment = staging, or environment = general.

2.8.1 Heartbeat Installation

Step 1: To Install Heartbeat, go back to the nssm folder and open win64 folder. Enter the command below.

nssm install heartbeat

Now Set the Application Path to the location of heartbeat.exe and click Install Service.

Picture

Step 2: To start Heartbeat, Go to services in task manager and search for heartbeat. Right click on the heartbeat and then start it, it will come to running state as shown below.

 

2.8.2 Systemstats Installation

Step 1: To Install Systemstats, go back to the nssm folder and open win64 folder. Enter the command below.

nssm install systemstats

Now Set the Application Path to the location of systemstats.exe and click Install Service.

 Picture

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

2.9 Teams and Slack Integration:

   Step 1: Go to the IANN_Monitor_Server folder and check for Teams and slack packages.

     Step 2: The following changes need to be made in the config.ini file, which is located in the same directory as the Teams and Slack packages.

1.    From – Specify the email ID from which notifications should be triggered.

2.    Queuedepth_threshold – Define the threshold value. Any queue exceeding this threshold will trigger a notification in Teams/Slack.

3.    Url_heartbeat_index – Provide the environment prefix along with the URL heartbeat index in a key-value pair format.

a.    Example (Single Environment):

{“ IANN_monitor _db2″: “db2_test_url_heartbeat-*”}

          

b.    Example (Multiple Environments):

 

{
  “ IANN_monitor _db2″: “db2_test1_url_heartbeat-*”,
  “ IANN_monitor _test”: “db2_test1_url_heartbeat-*”
}

 

4.    System_heartbeat_index – Configure this similar to Url_heartbeat_index, but use the system heartbeat index instead of the URL heartbeat index.

5.    IANN_monitor_UI_url – Specify the IANN Monitor UI URL.

6.    Server_metrics – To monitor server metrics, provide the server metrics index along with its name and prefix.

a.    Example (Single Server):

{
             IANN_monitor _db2″: [“SI Server; IANN_monitor _db2_metrics_general-*”]
       }

 

 

b.    Example (Multiple Servers):

 {
           “ IANN_monitor _db2″: [“SI Server; IANN_monitor    _db2_metrics_general-*”,                                   

“Another Server;another_metrics_general-*”]


    }

 

 

Step 3: 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.

Picture

Step 4: Install the Teams Package

In the Command Prompt window, enter the following command to begin installing the Teams service:

nssm install teams

 

1.    In the NSSM service installer window that appears, click on the three dots next to the Path field.

2.    Browse and select the teams.exe located in the server folder.

3.    Click OK to confirm.

Picture

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

Step 6: Install the Slack Package

Go to the win64 location from command prompt and run the command below.

nssm install slack

1.    In the NSSM service installer window that appears, click on the three dots next to the Path field.

2.    Browse and select the slack.exe located in the server folder.

3.    Click OK to confirm.

Picture


Step 7: To start Slack, Go to services in task manager and search for Slack. Right click on the slack and then start it, it will come to a running state as shown below.

2.10 Weekly Report Configuration

The weekly report offers a high-level overview of how your systems and applications are performing, highlighting average daily usage metrics. It is automatically generated every week to help you track trends and identify any areas that may need attention.

Note: Make sure to configure these settings and start the weekly report after your client agents have started to avoid indexing not found errors.

This section describes how to configure Weekly Reports config.ini file.

Step 1: Go to config.ini located at IANN_Monitor_Server to update the configurations.

Make sure to update the following sections:

[Environment_Type]- section

 

[Environment_Type]
vm = true
openshift = false
lightwell_metrics = false
environment = <environment name>
environment_prefix =  <environment prefix>
pragmaedge_image_path = <logo path>
pdf_name = <pdf name>
ram_field = RAM Utilization
image_width = 30
image_height = 15
x_axis = 240
y_axis = 1
timezone = UTC,UTC
schedule_weekly_reports_time_in_seconds = 1000

 

What to Update

1.    vm = true
 Set this to true if you are monitoring a VM environment.

2.    openshift = false
 Set this to true if you are monitoring an OpenShift environment; otherwise keep it false.

3.    lightwell_metrics = false
 Set this to true if you want to include Lightwell metrics in the weekly reports.
 For example:
 lightwell_metrics = true

4.    environment
 This must be manually updated after you create the environment in the UI.
 For example:
 environment = my_environment

5.    environment_prefix = iann_monitor_test
 This should match the index prefix set in your [elasticsearch] section.
 For example:
 environment_prefix = iann_monitor_test

6.    timezone = Asia/Kolkata,IST
 Set to your local timezone for accurate timestamps.
 For example:
 timezone = Asia/Kolkata,IST

7.    pdf_name = <name_for_pdf_reports>
 Sets the base name for the generated PDF reports.
 For example:
 pdf_name = system_health_report

8.    pragmaedge_image_path = <logo_file>
 Provide the image file (logo) path that will appear in your PDF reports.
 For example:
 pragmaedge_image_path = company_logo.png

[weekly_report_vm] – section

[weekly_report_vm]


serverdetails = {“App Server Metrics”: “envprefix_appserver_metrics-*”,

“Database Server Metrics”: “envprefix_dbserver_metrics-*”} 

What to Update

 

1.    Update headings and index name in serverdetails.

2.    “App Server Metrics” is the heading that will appear in your PDF report for this server

3.    “envprefix_appserver_metrics-*” is the Elasticsearch index pattern where this server’s metrics are stored.

[email] – section

Add the line below under the email section to send the weekly report to the specified email address:

to = receiver@email.com

[weekly_report_openshift] – section

No need to configure [weekly_report_openshift] since this is not an OpenShift environment.

2.10.1 Start Weekly Report

Step 1: Go to IANN Monitor Server folder, locate Weekly Report package and extract its contents.

Step 2: 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 3: Install the Weekly Report Package.

nssm install Weekly_report

1.    In the NSSM service installer window that appears, click on the three dots next to the Path field.

2.    Browse and select the Weekly_report.exe located in the server folder.

3.    Click OK to confirm.


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

 

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 4.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

·       appdata.zip

·       Database_Health_Check.zip

·       Sireports.zip

·       Pcmstats.zip

·       Queuewatcher.zip

·       Systemstats.zip

·       Silogparser.zip

·       Sspheartbeat.zip

Client Components & What They Collect:

File Name

Description

IANN_Monitor_API.jar

 Contains the client-side backend jar that connects to the SI database.

application.yml

This defines the Sterling Integrator (SI) database details, allowing the IANN_Monitor_API to connect to the database.

Config.ini

The main configuration file where all parameters (database connection, environment type, schedules, etc.) are set.

appdata.zip

Collects multiple Sterling Integrator metrics and status, including service times, mailbox depth, adapter health, halted processes, and scheduler info.

Database_Health_Check.zip

Collects detailed database health metrics such as IOPS, throughput, latency, sessions, locks, and tablespace usage.

Sireports.zip

Gathers BP (business process) metrics and SI certificate details, including long-running BPs, trusted certs, and execution distribution across nodes.

Pcmstats.zip

Executes application reference queries for PCM application insights.

Queuewatcher.zip

Collects QueueWatcher data including heap usage, non-heap usage, active threads, and queue depth.

Systemstats.zip

Gathers core server metrics like CPU, RAM, Disk, and Network utilization.

Silogparser.zip

Scans Sterling Integrator logs (silogs) for errors.

Sspheartbeat.zip

Checks the status and availability of the SSP (Secure Proxy) application.

 

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 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: <SI_User_encrypted_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 show how the JDBC URL differs for each supported database. Adjust the URL accordingly for the Sterling Integrator database.

DB Type

Example JDBC URL Format

Oracle

jdbc:oracle:thin:@host:port/service?currentSchema=schema

DB2

jdbc:db2://host:port/database:currentSchema=schema;

SQL

jdbc:sqlserver://host:port;databaseName=database;schema=schema;

 

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

Example:

            username = my_db_user

4.    Password:

This is the encrypted password for the database user specified above.

Note: To encrypt password, refer to – 3.6.2 Encrypting Password

 Example:

password = my_db_password

5.    driver-class-name:

 

           Update the driver class name as per the table below.

           

DB Type

Driver Class

Oracle

oracle.jdbc.OracleDriver

DB2

com.ibm.db2.jcc.DB2Driver

SQL Server

com.microsoft.sqlserver.jdbc.SQLServerDriver

 

 

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, 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.    Browse and select the IANN_Monitor_API.jar located in the server folder.

3.    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.

A screenshot of a computer  AI-generated content may be incorrect.

3.3 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.    appdata Configuration [appdata]

3.    Database Health Check Configuration ([db_healthcheck])

4.    Sterling Reports Configuration ([sterling_reports])

5.    PCM Stats Configuration ([pcm_stats])

6.    Queue Watcher Configuration

7.    Systemstats configuration([systemstats])

8.    Silogparser Configuration([silogparser])

9.    SSP Configuration ([ssp])

Step 1: Go to IANN_Monitor_Client.

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

Step 3: Configure Elasticsearch settings.

[elasticsearch]
index = <index_prefix>
url = <elasticsearch_url>:<elasticseach_port>
port = <elasticsearch_port>
username = <elasticsearch_username>
password =  <encrypted_elasticsearch_password>

use_ssl = false
os = linux

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.6.2 Encrypting Password

Step 4: Configure appdata settings.

[appdata]
api_host = http://<apiurl>:9090
jarvis_username = <jarvis_username>
jarvis_password = <jarvis_encrypted_password>
db_type = <db_type>
list = (‘/ceuroot/AL875′,’/abc’)
adapter_list = (‘adapters’)
service_list = (‘services’)
schedulers_list = (‘schedulers’)
scheduled_seconds = 300
external_perimeter_seconds = 60
adapter_status_seconds = 60
halted_count_seconds = 300
halting_count_seconds = 300
interrupted_count_seconds = 300
waiting_count_seconds = 300
waiting_on_io_count_seconds = 300
active_count_seconds = 300
archive_seconds = 300
index_seconds = 300
purge_seconds = 300
app_availability_time_seconds = 300
schedulers_status_seconds = 300
run_time_of_service_seconds = 300
adapter_uptime_status_seconds = 300
bp_status_seconds = 300
non_index_seconds = 300
mailbox_long_running_seconds = 300
document_processed_seconds = 300
db_usage_seconds = 300
get_mailbox_depth_seconds = 300
Waiting_count_version = true
Halted_count_version = true
archive = true
index = true
purge = true
get_mailbox_depth_query = true
get_mailbox_ref_query = true
document_processed = true
db_usage = true
mailbox_long_running = true
run_time_of_service = true
adapter_status = true
adapter_uptime_status = true
halted_count = true
halting_count = true
interrupted_count = true
waiting_count = true
waiting_on_io_count = true
Purge_count = true
app_availability_time = true
schedulers_status = true
Non_index = true
Bp_status = true
get_mailbox_depth = true
active_count = true

 

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

apihost,jarvis_username, jarvis_password, db_type,list,adapter_list,service_list,schedulers_list

1.api_host:

The URL of your Client-db-connector to which the agents connect to and fetch the data.

To get host and port refer to 4.3 Configure application.yml and Deploy Client-db-connector – step 6

Example:

api_host = http://apiurl:9090

2.jarvis_username & jarvis_password :

Credentials to authenticate with the IANN_Monitor_API.

Set default username – jarvis

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

Note : To encrypt password refer to – 3.6.2 Encrypting Password

Example:

jarvis_username = jarvis

jarvis_password = 8o3DjuRtTlvaqzbehivjk75p

3.db_type:

Specify the database type used by Sterling Integrator:

1.    Use db2 for DB2,

2.    oracle for Oracle,

3.    and sql_server for SQL Server

Example:

db_type = DB2

4. list, adapter_list , service_list, schedulers_list:

List – A list of mailboxes or directory paths that need to be monitored.

Example:

list = (‘/ceuroot/AL875′,’/abc’)

adapter_list – A list of adapters that should be monitored.

Example:

adapter_list = (‘FileAdapter’,’FTPAdapter’)

service_list – A list of BP (Business Process) services to be monitored.

Example:

service_list = (‘OrderProcessingService’,’InvoiceGenerationService’)

schedulers_list -A list of schedulers that need to be monitored.

Example:

schedulers_list = (‘NightlyCleanupScheduler’,’DataSyncScheduler’)

5. mailbox_long_running_morethan_mins:

mails running more than the time configured here are monitored.

Example:  mailbox_long_running_morethan_mins = 5

6. Scheduling:

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

scheduled_seconds, external_perimeter_seconds, adapter_status_seconds, halted_count_seconds, halting_count_seconds, interrupted_count_seconds, waiting_count_seconds, waiting_on_io_count_seconds, active_count_seconds, archive_seconds, index_seconds, purge_seconds, app_availability_time_seconds, schedulers_status_seconds, run_time_of_service_seconds, adapter_uptime_status_seconds, bp_status_seconds, non_index_seconds, mailbox_long_running_seconds, document_processed_seconds, db_usage_seconds, get_mailbox_depth_seconds

Example:

scheduled_seconds = 300

external_perimeter_seconds = 60

adapter_status_seconds = 60

halted_count_seconds = 300

halting_count_seconds = 300

interrupted_count_seconds = 300

waiting_count_seconds = 300

waiting_on_io_count_seconds = 300

active_count_seconds = 300

archive_seconds = 300

index_seconds = 300

purge_seconds = 300

app_availability_time_seconds = 300

schedulers_status_seconds = 300

run_time_of_service_seconds = 300

adapter_uptime_status_seconds = 300

bp_status_seconds = 300

non_index_seconds = 300

mailbox_long_running_seconds = 300

document_processed_seconds = 300

db_usage_seconds = 300

get_mailbox_depth_seconds = 300

7. Metrics Toggles:

Enable or disable monitoring of specific data points.
 If set to true, the agent will monitor and collect data for that metric.
 If set to false, the agent will skip monitoring that data point.

Metrics toggles to configure:

Waiting_count_version, Halted_count_version, archive, index, purge, get_mailbox_depth_query, get_mailbox_ref_query, document_processed, db_usage, mailbox_long_running, run_time_of_service, adapter_status, adapter_uptime_status, halted_count, halting_count, interrupted_count, waiting_count, waiting_on_io_count, Purge_count, app_availability_time, schedulers_status, Non_index, Bp_status, get_mailbox_depth, active_count

Example:

Waiting_count_version = true

Halted_count_version = true

archive = true

index = true

purge = true

get_mailbox_depth_query = false

get_mailbox_ref_query = true

document_processed = true

db_usage = true

mailbox_long_running = true

run_time_of_service = true

adapter_status = true

adapter_uptime_status = true

halted_count = true

halting_count = true

interrupted_count = true

waiting_count = true

waiting_on_io_count = true

Purge_count = true

app_availability_time = true

schedulers_status = true

Non_index = false

Bp_status = false

get_mailbox_depth = true

active_count = false

external_perimeter=true

Step 5: Configure sterling_reports settings.

[sterling_reports]
trusted_certs_seconds = 60
ca_certs_seconds = 60
system_certs_seconds = 60
no_execution_per_node_seconds = 60
bp_records_per_month_seconds = 60
bp_with_large_bp_steps_seconds = 60
bp_runs_bp_steps_seconds = 60
bp_definition_details_for_si_seconds = 60
long_running_bp_steps_seconds = 60
long_running_bp_seconds = 60
long_bp_steps_time_seconds = 60
long_bp_time_seconds = 1800
ca_certs = true
system_certs = true
long_running_bp_steps = true
long_running_bp = true
bp_definition_details_for_si = true
system_cert = true
ca_cert = true
trusted_cert = true
bp_runs_bp_steps = true
no_execution_per_node = true
bp_records_per_month = true
bp_with_large_bp_steps = true
trusted_certs = true

large_bp_steps=3000

1.Scheduling:

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

trusted_certs_seconds, ca_certs_seconds, system_certs_seconds, no_execution_per_node_seconds, bp_records_per_month_seconds, bp_with_large_bp_steps_seconds, bp_runs_bp_steps_seconds, bp_definition_details_for_si_seconds, long_running_bp_steps_seconds, long_running_bp_seconds, long_bp_steps_time_seconds, long_bp_time_seconds

Example:

trusted_certs_seconds = 60

ca_certs_seconds = 60

system_certs_seconds = 60

no_execution_per_node_seconds = 60

bp_records_per_month_seconds = 60

bp_with_large_bp_steps_seconds = 60

bp_runs_bp_steps_seconds = 60

             bp_definition_details_for_si_seconds = 60

             long_running_bp_steps_seconds = 60

long_running_bp_seconds = 60

long_bp_steps_time_seconds = 60

long_bp_time_seconds = 1800

2. Metrics Toggles:

Set to true if you want the agent to monitor these data points.
If set to false, the agent will skip collecting them.

ca_certs, system_certs, long_running_bp_steps, long_running_bp, bp_definition_details_for_si, system_cert, ca_cert, trusted_cert, bp_runs_bp_steps, no_execution_per_node, bp_records_per_month, bp_with_large_bp_steps, trusted_certs

Example:

ca_certs = true

system_certs = true

long_running_bp_steps = true

long_running_bp = true

bp_definition_details_for_si = true

system_cert = true

ca_cert = true

trusted_cert = true

bp_runs_bp_steps = true

no_execution_per_node = true

bp_records_per_month = true

bp_with_large_bp_steps = true

trusted_certs = true

3. large_bp_steps:

IANN Monitor will track BPs that have 3000 steps or more, based on the value set in large_bp_steps

Example:

large_bp_steps=3000

Step 6: Configure db_healthcheck settings

[db_healthcheck]
read_iops_seconds = 60
inactive_sessions_seconds = 60
total_sessions_seconds = 60
database_check_seconds = 60
database_locks_seconds = 60
db_response_time_seconds = 60
top_tables_seconds = 60
mailboxes_with_unextracted_messages_seconds = 60
no_of_messages_extracted_older_n_days_seconds = 60
active_sessions_seconds = 60
tablespace_usage_seconds = 60
purge_locks_seconds = 60
cpu_util_seconds = 60
ram_util_seconds = 60
db_conn_seconds = 60
read_latency_seconds = 60
write_latency_seconds = 60
read_throughput_seconds = 60
write_throughput_seconds = 60
cluster_status_seconds = 60
write_iops_seconds = 60
over_all_database_size_seconds = 60
no_of_messages_unextracted_older_n_days_seconds = 60
read_iops = true
cpu_util = true
ram_util = true
db_conn = true
read_latency = true
write_latency = true
read_throughput = true
write_throughput = true
over_all_database_size = true
database_check = true
tablespace_usage = true
active_sessions = true
inactive_sessions = true
total_sessions = true
database_locks = true
db_response_time = true
mailboxes_with_unextracted_messages = true
no_of_messages_extracted_older_n_days = true
purge_locks = true
cluster_status = true
write_iops = true
no_of_messages_unextracted_older_n_days = true
bp_locks_minutes=2
top_tables=true
days=4
days_unextracted=5

1.Scheduling:

Configure how often (in seconds) the agent collects each database health metric.

Scheduling keys:

read_iops_seconds, inactive_sessions_seconds, total_sessions_seconds, database_check_seconds, database_locks_seconds, db_response_time_seconds, top_tables_seconds, mailboxes_with_unextracted_messages_seconds, no_of_messages_extracted_older_n_days_seconds, active_sessions_seconds, tablespace_usage_seconds, purge_locks_seconds, cpu_util_seconds, ram_util_seconds, db_conn_seconds, read_latency_seconds, write_latency_seconds, read_throughput_seconds, write_throughput_seconds, cluster_status_seconds, write_iops_seconds, over_all_database_size_seconds, no_of_messages_unextracted_older_n_days_seconds

Example:

read_iops_seconds = 60

inactive_sessions_seconds = 60

total_sessions_seconds = 60

database_check_seconds = 60

database_locks_seconds = 60

 db_response_time_seconds = 60

top_tables_seconds = 60

mailboxes_with_unextracted_messages_seconds = 60

no_of_messages_extracted_older_n_days_seconds = 60

active_sessions_seconds = 60

tablespace_usage_seconds = 60

purge_locks_seconds = 60

cpu_util_seconds = 60

ram_util_seconds = 60

db_conn_seconds = 60

read_latency_seconds = 60

write_latency_seconds = 60

read_throughput_seconds = 60

write_throughput_seconds = 60

cluster_status_seconds = 60

write_iops_seconds = 60

over_all_database_size_seconds = 60

no_of_messages_unextracted_older_n_days_seconds = 60

2. Metrics Toggles:

Set true if you want the agent to monitor that specific database metric.
 If set to false, the agent will skip monitoring it.

read_iops, cpu_util, ram_util, db_conn, read_latency, write_latency, read_throughput, write_throughput, over_all_database_size, database_check, tablespace_usage, active_sessions, inactive_sessions, total_sessions, database_locks, db_response_time, mailboxes_with_unextracted_messages, no_of_messages_extracted_older_n_days, purge_locks, cluster_status, write_iops, no_of_messages_unextracted_older_n_days

Example:

read_iops = true

cpu_util = true

ram_util = true

db_conn = true

read_latency = true

write_latency = true

read_throughput = true

write_throughput = true

over_all_database_size = true

database_check = true

tablespace_usage = true

active_sessions = true

inactive_sessions = true

total_sessions = true

database_locks = true

db_response_time = true

mailboxes_with_unextracted_messages = true

no_of_messages_extracted_older_n_days = true

purge_locks = true

cluster_status = true

write_iops = true

no_of_messages_unextracted_older_n_days = true

top_tables=true

3. bp_locks_minutes, days, days_unextracted:

1.    bp_locks_minutes: Monitors locks that have been held for this number of minutes or longer.

Example:

               bp_locks_minutes=2

2.    days: Tracks extracted messages that are older than this number of days.

Example :

days=4

3.    days_unextracted: Checks for unextracted messages that are older than the specified number of days.

Example :

days_unextracted=5

Step 7: Configure pcm_stats settings.

[pcm_stats]
application_ref_query_seconds=60
tp_ref_query_seconds=60
wf_ref_query_seconds=60
application_ref_query=true
tp_ref_query=true
wf_ref_query=true

1. Scheduling:

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

Scheduling keys:

application_ref_query_seconds, tp_ref_query_seconds, wf_ref_query_seconds

Example:

application_ref_query_seconds=60

tp_ref_query_seconds=60

wf_ref_query_seconds=60

2. Metrics Toggles:

Set to true if you want the agent to monitor that specific data point.
 If set to false, the agent will skip monitoring it.

Toggles:

application_ref_query, tp_ref_query, wf_ref_query

Example:

application_ref_query=true

tp_ref_query=true

wf_ref_query=true

Step 8: 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>
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://10.0.0.21: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.    schedule_threads_seconds = 60
 Interval (in seconds) at which the agent schedules general thread-related tasks.

6.    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://10.0.0.21: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://10.0.0.21:50000/queueWatch/

username = user1

password = aBc123XyZ456+==sDfGhJkLmN0

schedule_threads_seconds = 60

schedule_queuewatcher_seconds = 60

[queuewatcher_node2]

index = node2

queue_url = http://10.0.0.26:10000/queueWatch/

username = user2

password = zYx987WvU654/TuRqPoLmNkJiHg

Step 9: Configure ssp settings.

[ssp]
data = {“SSP Server 1”: [“host”, port], “SSP Server 2”: [“host”, port]}
delay = 60

Configuration Parameters to be updated:

1.    Replace “host” and port with your actual SSP Engine hostnames and ports.

2.    You can add as many ssp servers as needed by expanding the data dictionary.

3.    delay controls how often (in seconds) the SSP check runs.

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”},
  {‘path’: “/path/to/logs2/*.log*”, ‘application’: “other_app”}
   ]

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.

Step 11: Configure systemstats settings.

[systemstats]
schedule_system_stats_seconds = 300
os = linux
environment = general
swap = false

Refer to section 3.8 Configure Heartbeat and System Stats for systemstats configuration.

3.4 Installation of IANN Monitor Agents:

3.4.1 Install Appdata:

Step 1: Unzip appdata.zip and Open Command Prompt from the NSSM Folder

1.    Go to the IANN_Monitor_Client path where the appdata.zip file is located. Right-click on appdata.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 appdata Package

In the Command Prompt window, enter the following command to begin installing the Teams service:

nssm install appdata

1.    In the NSSM service installer window that appears, click on the three dots next to the Path field.

2.    Browse and select the appdata.exe located in the server folder.

3.    Click OK to confirm.

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

Step 4:

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

Picture, Picture
Picture

3.4.2 Install Database_Health_Check:

Step 1: Open Command Prompt from NSSM Folder

1.    Go to the IANN_Monitor_Client path where the database_health_check.zip file is located. Right-click on database_health_check.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 Database_Health_Check Package

In the Command Prompt window, enter the following command to begin installing the Teams service:

nssm install Database_Health_Check

1.    In the NSSM service installer window that appears, click on the three dots next to the Path field.

2.    Browse and select the Database_Health_Check.exe located in the server folder.

3.    Click OK to confirm.

 

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

Step 4: Go to the Database_Health_Check package location and open the “db_healthcheck_api.log” text document and verify the logs for any errors or exceptions and then validate the time of the logs with the current time.

Picture

Picture

3.4.3 Install Sireports:

Step 1: Open Command Prompt from NSSM Folder

1.    Go to the IANN_Monitor_Client path where the Sireports.zip file is located. Right-click on Sireports.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 Sireports Package

In the Command Prompt window, enter the following command to begin installing the Teams service:

nssm install Sireports

1.    In the NSSM service installer window that appears, click on the three dots next to the Path field.

2.    Browse and select the Sireports.exe located in the server folder.

3.    Click OK to confirm.

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

Step 4: Go to the Sireports package location and open the ” sterling_reports.log” text document and verify the logs for any errors or exceptions and then validate the time of the logs with the current time.

Picture

 

Picture

3.4.4 Install Pcmstats:

Step 1: Open Command Prompt from NSSM Folder

1.    Go to the IANN_Monitor_Client path where the pcmstats.zip file is located. Right-click on pcmstats.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 Pcmstats Package

In the Command Prompt window, enter the following command to begin installing the Teams service:

nssm install Pcmstats

1.    In the NSSM service installer window that appears, click on the three dots next to the Path field.

2.    Browse and select the Pcmstats.exe located in the server folder.

3.    Click OK to confirm.

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

Step 4: Go to the pcmstats package location and open the “pcm_stats.log” text document and verify the logs for any errors or exceptions and then validate the time of the logs with the current time.

A computer screen shot of a computer screen  AI-generated content may be incorrect.

3.4.5 Install Queuewatcher:

Step 1: Open Command Prompt from NSSM Folder

1.    Go to the IANN_Monitor_Client path where the Queuewatcher.zip file is located. Right-click on Queuewatcher.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 Queuewatcher Package

In the Command Prompt window, enter the following command to begin installing the Teams service:

nssm install Queuewatcher

1.    In the NSSM service installer window that appears, click on the three dots next to the Path field.

2.    Browse and select the Queuewatcher.exe located in the server folder.

3.    Click OK to confirm.

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

Step 4: Go to the Queuewatcher package location and open the “queuewatcher.log ” text document and verify the logs for any errors or exceptions and then validate the time of the logs with the current time.

Picture

Picture

3.4.6 Install Silogparser:

Step 1: Open Command Prompt from NSSM Folder

1.    Go to the IANN_Monitor_Client path where the Silogparser.zip file is located. Right-click on Silogpraser.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 Silogparser Package

In the Command Prompt window, enter the following command to begin installing the Teams service:

nssm install Silogparser

1.    In the NSSM service installer window that appears, click on the three dots next to the Path field.

2.    Browse and select the Silogparser.exe located in the server folder.

3.    Click OK to confirm.

 

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

Step 4: Go to the Silogparser package location and open the “silogparser.log ” text document and verify the logs for any errors or exceptions and then validate the time of the logs with the current time.

Picture

Picture

3.4.7 Install sspheartbeat:

Step 1: Open Command Prompt from NSSM Folder

1.    Go to the IANN_Monitor_Client path where the sspheartbeat.zip file is located. Right-click on sspheartbeat.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 sspheartbeat Package

In the Command Prompt window, enter the following command to begin installing the Teams service:

nssm install sspheartbeat

1.    In the NSSM service installer window that appears, click on the three dots next to the Path field.

2.    Browse and select the sspheartbeat.exe located in the server folder.

3.    Click OK to confirm.

 

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

Step 4: Go to the sspheartbeat package location and open the ” ssp_heartbeat.log” text document and verify the logs for any errors or exceptions and then validate the time of the logs with the current time.

A close-up of a text  AI-generated content may be incorrect.

3.4.8 Install Systemstats:

Step 1: Open Command Prompt from NSSM Folder

1.    Go to the IANN_Monitor_Client path where the systemstats.zip file is located. Right-click on systemstats.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 Systemstats Package

In the Command Prompt window, enter the following command to begin installing the Teams service:

nssm install Systemstats

1.    In the NSSM service installer window that appears, click on the three dots next to the Path field.

2.    Browse and select the systemstats.exe located in the server folder.

3.    Click OK to confirm.

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

Step 4: Go to the systemstats package location and open the ” systemstats.log” text document and verify the logs for any errors or exceptions and then validate the time of the logs with the current time.

Picture

Picture

4. Troubleshooting Steps

4.1 Agent Startup Failure- Key Errors

Issue: Agent fails to start due to missing or incorrect keys in the configuration file.

A screen shot of a computer  AI-generated content may be incorrect.

Planned Action (Windows):

·       Run the agent executable (e.g., appdata.exe) from Command Prompt to capture detailed errors.

·       Open the configuration file in a text editor.Add the missing db_type or other required parameters.

·       Save the file and restart the agent via Services or Task Scheduler.

4.2. IANN Monitor UI/API Startup Failure – Java Exception

Issue: IANN Monitor fails to start due to unsupported Java version.

A screenshot of a computer program  AI-generated content may be incorrect.

Planned Action (Windows):

·       Open Command Prompt and run:

·       If Java is not version 17 or above, download and install the correct version.

·       Set JAVA_HOME in Environment Variables and update the system Path.

A computer screen shot of white text  AI-generated content may be incorrect.

4.3. SSL Configuration Issues – Elasticsearch

Issue: Elasticsearch fails to start due to incorrect SSL certificate configuration.

A computer screen shot of a computer code  AI-generated content may be incorrect.

Planned Action (Windows):

·       Validate .crt and .key paths in elasticsearch.yml.

·       Ensure certificates are in supported format.

·       Use tools like OpenSSL on Windows to verify certificates:

xpack. security. transport.ssl.key: certs/pragmaedge.com.key

xpack. security. transport. ssl.certificate: certs/pragmaedge.com.crt

xpack. security. transport. ssl.certificate_authorities: /certs/pragmaedge.com.ca-bundle

·       Restart the Elasticsearch service from the Services panel.

4.4. Kibana UI Inaccessible – Certificate Validation Issue

Issue: Kibana is running, but the browser cannot access the UI due to certificate validation errors.

Planned Action (Windows):

·       Check that kibana.yml has the correct paths to SSL certs.

·       Ensure Kibana and Elasticsearch use certs from the same CA.

·       Use browser dev tools or curl for Windows:

A close-up of a computer code  AI-generated content may be incorrect.

4.5. Applications Not Accessible via Browser

Issue: Applications are up but not accessible via browser.

Planned Action (Windows):

·       Confirm the application is running using Task Manager

·       Check Windows Defender Firewall to ensure the port is allowed.

4.6. No Data from DB Monitoring Agents

Issue: Agents show “No Data” due to permission issues in the database.

Planned Action (Windows):

·       Review logs from the agent install folder.

·       Ensure the user has at least privileges

4.7. Elasticsearch Connection Timeout – Max Retry Exceeded

Issue: Applications cannot connect to Elasticsearch on https://XX.XX.X.XX:9200.

Planned Action (Windows):

·       Ensure Elasticsearch is running as a Windows service.

·       Use:curl -X GET https://XX.XX.X.XX:9200.

·       Confirm port 9200 is open and not blocked by Windows Firewall.

·       Check for issues in elasticsearch.yml or incorrect SSL configuration.