Utility Installation

Table of Contents

• General Description
• Installation Sequence
  • Step 0. Utility Requirements
  • Step 1. Installing Utility Dependencies
  • Step 2. Deploying Utility Objects
  • Step 3. Checking Utility Object Loading
    • 1. Index Templates
    • 2. Index Patterns
    • 3. Inventory Asset
    • 4. Health Metrics
• Removing Objects

---

General Description

The ai_observability_ko_maker utility is used to deploy AI Observability module objects.

The utility installs:

• index templates gen_ai_traces*, gen_ai_events*, gen_ai_metrics*, gen_ai_gpu_metrics*, gen_ai_cost*
• index patterns for all gen_ai_* indexes
• AI Observability: GPU inventory asset
• 6 health metrics

---

Installation Sequence

Step 0. Utility Requirements

• Python 3.x
• access to Smart Monitor cluster with administrator rights
• network access simultaneously to frontend API (port 5601) and OpenSearch API (port 9200)

Step 1. Installing Utility Dependencies

./bin/install_dependencies.sh

Step 2. Deploying Utility Objects

./bin/make_ai_observability.py \
  --sm_host <SEARCH_ANYWHERE_FRAMEWORK_HOST> \
  --sm_api_port <SEARCH_ANYWHERE_FRAMEWORK_API_PORT> \
  --sm_cluster_port <OPENSEARCH_PORT> \
  --sm_user <SEARCH_ANYWHERE_FRAMEWORK_USER> \
  --sm_password '<SEARCH_ANYWHERE_FRAMEWORK_PASSWORD>'

Parameter	Required	Default	Description
--sm_host	Yes	—	IP or hostname of Search Anywhere Framework
--sm_api_port	No	5601	Frontend API port (saved objects, inventory, Service Monitor Toolkit metrics)
--sm_cluster_port	No	9200	OpenSearch API port (index templates)
--sm_user	Yes	—	Username
--sm_password	Yes	—	User password

Additional parameters:

• --skip-index-templates, --skip-index-patterns, --skip-inventory, --skip-rsm-metrics — skip the corresponding object type
• --dry-run — show what will be done without sending requests

Please note!

--sm_api_port is used for frontend API and saved objects, while --sm_cluster_port is used for loading index templates. If frontend API and OpenSearch are published on different servers, you can explicitly specify --sm_api_host and --sm_cluster_host.

Step 3. Checking Utility Object Loading

1. Index Templates

After loading, check for index template availability:

Main Menu - System Settings - Index Management - Templates

2. Index Patterns

After loading, check for index pattern availability:

Main Menu - System Settings - Module Settings - OPENSEARCH - Index Patterns

3. Inventory Asset

After loading, check for inventory asset availability:

Main Menu - Inventory - Assets

4. Health Metrics

After loading, check for global metrics in the Service Monitor Toolkit module:

Main Menu - Service Monitor Toolkit - Metrics

---

Removing Objects

To remove all deployed objects, use the reverse script:

./bin/remove_ai_observability.py \
  --sm_host <SEARCH_ANYWHERE_FRAMEWORK_HOST> \
  --sm_api_port <SEARCH_ANYWHERE_FRAMEWORK_API_PORT> \
  --sm_cluster_port <OPENSEARCH_PORT> \
  --sm_user <SEARCH_ANYWHERE_FRAMEWORK_USER> \
  --sm_password '<SEARCH_ANYWHERE_FRAMEWORK_PASSWORD>'