FAQ: TruSTAR for IBM QRadar
- Manually Installing the TruSTAR App
- Updating the App
- Uninstalling the App
- Q. Why don’t I see an offense or event in TruSTAR?
- Q. Why is the submitted offense missing some events in TruSTAR?
- Q. Can I check the event submission logs?
- Q. I’m getting the following error message. What should I do now?
- Q. How do I locate my TruSTAR log files and configuration files?
- Q. When I try to save the configuration with my API keys, I see this message ‘Fail: Unable to validate TruSTAR credentials’.
- Q. My issue isn’t listed here. How do I collect data to work with TruSTAR support?
This document explains how to manually install the TruSTAR App for IBM QRadar, update the app, or uninstall it. The document also covers troubleshooting and known issues.
Manually Installing the TruSTAR App
- Download the latest version of the TruSTAR Workflow App for QRadar at this link.
- Navigate to the QRadar Admin tab.
- Click Extension Management.
- Click Add and select the TruSTAR App bundle from the location you downloaded it to.
- Click Install Immediately, then click OK to begin the installation.
You now see the TruSTAR Workflow App settings on the QRadar Admin page and buttons that show the available TruSTAR actions.
Updating the App
- Navigate to the Admin Tab
- Click Extension Management.
- Click Add and select the TruSTAR App bundle application.
- Click Install Immediately.
- Click OK.
Uninstalling the App
- Go to the QRadar Admin Page
- Click Extension Management.
- Select the TruSTAR App for QRadar application
- Click Uninstall.
Q. Why don’t I see an offense or event in TruSTAR?
A. There are two reasons why you may not see an offense or an event in TruSTAR:
- If you configured the Offense Exclusion Filter with specific values and the offense matches one of those values, then that offense will not be submitted to TruSTAR.
- If you configured the Event Exclusion Filter and all the events associated with that offense match one of those filters, then the offense will not be submitted to TruSTAR.
Q. Why is the submitted offense missing some events in TruSTAR?
A. If you configured the Event Exclusion Filter and some of the events associated with that offense match one of those filters, then those events will not be submitted to TruSTAR.
Q. Can I check the event submission logs?
A. You can check event submission logs from the QRadar console. Search in the Log Activity Quick Filter using this format:
APP_ID/<app_id of TruSTAR app> where the <app_id of TruSTAR app> is the TruSTAR application ID. In the graphic below, the APP_ID is 1051.
You can then read through the list to check whether the event has been submitted.
Q. I’m getting the following error message. What should I do now?
A. Work with a QRadar Admin user to execute the following procedure on the QRadar instance where the error occurred.
- Go to Admin->Advanced.
- Click Deploy Full Configuration. This action sends a request to rebuild all configuration file sets. Each QRadar instance contains its own configuration files which then restarts services to ensure that the new configuration is loaded.
Q. How do I locate my TruSTAR log files and configuration files?
The TruSTAR Workflow App for QRadar runs in a Docker container that is alive from the time of the App installation. (QRadar automatically launches this container every time the QRadar main application is restarted.) Your log files and config file are located inside that container in the /store/ directory. However, since you may be running multiple Docker containers, you will need to search for the TruSTAR container by listing all the Docker containers and then searching each container individually.
Listing the Docker Containers
- SSH into the QRadar host (your linux user account needs sudo permission).
- List the running containers using this command:
sudo docker ps
Searching the Docker Containers
You must search each container to locate the one with the TruSTAR files.
- To do this, use this command to open a shell script in the first container:
sudo docker exec -it [container ID] /bin/bash
- Navigate to that container's /store/log/ directory and then look for files that contain "trustar" in the filenames.
- If the container doesn't have any "trustar" files, you can exit that container and return to the list of containers.
- Choose the next container on the list, then repeat the search in that container.
- Continue the search procedure until you locate the container with the TruSTAR files.
Q. When I try to save the configuration with my API keys, I see this message ‘Fail: Unable to validate TruSTAR credentials’.
A. To confirm this is an issue, check that you are using valid API keys from TruSTAR for that user profile. Finding Your API Keys
If this is not the issue then it may be related to categorizing the URL https://station.trustar.co as a threat and blocking the URL in your firewall. Please confirm that your URL filtering profile is not preventing any communication with TruSTAR's URL.
Q. My issue isn’t listed here. How do I collect data to work with TruSTAR support?
A. To begin the process of filing a support issue with TruSTAR, first download the App logs using this procedure:
- Click System and License Management in the QRadar Admin Panel.
- Select the host on which the TruSTAR App is installed
- Click Actions in the top panel and select the Collect Log Files option. This opens the Log File Collection popup window.
- Click Advanced Options.
- Select these checkboxes:
- Include Debug Logs
- Include Application Extension Logs
- Include Setup Logs (Current Version)
- Specify the number of days in the Collect Logs for This Many Days field.
- Click Collect Log Files.
- Click Click here to download files. This will download all the log files into a single zip on your local machine.
You can then contact TruSTAR support to create a support case.
If the submitted event contains certain special characters, the event may not be submitted to TruSTAR. You can view the event submission log to check if an event has been submitted.