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:  Once downloaded, unzip the IANN_Monitor.zip file and extract its contents.

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

2.1 Upload Server Package and Unzip 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>, run the following command to extract the package:       

 Step 3: To set the permissions for the IANN_Monitor_Server  directory and all its contents, run:

This ensures:

1.    The owner has read, write, and execute permissions.

2.    Group and others have read and execute permissions.

  Step 4: Navigate into the IANN_Monitor_Server directory by running the                           below command:    

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

·       encryptInput.zip

·       Heartbeat.zip

·       systemstats.zip

·       ELK_Start.sh 

·       server_restart.sh

·       teams.zip

·       slack.zip

·       Weekly_report.zip

·       alerts.zip

·       send_mails.zip

·       shards.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.

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: Navigate to the <Install_dir> / IANN_Monitor_Server and Download Elasticsearch

1.    Open a terminal and navigate to the Server directory:

Download the Elasticsearch 8.12.2 package using the following command:

2.    Extract the downloaded archive:

3.      Navigate into the extracted Elasticsearch directory:

Step 2: Edit elasticsearch.yml

1.    The elasticsearch.yml configuration file is located at:

2.    Update the following basic configuration settings in elasticsearch.yml file.

3.    bin folder is located at:

 4.    Navigate to bin folder using below command:

 5.    Start Elasticsearch in the background using the below command:

 6.    Once started check whether the elasticsearch is running or not using below command:

 7.    Verify Elasticsearch is running by checking its default port:

 Note: <your public/private IP> – This is the host address or DNS of the server running Elasticsearch.

Example: telnet ec2-62-99-71-171.compute-1.amazonaws.com 9200

 8.    Try accessing Elasticsearch in your browser.

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

Step 1: Navigate to the bin directory
Use the following command to change to the Elasticsearch installation’s bin directory:

Step 2: Run the password reset tool
Execute the password reset script for the elastic user in interactive mode:

Step 3: Follow the prompts
The tool will display:

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://<your-IP>: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:

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

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

Step 1: Edit the elasticsearch.yml file
                 This file is located at:

Step 2: Create a certs directory inside the Elasticsearch config folder to store  all your security certificates:

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

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

Note: Replace <Install_dir>/IANN_Monitor_Server/elasticsearch-8.12.2/config/certs/… with the actual paths to your certificate files.

 Step 5: Save the elasticsearch.yml file.

 Step 6: Restart Elasticsearch to apply the SSL changes:

Navigate to bin using:

And run elasticsearch:

Step 7: Finally, verify that secure (HTTPS) access to Elasticsearch is Functional.

1.    Open a browser and navigate to:

https://<your-IP>:9200/

2.    Log in using:

Username: elastic

Password: <elasticseach_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: Navigate to the Server directory:

Step 2: Download using the below command

Step 3: Extract the kibana.tar.gz archive using the following command:

Step 4: Navigate into the extracted Kibana directory:          

2.5.2 Create Kibana User in Elasticsearch

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

Step 1: Find the PID by running:

Step 2: Stop Elasticsearch with

Step 3: Create the kibanauser with required roles in Elasticsearch

1.    To create the Kibana user navigate to the Elasticsearch installation directory using below command

2.    Run the following command to create the kibanauser with the necessary roles:

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

Step 3: Save this username and password to set them in kibana yaml file for       elasticsearch.username and elasticsearch.password in coming  section 3.5.4.

Step 4: After creating the user, start Elasticsearch again:         

2.5.3 Update Kibana Certificates

To enable secure HTTPS communication:

Step 1: Create the certs directory inside the kibana folder using the below command.

1.    Navigate to kibana folder using below command:

2.    Create certs directory inside kibana folder using below command:

Step 2: Navigate to the certs folder and upload the security certificate files (.crt, .key, .ca-bundle) into this location

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:

Step 2: Update the following configuration:

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

Step 3: Add these lines for server SSL and Elasticsearch SSL verification

Step 4: Update the following settings above lines:

1.    server.ssl.certificate with the path to the .crt file located at <Install_dir>/IANN_Monitor_Server/kibana-8.12.2-linux-x86_64/config/certs. 

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: Navigate to bin folder below command.

Step 2: Start Kibana using below command.

1.    Verify Kibana is Running :

Check port 5601:

 telnet localhost 5601 OR telnet <your public/private ip> 5601

2.    Access Kibana in your web browser

https://<your-IP>:5601/

Log in using:

·       Username: elastic

·       Password: the password you set during password reset

2.6 IANN Monitor Application Installation

This section covers the configuration steps for the IANN Monitor UI application, including the setup of the application.yml file and the installation of other UI components.

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:

1. Go to the certificates directory

