Splunk® IT Service Intelligence

Administration Manual

Use the ITSI Upgrade Readiness Dashboard

The ITSI Upgrade Readiness Dashboard displays the results of a nightly upgrade readiness check that detects common ITSI issues in your environment before you upgrade to the next ITSI version. The dashboard surfaces and provides steps to resolve these issues so you can successfully upgrade your environment. For more information about upgrading ITSI, see Install Splunk IT Service Intelligence on a single instance.

ITSI upgrades might fail due to issues outside of those checked by the Upgrade Readiness dashboard. For more information, see Troubleshooting ITSI upgrades and Rolling back an upgrade of ITSI.

You must have the admin role to access this dashboard. The dashboard populates after the upgrade readiness job runs every 24 hours.

Dashboard panels

Panel Description
No issues Displays the status of each specific job that checks for issues that may interfere with the ITSI upgrade. If no issues are detected, the dashboard displays the green checkmark icon A small circle with a check in the middle. For example, if the job doesn't detect any KPIs with missing threshold levels, the check for Missing KPI Threshold Levels displays this green checkmark icon.
Upgrade precheck name Select each check name to view a more detailed description and remediation steps. Drill down to view the specific objects affected by each check by selecting the Open in Search button on the dashboard.


Additionally, the dashboard lists extra details about each check:

  • Severity: describes the level of impact that the error might have on the upgrade. There are 3 severity levels: Minor, Moderate, and Major. A minor or moderate severity error will not stop an upgrade, but might cause issues with functionality. However, though you'll still be able to proceed with upgrading to the next version, an error categorized with major severity will likely cause a failure during the upgrade process.
  • Blocks Upgrade: if this is True, it is highly recommended you address errors before upgrading your ITSI environment to prevent potential failures or errors. However, you can still proceed with upgrading to the next version of ITSI even if errors are identified.
  • Category: displays the type of objects affected by the error, such as Services or Service Templates.
  • Description: A summary of the issue.
  • Resolution: Steps you can take to resolve the issue.
  • Documentation: A link to related documentation for the affected objects.

For more information about each check, see the Upgrade error reference.

Number of prechecks with issues detected Displays the number of upgrade checks that did not pass and require attention before you upgrade your environment.

Manually start a check

Select the Start new precheck button on the dashboard page to manually start a new upgrade readiness check. Refresh the page after the precheck runs to view the most up to date data on the dashboard. For example, if you remediate an error and select this button to run a precheck again, the error should no longer surface on the dashboard.

Run automatic fixes before upgrading ITSI

Instead of manual troubleshooting, you can automatically resolve errors or configuration issues by selecting the Run fix button when available. Selecting this button runs a job in the backend that fixes issues with your current configuration, and prepares your environment for a successful upgrade. For example, when you select Run fix for the Linked services missing error, a job runs that links the missing service dependencies to the correct service templates.

Do not run a backup or restore operation at the same time that an automatic fix job is running to avoid conflicts between the fix and the backup or restore operation.

Upgrade error reference

The table below lists the types of errors that pre-checks identify before you can upgrade ITSI to the latest version. These errors display on the ITSI Upgrade Readiness dashboard.

Error name Description Resolution Severity Automatic fix available? (Yes/No)
Service templates missing A service isn't linked to the correct service templates. From the service configuration page, link the missing service templates to the service. View the services that require configuration on the Search page. Minor Yes
Incorrect service linked to entity Some services assigned to the entity need to be removed. Add the service to the entity if the entity's filter rule references the service, but the service is not yet associated with the entity. Remove the service from the entity if the entity's filter rule doesn't reference the service. Major Yes
Missing capabilities for itoa_admin role One or more default capabilities are missing for an itoa_admin role. Add the missing capabilities to the itoa_admin role. Select the Open in Search button to view the missing capabilities. Major No
Service has no associated entities to filter The KPI base search has entity filtering turned on for the service, but the service does not have associated entities. Update the service to have entity filter rule. Major No
Maximum number of KPIs using base search reached The maximum number of KPIs using this base search has been reached. Clone the base search, and link existing KPIs from the original search to the cloned search. See the list of searches that have reached the maximum number of associated KPIs by selecting the Open in Search button. Major No
Entity assigned to deleted service Entities are assigned to one or more deleted services. Remove the deleted services from the entity. Major Yes
Missing KPI threshold levels One or more of your KPIs are missing threshold levels. Add the missing KPI threshold field to the KPI. View a list of KPIs to edit by selecting the Open in Search button. Moderate No
Incorrect KPI base search reference Services or service templates display an inaccurate dependency with one or more shared KPI base searches. For example, one of your services shows that it is dependent on a shared KPI base search that doesn't exist in your system. For the KPIs of services, update the KPI search type from base search to adhoc search. View a list of KPIs to edit by selecting the Open in Search button.

For the KPIs of service templates, update the current base search to a different base search. View a list of KPIs to edit by selecting the Open in Search button.

Moderate No
KPIs with missing KPI threshold template Services or service templates display an inaccurate dependency with one or more KPI threshold templates. Update the KPI threshold configuration. View a list of KPIs to edit by selecting the Open in Search button. Moderate Yes
Objects having KPIs with incorrect search type KPIs aren't configured with the correct search type. Update the KPI to the correct search type. View a list of KPIs to edit by selecting the Open in Search button. Moderate No
Missing KPI base search KPIs linked to services or service templates are missing a base search ID field. For the KPIs of services, update the KPI search type from base search to adhoc search. View a list of KPIs to edit by selecting the Open in Search button.

For the KPIs of service templates, update the current base search to a different base search. View a list of KPIs to edit by selecting the Open in Search button.

Moderate Yes

Note: An automatic fix is only available for KPIs of services. You must manually fix the missing base searches for KPIs of service templates.

Incorrect linked services Service templates are linked to services that don't exist. Add a tag to the service to remove the incorrect linked services. Moderate Yes
Linked services missing Service templates don't display the correct linked services. From the service configuration, link the service to the correct service template. Minor Yes
Incorrect linked services number The number of linked services does not match the total linked services field for a service template. Add a tag to the service template to resolve the discrepancy. Minor Yes
Sync status field error The sync status field is not set to 'synced'. Add a tag to the service template in order for the 'synced' status to display or resolve the issue using the last_sync_error message. Major No
Incorrect service dependencies A service is incorrectly displayed as the dependent of another service that doesn't exist. This precheck error won't affect your upgrade. Minor Yes
Main service dependencies missing A service doesn't display the other services that it depends on. This precheck error won't affect your upgrade. Minor Yes
Dependent services missing A service doesn't display the correct dependent services. Add the correct dependent services to the main service. Minor Yes
Duplicate Service names One or more services has the same name as an existing service. Change or update one of the duplicate service names. Moderate No
Incorrect dependent services A service has inaccurate service dependencies. A service may have been deleted yet still continues to be linked as a dependent service. Run the automatic backend fix to remove the incorrect dependent services. Moderate Yes
Last modified on 17 June, 2024
Use the ITSI SVC Statistics dashboard   Use the ITSI Configuration Assistant

This documentation applies to the following versions of Splunk® IT Service Intelligence: 4.19.0


Was this topic useful?







You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters