Skip to main content

Finalize and validate the upgrade

Follow these steps to perform the final tasks for an upgrade to Moogsoft Enterprise v8.2.0 from v7.0.x, v7.1,.x, v7.2.x, or v7.3.x.

Refer to Upgrade Moogsoft Enterprise for general information and upgrade instructions for other components and versions.

Configure the ServiceNow MID server to use Java 8

Configure Opensearch/Elasticsearch heap size

The minimum and maximum JVM heap sizes must be large enough to ensure that Elasticsearch starts.

To set the minimum and maximum JVM heap sizes:

  • For RPM, edit the /etc/elasticsearch/jvm.options file.

  • For Tarball, edit the $MOOGSOFT_HOME/cots/elasticsearch/config/jvm.options file.

These heap sizes must be the same value. For example, to set the heap to 4 GB:

# Xms represents the initial size of total heap space
# Xmx represents the maximum size of total heap space

-Xms4g
-Xmx4g

If you change the heap size, you must restart Elasticsearch:

  • For RPM, run service elasticsearch restart.

  • For Tarball, run $MOOGSOFT_HOME/bin/utils/process_cntl elasticsearch restart.

Upgrade Moogsoft Add-ons

Moogsoft periodically releases add-ons to extend and enhance the core Moogsoft Enterprise functionality. For example, new Workflow Engine functions, new Workflow Engines, or Integrations tiles. All add-ons releases are cumulative and include the fixes from previous releases.

Upgrading the Moogsoft Enterprise core components replaces any manually installed add-ons with versions of those add-ons that come with the upgrade by default. These default versions can be an earlier version than the manually installed versions of the add-ons.

Once you have finished upgrading the core components, you should install the Moogsoft Enterprise add-ons to ensure you have the latest versions of these add-ons.

See Install Moogsoft Add-ons for more information on how to install the Moogsoft Enterprise add-ons.

Restart services and processes

Finalize the Events Analyser configuration

You can configure the Events Analyser in v8.0.x in two ways:

  • Use the Events Analyser database configuration and schedule. This is the default method for Moogsoft Enterprise v8.0.x.

  • Use the event_analyser.conf file (for example in the case of significant customisations) and schedule through cronjob. This is the pre-v8.0.x method. See the 'Important' section below for steps if this is needed.

We recommend that you use the default Events Analyser database configuration and schedule method. Upgrading to Moogsoft Enterprise v8.0.x automatically creates the database configuration and schedule.

After you have finished the upgrade, you must update the cronjob to check each minute if the job needs to run. Remove any existing cronjobs by running the following:

(crontab -l | grep -v events_analyser) | crontab -

Add the new cronjob:

$MOOGSOFT_HOME/bin/utils/moog_init_server.sh -e

Important

If you are using a significantly customised Events Analyser configuration file or are running the Events Analyser using the stream or partition flags, you should continue to use the pre-v8.0.x method.

Uncomment the existing events_analyser cronjob(s):

(crontab -l | sed -e 's/^\#\+\(.*events_analyser.*\)/\1/') | crontab -

Use the crontab -e command (a 'vi'-like editor) to update any events_analyser cronjobs.

Specify the events_analyser configuration file at the end of each events_analyser command. The following example schedules a run every day at 3am, and each run will analyze two weeks of data. We recommend that you use this schedule if you do not have an existing schedule that works for your deployment.

03 * * * /usr/share/moogsoft/bin/events_analyser --incremental --readage 2w --config /usr/share/moogsoft/config/events_analyser.conf

If you want to migrate from the pre-v8.0.x method to the v8.0.x database method, contact Moogsoft Support.

Reindex Opensearch/Elasticsearch

Reconfigure UI integrations

If you have configured an xMatters or Dynatrace Synthetic UI integration, then these have are deprecated in 8.0.x. If you do not have these UI integrations installed, the section below can be skipped.

Important

This section is for offline deployments only, which had a configured xMatters or Dynatrace Synthetic UI integration installed.

These steps must be run on the UI server only

Download the following two files and place them in $MOOGSOFT_HOME/etc/integrations/deprecated to be able to view the configuration.

  • https://integrations-downloads.s3.amazonaws.com/deprecated/dynatrace_synthetic_lam.zip

  • https://integrations-downloads.s3.amazonaws.com/deprecated/xMatters.zip

Run the following commands to ensure the old integrations can be safely removed:

mkdir -p $MOOGSOFT_HOME/etc/integrations/deprecated
chown -R moogsoft:moogsoft $MOOGSOFT_HOME/etc/integrations/deprecated
cp dynatrace_synthetic_lam.zip $MOOGSOFT_HOME/etc/integrations/deprecated
cp xMatters.zip $MOOGSOFT_HOME/etc/integrations/deprecated

Restart apache-tomcat:

  • For non-root tarball deployments: $MOOGSOFT_HOME/bin/utils/process_cntl apache-tomcat restart

  • For RPM deployments: service apache-tomcat restart

The xMatters and Dynatrace Synthetic UI integrations should now be uninstalled from using the UI.

Validate the upgrade: UI components

Note

Run the following commands/tasks on the server that houses the UI components. See Upgrade Moogsoft Enterprise for a description of the component groups.

Validate the upgrade: Core components

Note

Run the following command on the server that houses the core components. See Upgrade Moogsoft Enterprise for a description of the component groups.

Validate the upgrade: Data ingestion components

Note

Run the following command on the server that houses the data ingestion components. See Upgrade Moogsoft Enterprise for a description of the component groups.

Validate the upgrade: Database components

Note

Run the following command on the server that houses the database components. See Upgrade Moogsoft Enterprise for a description of the component groups.

Add Tempus (optional)

A new install of Moogsoft Enterprise v8.0.x includes the Tempus clustering algorithm by default. You will need to add Tempus manually when you upgrade to v8.0.x if you did not already add Tempus to an earlier version of your Moogsoft Enterprise deployment.

Run the following command to add the default configuration of Tempus to Moogsoft Enterprise. Replace the following parameters' default values if required:

  • run_on_startup: Set this value to true to enable Tempus.

    You can also enable Tempus by going to System Settings in the UI after you have run this command.

  • localhost: If you run the command from a different server to your UI server, replace localhost with the hostname of your UI server.

  • graze:graze: Replace graze:graze with the credentials of a user with the grazer role in your deployment if needed.

  • MaintenanceWindowManager: If the non-Tempus clustering algorithms do not process events from the Maintenance Window Manager Moolet, replace this default value with the Moolet that the non-Tempus clustering algorithms process events from.

    See Clustering Algorithm Guide for more information on the non-Tempus clustering algorithms.

    See Configure Alert Behavior During a Maintenance Window for more information on this Moolet.

curl -X POST -u graze:graze -k "https://localhost/graze/v1/addTempus" -H "Content-Type: application/json; charset=UTF-8" --data '{
"name" : "Time Based (Tempus)",
"description" : "A Tempus Situation",
"run_on_startup" : false,
"entropy_threshold" : 0.0,
"threshold_type" : "global",
"process_output_of" : [ "MaintenanceWindowManager" ],
"execution_interval" : 60,
"window_size" : 1200,
"bucket_size" : 5,
"arrival_spread" : 15,
"minimum_arrival_similarity" : 0.6667,
"alert_threshold" : 4,
"pre_partition" : null,
"partition_by" : null,
"significance_test" : "Poisson1",
"significance_threshold" : 1,
"detection_algorithm" : "Louvain"
}'

See the Time-based Clustering with Tempus for more information on this clustering algorithm.

Next steps

Now that the upgrade is complete, follow the instructions in Post upgrade steps.