IBM Support

QRadar: Starting apps that are in an ERROR state or do not display in the user interface

Troubleshooting


Problem

Administrators or users might notice that when they log in to the QRadar® Console that the tab or the contents of an app is not visible in the user interface. The procedures outlined in this article explore common issues with apps not starting or in an error state and how to resolved them.

Symptom

The following conditions indicate that an application is not started or cannot start due to an error:
  • Installed Apps do not display as a tab in the banner.
  • Apps display as a tab, but the contents list an error, such as Bad Gateway, 404 error, or missing visualizations and data.
  • The Assistant app shield is not being displayed in the banner of the user interface.
    image 6674
    Example 1:  Assistant app shield is missing and the User Behavior Analytics app displays a gateway error.

Resolving The Problem

There are multiple methods to resolve most issues with Apps not starting or in an error state. The QRadar® Assistant app is always the first and preferred method to work with apps. If the QRadar® Assistant app shield is not visible in the QRadar® User Interface, then administrators can use of one of the alternate methods to resolve the issue.  For QRadar 7.4 versions, administrators can use the qappmanager utility or the API. QRadar 7.4 versions have enhanced features such as multitenant instances and better error correction capabilities. QRadar® V7.3, administrators need to use the API to restart the apps.

Tip: In some instances the app can display a status of RUNNING, but it is not working as expected or does not display properly in the user interface. To confirm an app is operational the administrator can stop the app, then start it, which forces the app to load.

Start an application in the error state with the QRadar Assistant app

To resolve the issue by using the QRadar Assistant app.

  1. Log in the QRadar Console as admin user.
  2. Click the QRadar Assistant app shield.
    image 6829
  3. Click Applications.
  4. Click Manage.
    image 6831
  5. Under Installed Extensions, locate the App with the issue.
    Note: The red bar indicates an application is in an error state or stopped.
    image 6836
  6. In the Options column, click the ellipsis (...) to expand the menu.
  7. Click Start All Instances.
Results
The app instance starts and the bar changes from red to blue if successful.
image 6834

How to start an app with the qappmanager utility (advanced)

The qappmanager utility is installed on QRadar V7.4 Console appliances after an auto update is run for the first time. The utility has all the functionality of the recon utility and the API to manage apps. It also has more functionality to manage apps. The scope of this article is to address how to use the utility to start or stop apps that might not be appearing in the UI or are in an error state. In some cases apps are not showing in the UI and not in an error state, but restating the app can resolve the issue.

Notes

  • This application is intended primarily for QRadar Support representatives and is considered a support tool.
  • In order to perform these steps you need to have an authentication token with admin rights.
  • You don't need to have the token, but this token needs to exist. On step 4, the tool displays the existing tokens and requests to select one with admin rights.
  • For more information on how to create the authentication token, check Creating an authorized service token for QRadar Operations.

To use the qappmanager:

  1. Use SSH to log in to the Console as root user.
  2. Type the command: /opt/qradar/support/qappmanager
    Note: The Assistant app will be used as an example. image 6847
  3. From the Options list, select App instance - start (23).
    image 6839
  4. Type the number associated with the Authorized Service for your app.
    Note: This must be an Admin security profile.
    image 6840
  5. Type the application ID for the app you want to start. The QRadar Assistant app 1453 is used in the example.
    image 6848
  6. The application should display a status of RUNNING.
    image 7147
  7. From Choose option, enter 0 to exit the qappmanager utility.
Results
After the QRadar Assistant app starts, administrators can start other application instances from the user interface.

Using the API to start or stop and application

The qappmanager is not available in QRadar 7.3.x versions so administrators need to use the Developers interactive API to locate the App-ID and start the app.

To resolve the issue by using the recon utility and API.

  1. Log in to the Console as admin user.
  2. Click the navigation menu (☰) > Interactive API for Developers
  3. Expand gui_app_framework.
  4. Click Applications.
    image 6867
  5. Click Try It Out
  6. Search in the Response Body for the application that is not working. Record the Application ID and its status.
    image 6869
  7. Expand applications.
  8. Click application_id.
  9. Click POST.
  10. In the Parameter application_id, enter the App-ID from step #6
    image 6871
  11. In the Parameter status, enter RUNNING.
  12. Click Try it Out!
Results
The Response Body displays a message similar to:
{
  "installed_on": 1579643001405,
  "application_state": {
    "memory": 2000,
    "application_id": "1101",
    "status": "STARTING"
  },
  "manifest": {
    "description": "Machine Learning Analytics",
    "console_ip": "192.168.0.80",
    "uuid": "3f42e91e-bab9-4e7f-a943-64067a728f70",
    "app_id": 1101,
    "multitenancy_safe": "true",
    "resources": {
      "memory": 2000
    },
    "version": "3.8.0",
    "dependencies": {
      "rpms_directory": "/src_deps/init/rpms",
      "pip_directory": "/src_deps/init/pip"
Results
These three procedure methods can resolve most issues with apps not starting, displaying an error status, or missing data in the app tab. If these procedures do not resolve the issue with your apps, contact IBM QRadar support.

Document Location

Worldwide

[{"Line of Business":{"code":"LOB24","label":"Security Software"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSBQAC","label":"IBM Security QRadar SIEM"},"ARM Category":[{"code":"a8m0z000000cwt3AAA","label":"QRadar Apps"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Version(s)"}]

Document Information

Modified date:
05 April 2024

UID

ibm16349171