Navigate to the directory where you have placed your SSL certificates using below command.

2. Generate the truststore

 Run the following command from the certs directory:

What does this:

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.

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:

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 password 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

                     cd <Install_dir>/ IANN_Monitor_Server/

      This is where your encryptInput.zip file is located.

Step 2: Unzip the encryption tool

Run this command to extract the encryptInput.zip file

unzip encryptInput.zip

Step 3: Run the encryption tool

                     Use this command to start the encryption program:

                     ./encryptInput/encryptInput

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 unzip the dashboard files to prepare them for use.

Step 2: To unzip, navigate to default dashboard location

Step 3: Unzip using below command:

 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: Navigate to IANN_Monitor_Server Directory:

Navigate to IANN_Monitor_Server Directory using the below command.

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.

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 at fileLocation under python.

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.

Step 5: DefaultUser 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.

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 trustore passwords refer to – 3.6.2 Encrypting 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.

 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.

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 located at:

 <Install_dir>/IANN_Monitor_Server/logo.png

2.    Upload your desired logo file to the directory:

 <Install_dir>/IANN_Monitor_Server/

3.    Rename your uploaded file to logo.png.

4.    Ensure that logoPath in your configuration points to:

 <Install_dir>/IANN_Monitor_Server/logo.png

Step 9: Saml Configuration:

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

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

Step 1: Navigate to the IANN Monitor JAR directory

go to the folder where your IANN Monitor JAR file is located using the command below.

Step 2: Start with the default (IANN Monitor) profile using the command below.

Step 3: If Saml needs to be enabled, Start with the SAML profile (for SSO integration).

          1. Find the process id of IANN Monitor application using below command.

       2. Kill this pid using below command.

         3. Start the IANN Monitor Application with saml profile using the command below.

Step 4: If you want to start with performance tuning and custom GC settings:

Follow Step 3 to kill the process and run the below command.

This option runs the IANN Monitor application with optimized memory, garbage collection (GC), and concurrency parameters to improve performance and handle larger workloads efficiently.

Step 5: To verify if the jar is running or not:

Step 6: Accessing the Application UI:

1.    Once the application has started successfully, open your browser and navigate to:

https://<IP or DNS>:<port>

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

2.7 Send Mails 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 Unzip alerts.zip and Send_mail.zip

Step 1: Navigate to the IANN_Monitor_Server directory using the command below.

Step 2: Unzip the alerts.zip and send_mail.zip packages using the unzip command.

2.7.2 Edit config.ini file for Elasticsearch and SMTP Details

Step 1: Navigate to config.ini using below command:

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

[elasticsearch] Section

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

1.    Set username to your Elasticsearch username.

2.    Update password with your encrypted Elasticsearch password.

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

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

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

[email] Section

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: Start the alerts and send mail agents from their respective locations:

2.7.4 Verify Logs

Step 1: Verify that the agents are running by checking their process status:

Step 2: Check the agent logs for any errors or exceptions, and validate the log timestamps against the current time:

Note: You might notice “index not found” errors in the alerts.log and send_mail.log files. This is expected because no dashboards have been created yet in the IANN Monitor. You can safely ignore these errors for now—they will disappear once the dashboards are set up.

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. It ensures that critical services are up and running, and promptly detects any downtime or connectivity issues.

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.

Step 1: Navigate to config.ini using below command:

This section outlines the configuration and startup of the Heartbeat and System Stats agents.

Step 2: Update the following sections for elasticsearch,Hearbeat and Systemstats

[elasticsearch] – section:

What to Update

1.    index = <index_prefix>
 Add this line in the [elasticsearch] section of your configuration.
 The index_prefix determines the prefix used when creating all indexes in Elasticsearch. This is helpful for separating environments in the IANN Monitor application.

For example:
 index = iann_test_qa
 This means all indexes created in Elasticsearch will start with iann_test_qa, making it easy to identify and manage them by environment (like iann_test_prod, iann_test_dev, etc.).

[heartbeat] – section:

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] – section:

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 = linux
 Specify the operating system of the servers being monitored. For example:
 os = linux for Linux servers, or 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 Start Heartbeat and Systemstats

Step 1: Navigate to config.ini using below command:

Step 2: Unzip Heatbeat and Systemstats using commands below:

Step3 : Start the alerts and send mail agents using the commands below.

Step 4: Verify Status using the commands below.

Step 5: Check the agent logs for any errors or exceptions, and validate the log timestamps against the current time:

2.9 Shards Usage
This section explains how to configure the IANN Monitor component to monitor the shard usage of Elasticsearch. Proper shard monitoring setup helps maintain cluster health, ensures balanced data distribution, and supports optimal search and indexing performance.

