Skip to main content
Version: 6.2

Install the Utility

Contents​

Overview​

The installation utility deploys the Database Observability module's service objects.

The utility installs:

  • index patterns
  • a search macro and 2 AI presets
  • 6 lookups
  • 3 Inventory asset configurations
  • 8 metrics, a health model, and an analytics center in Service Monitor Toolkit
  • the db_incident incident type
  • 2 SLA policies
  • 4 custom icons

Installation Procedure​

Step 0. Utility Requirements​

  • Python 3.12 or newer
  • administrative access to Search Anywhere Framework
  • key-based SSH access to the SA Web node
  • permission to run sudo without a password to install custom icons

Step 1. Install Utility Dependencies​

Extract the utility archive and run this command from its directory:

bash bin/install_dependencies.sh

Step 2. Deploy Utility Objects​

Pass the password through an environment variable and run the installation:

export SAF_PASSWORD='<password>'
./bin/make_database_observability.py \
  --sm_host <SEARCH_ANYWHERE_FRAMEWORK_HOST> \
  --sm_api_port 5601 \
  --sm_cluster_port 9200 \
  --sm_user admin \
  --ssh_user <SSH_USER>

If the command exits with code 3, wait for the health model services to be created. Install the analytics center ten minutes later:

./bin/make_database_observability.py \
  --sm_host <SEARCH_ANYWHERE_FRAMEWORK_HOST> \
  --sm_user admin \
  --only analytics_centre

Step 3. Verify Utility Objects​

1. Index Patterns​

Check that the index patterns are present:

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

Index patterns

2. Search Macro​

Check that the db_exclude_self macro appears in the macro list.

Search macro

3. Lookups​

Check that all six module lookups are present:

Main Menu - Lookups

Lookups

4. Asset Configurations​

Check that all three asset configurations are present in Inventory.

Asset configurations

5. Incident Type​

Check that the db_incident type is present:

Main Menu - Settings - Module Settings - Incident Manager - Incident Types

Incident type

6. SLA Policies​

Check that both SLA policies are present:

Main Menu - Settings - Module Settings - Incident Manager - SLA Policies

SLA policies

7. Service Monitor Toolkit Metrics​

Check that all eight metrics are present:

Main Menu - Service Monitor Toolkit - Metrics

Service Monitor Toolkit metrics

8. Health Model​

Check that the DB Observability: Databases health model is present:

Main Menu - Service Monitor Toolkit - Health Models

Health model

9. Analytics Center​

Check that the module's analytics center is present:

Main Menu - Service Monitor Toolkit - Analytics Centers

Analytics center