AnalyticsWizard

The Oracle Communications Unified Assurance AnalyticsWizard sets up the Historical database for Observability, Flow, and Log Analytics. This includes starting the MySQL Replication Data Importer service, which imports event and journal data from the Event database into the Historical database.

AnalyticsWizard can also:

• Update database templates after you have added custom fields to the Event database. See Adding Custom Fields to the Event Database.

• Finalize the migration from Elasticsearch to OpenSearch after you have migrated all data and artifacts. See About Migration in Unified Assurance Migration Guide.

You run AnalyticsWizard from the command line. When configuring the Historical database, you can run it interactively, or headlessly, using the --No-Prompt option described in Administration Details.

You typically run AnalyticsWizard during the initial Unified Assurance setup. You can also run it later, to add new servers to an existing Historical database cluster. In this situation:

• Before running AnalyticsWizard, confirm that the Historical database cluster is in green or yellow status:

  1. From the main navigation menu, select Analytics, then Events, then Administration, and then Console.

  2. Enter the following request in the console and click the arrow to run the request:

     GET _cluster/health
     

     The response should contain "status": "green" or "status": "yellow".

• After running AnalyticsWizard:

  1. Increase the number of replicas for indexes. See Increasing Replicas for Indexes.

  2. If you also have an existing microservice cluster, update the configmap for the microservice cluster. See Updating Microservice Cluster Configurations.

Administration Details

The following list shows the technical details you will need for advanced administration of the application:

• Package: historicalProcessing-app

• Synopsis: ./AnalyticsWizard [OPTIONS]

• Options:

  • Use the following options to run AnalyticsWizard headlessly when setting up the Historical database:

    • --No-Prompt: Set this option to allow AnalyticsWizard to configure the Historical database headlessly. If you do not specify --ClusterName and either --Heap Size or --HeapPercentage, the default values are used. Appropriate servers are automatically selected for the OpenSearch components, including the UI, database, and MySQL Replication Data Importer.

    • --HeapSize: Set this to an integer to specify the heap size, in GB, to use for the Historical database. If not specified, the default value of 30 percent of system memory is used. Set either this or --HeapPercentage, not both.

    • --HeapPercentage: Set this to an integer to specify percentage of total memory to use for the Historical database. If not specified, the default value of 30 percent of system memory is used. Set either this or --HeapSize, not both.

    • --ClusterName: Set this to a string to specify the name to use for the Historical database cluster. If not specified, the default value of opensearch-pri is used for a primary cluster and opensearch-sec is used for a secondary cluster.

  • --Update-Templates: Set this option to allow AnalyticsWizard to update the database templates after you have added custom fields to the Event database.

  • --Finalize-Update: Set this option to allow AnalyticsWizard to remove all the references of Elasticsearch, Kibana, and Filebeat.

    Caution:

    Use this option only after completing the Historical database migration to OpenSearch. See About Migration in Unified Assurance Migration Guide for information.

  • ?, -h, --Help: Print usage and exit

• Threaded: Single Threaded