2.9.1 Configure Shard Usage

Step 1: Navigate to IANN_Monitor_Server using below command:

Step 2: Update the following section in config.ini

What to Update

1.    shards_interval_seconds = 300
 This sets how often (in seconds) the IANN Monitor checks Elasticsearch shard usage.

 For example:
 shards_interval_seconds = 300
 means shard usage will be monitored every 5 minutes.

2.9.2 Start Packages

Step 1: Navigate to IANN_Monitor_Sercer using below command:

Step 2: Unzip the shards_monitor.zip using command

Step 3: Start the shards agent using the commands below.

Step 4: Verify Status      

Step 5: Check the agent logs for any errors or exceptions, and validate the log timestamps against the current time:

2.10 Teams and Slack Configuration

1.    Teams: Sends a summary of the overall environmental health along with the top critical alerts triggered in the environment to the designated Teams channel.

2.    Slack: Sends a summary of the overall environmental health along with the top critical alerts triggered in the environment to the designated Slack channel.

Note: Make sure to configure these settings and start the teams and slack agents after your client agents have started to avoid index not found errors.

This section describes how to configure notifications for Microsoft Teams and Slack.

Step1: Navigate to config.ini using below command:

[teams_alerts] – section:

What to Update:

1.    from = <sender_email>
 Specify the sender email address used to post notifications to Microsoft Teams.
 For example:
 from = alerts@company.com

Note: This email user should be part of the Teams channel where you want these notifications to be delivered.

2.    queuedepth_threshold = <number>
 Sets the threshold for queue depth. An alert will be triggered when this limit is crossed.
 For example:
 queuedepth_threshold = 200

3.    url_heartbeat_index = {“<environment>”:”<index_prefix>_url_heartbeat-“}

4.    Map each environment name to its corresponding heartbeat index pattern. For example: url_heartbeat_index = {“uat”:”uat_url_heartbeat-“}`

5.    system_heartbeat_index = {“<environment>”:”<index_prefix>_system_heartbeat-“} Map each environment name to the system heartbeat index pattern. For example: system_heartbeat_index = {“uat”:”uat_system_heartbeat-“}`

6.    iann_monitor_UI_url = <iann_monitor_application_url>
 Provide the URL to access the IANN Monitor application.
 For example:
 iann_monitor_UI_url = https://monitor.company.com/#/login

7.    server_metrics = {“<environment>”:[“<server_name>;<metrics_index_pattern>”]}
 Define the mapping of environment to server name and metrics index.
 For example:
 server_metrics = {“uat”:[“AppServer1;uat_metrics_general-*”, “DBServer1;uat_db_metrics-*”]}

Here, AppServer1 is the server name and uat_metrics_general-* is the index pattern where its metrics are stored.

 2.10.1 Start Teams and Slack

Step 1: Navigate to config.ini using below command:

Step 2: Unzip Teams and Slack using commands below:

Step 3: Start the Teams and Slack agents using the commands below.

Step 4: Verify Status using the commands below.

Step 5: Check the agent logs for any errors or exceptions, and validate the log timestamps against the current time:

2.11 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 index not found errors.

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

Step 1: Navigate to config.ini using below command:

Make sure to update the following sections:

[Environment_Type]- section

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

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.11.1 Start Weekly Report

Step 1: Navigate to config.ini using below command: 

Step 2: Unzip Weekly_report using commands below:

Step 3: Start the Weekly_report agents using the commands below.

Step 4: Verify Status using the commands below.

Step 5: Check the agent logs for any errors or exceptions, and validate the log timestamps against the current time:

2.12 Configure Auto-Restart of IANN Monitor Server Applications
This section describes two supported methods to configure automatic restarts for critical IANN Monitor components such as Elasticsearch, Kibana, and UI services. You can choose between a cron-based approach or systemd-based service management depending on your environment and system preferences.

2.12.1 Auto-Restart Using Crontab

This method uses scheduled cron jobs to monitor and restart applications if they are not running.

Step 1: Navigate to the Server Directory

This directory contains two key scripts:

1.    Start_ELK.sh – Manages Elasticsearch and Kibana

2.    server_restart.sh – Manages UI and API JAR restarts

Step 2: Schedule Cron Jobs

To create scheduled tasks that check and restart applications every minute:

1.    Open the crontab editor:

2.    Add the following entries, adjusting <Install_Dir> as needed:

Step 3: Verify Cron Configuration

            To confirm the cron jobs have been scheduled correctly:

2.12.2 Verification (Crontab Method)

Once configured, the system will check every minute if Elasticsearch, Kibana, and UI services are active. If any of them are down, the respective script will trigger a restart automatically.