Troubleshooting your Microsoft Sentinel solution for SAP applications deployment
This article includes troubleshooting steps to help you ensure accurate and timely data ingestion and monitoring for your SAP environment with Microsoft Sentinel.
In this article, we refer to the systemconfig.json file, which is used for agent versions released on or after June 22, 2023. If you're using an earlier version of the agent, refer to the systemconfig.ini file instead.
Useful Docker commands
When troubleshooting your Microsoft Sentinel for SAP data connector, you might find the following commands useful:
Function | Command |
---|---|
Stop the Docker container | docker stop sapcon-[SID] |
Start the Docker container | docker start sapcon-[SID] |
View Docker system logs | docker logs -f sapcon-[SID] |
Enter the Docker container | docker exec -it sapcon-[SID] bash |
For more information, see the Docker CLI documentation.
Review system logs
We highly recommend that you review the system logs after installing or resetting the data connector.
Run:
docker logs -f sapcon-[SID]
Enable/disable debug mode printing
On your data collector agent container virtual machine, edit the /opt/sapcon/[SID]/systemconfig.json file.
Define the General section if it wasn't previously defined. In this section, define
logging_debug = True
to enable debug mode printing, orlogging_debug = False
to disable it.For example:
[General] logging_debug = True
Save the file.
The change takes effect approximately two minutes after you save the file. You don't need to restart the Docker container.
View all container execution logs
Connector execution logs for your Microsoft Sentinel solution for SAP applications data connector deployment are stored on your VM in /opt/sapcon/[SID]/log/. Log filename is OmniLog.log. A history of logfiles is kept, suffixed with .[number] such as OmniLog.log.1, OmniLog.log.2, and so on.
Review and update the Microsoft Sentinel for SAP agent connector configuration file
If you deployed your agent via the portal, you can continue to maintain and change configuration settings via the portal.
If you deployed via the command line, or want to make manual updates directly to the configuration file, perform the following steps:
On your VM, open the configuration file: sapcon/[SID]/systemconfig.json
Update the configuration if needed, and save the file. For more information, see the Microsoft Sentinel solution for SAP applications
systemconfig.json
file reference.
The change takes effect approximately two minutes after you save the file. You don't need to restart the Docker container.
Reset the Microsoft Sentinel for SAP data connector
The following steps reset the connector and reingest SAP logs from the last 30 minutes.
Stop the connector. Run:
docker stop sapcon-[SID]
Delete the metadata.db file from the /opt/sapcon/[SID] directory. Run:
cd /opt/sapcon/<SID> rm metadata.db
Note
The metadata.db file contains the last timestamp for each of the logs, and works to prevent duplication.
Start the connector again. Run:
docker start sapcon-[SID]
Make sure to Review system logs when you're done.
Common issues
After having deployed both the Microsoft Sentinel for SAP data connector and security content, you might experience the following errors or issues:
Corrupt or missing SAP SDK file
This error might occur when the connector fails to boot with PyRfc, or zip-related error messages are shown.
- Reinstall the SAP SDK.
- Verify that you're the correct Linux 64-bit version, such as nwrfc750P_8-70002752.zip.
If you'd installed the data connector manually, make sure that you'd copied the SDK file into the Docker container.
Run:
docker cp nwrfc750P_8-70002752.zip /sapcon-app/inst/
ABAP runtime errors appear on a large system
If ABAP runtime errors appear on large systems, try setting a smaller chunk size:
Edit the /opt/sapcon/[SID]/systemconfig.json file and in the Connector Configuration section define
timechunk = 5
.For example:
[Connector Configuration] timechunk = 5
Save the file.
The change takes effect approximately two minutes after you save the file. You don't need to restart the Docker container.
Note
The timechunk size is defined in minutes.
Empty or no audit log retrieved, with no special error messages
- Check that audit logging is enabled in SAP.
- Verify the SM19 or RSAU_CONFIG transactions.
- Enable any events as needed.
- Verify whether messages arrive and exist in the SAP SM20 or RSAU_READ_LOG, without any special errors appearing on the connector log.
Incorrect workspace ID or key in key vault
If you realize that you entered an incorrect workspace ID or key in your deployment script, update the credentials stored in Azure key vault.
After verifying your credentials in Azure KeyVault, restart the container:
docker restart sapcon-[SID]
Incorrect SAP ABAP user credentials in key vault
Check your credentials and fix them as needed, applying the correct values to the ABAPUSER and ABAPPASS values in Azure Key Vault.
Then, restart the container:
docker restart sapcon-[SID]
Incorrect SAP ABAP user credentials in a fixed configuration
A fixed configuration is when the password is stored directly in the systemconfig.json configuration file.
If your credentials there are incorrect, verify your credentials.
Use base64 encryption to encrypt the user and password. You can use online encryption tools to do encrypt your credentials, such as https://www.base64encode.org/.
Missing ABAP (SAP user) permissions
If you get an error message similar to: ..Missing Backend RFC Authorization.., your SAP authorizations and role weren't applied properly.
Ensure that the MSFTSEN/SENTINEL_CONNECTOR role was imported as part of a change request transport, and applied to the connector user.
Run the role generation and user comparison process using the SAP transaction PFCG.
Missing data in your workbooks or alerts
If you find that you're missing data in your Microsoft Sentinel workbooks or alerts, ensure that the Auditlog policy is properly enabled on the SAP side, with no errors in the container log file.
Use the RSAU_CONFIG_LOG transaction for this step.
For more information, see the SAP documentation and Collect SAP HANA audit logs in Microsoft Sentinel.
Missing IP address or transaction code fields in the SAP audit log
In SAP systems with versions for SAP BASIS 7.5 SP12 and above, Microsoft Sentinel can reflect extra fields in the ABAPAuditLog_CL
and SAPAuditLog
tables.
If you're using SAP BASIS versions higher than 7.5 SP12 and are missing IP address or transaction code fields in the SAP audit log, verify that the SAP system from which you're extracting the data contains the relevant change requests (transports). For more information, see Configure support for extra data retrieval (recommended).
Missing SAP change request
If you see errors that you're missing a required SAP change request, make sure you've imported the correct SAP change request for your system. For more information, see SAP prerequisites and Configure your SAP system for the Microsoft Sentinel solution.
No data is showing in the SAP table data log
In SAP systems with versions for SAP BASIS 7.5 SP12 and above, Microsoft Sentinel can reflect table data log changes in the ABAPTableDataLog_CL
table.
If no data is showing in the ABAPTableDataLog_CL
table, verify that the SAP system from which you're extracting the data contains the relevant change requests (transports). For more information, see Configure support for extra data retrieval (recommended).
No records / late records
The data collector agent relies on time zone information to be correct. If you see that there are no records in the SAP audit and change logs, or if records are constantly a few hours behind, check whether the SAP TZCUSTHELP report presents any errors. For more information, see SAP note 481835.
There might also be issues with the clock on the virtual machine where the data collector agent container is hosted, and any deviation from the clock on the VM from UTC impacts data collection. Even more importantly, the clocks on both the SAP system machines and the data collector agent machines must match.
Network connectivity issues
If you're having network connectivity issues to the SAP environment or to Microsoft Sentinel, check your network connectivity to make sure data is flowing as expected.
Common issues include:
Firewalls between the docker container and the SAP hosts might be blocking traffic. The SAP host receives communication via the following TCP ports, which must be open: 32xx, 5xx13, and 33xx, where xx is the SAP instance number.
Outbound communication from your SAP agent host to Microsoft Container Registry or Azure requires proxy configuration. This typically impacts the installation and requires you to configure the
HTTP_PROXY
andHTTPS_PROXY
environmental variables. You can also ingest environment variables into the docker container when you create the container, by adding the-e
flag to the dockercreate
/run
command.
Retrieving an audit log fails with warnings
If you attempt to retrieve an audit log without the required configurations and the process fails with warnings, verify that the SAP Auditlog can be retrieved using one of the following methods:
- Using a compatibility mode called XAL on older versions
- Using a version not recently patched
- Without any changes made for connecting to the Microsoft Sentinel data connector agent. For more information, see Configure your SAP system for the Microsoft Sentinel solution.
While your system should automatically switch to compatibility mode if needed, you might need to switch it manually. To switch to compatibility mode manually:
Edit the /opt/sapcon/[SID]/systemconfig.json file.
In the Connector Configuration section defineefine:
auditlogforcexal = True
For example:
[Connector Configuration] auditlogforcexal = True
Save the file.
The change takes effect approximately two minutes after you save the file. You don't need to restart the Docker container.
SAPCONTROL or JAVA subsystems unable to connect
Check that the OS user is valid and can run the following command on the target SAP system:
sapcontrol -nr <SID> -function GetSystemInstanceList
SAPCONTROL or JAVA subsystem fails with timezone-related error message
If your SAPCONTROL or JAVA subsystem fails with a timezone-related error message, such as: Please check the configuration and network access to the SAP server - 'Etc/NZST', make sure that you're using standard timezone codes.
For example, use javatz = GMT+12
or abaptz = GMT-3**
.
Audit log data not ingested past initial load
If the SAP audit log data, visible in either the RSAU_READ_LOAD or SM200 transactions, isn't ingested into Microsoft Sentinel past the initial load, you might have a misconfiguration of the SAP system and the SAP host operating system.
- Initial loads are ingested after a fresh installation of the Microsoft Sentinel for SAP data connector, or after the metadata.db file is deleted.
- A sample misconfiguration might be when your SAP system timezone is set to CET in the STZAC transaction, but the SAP host operating system time zone is set to UTC.
To check for misconfigurations, run the RSDBTIME report in transaction SE38. If you find a mismatch between the SAP system and the SAP host operating system:
Stop the Docker container. Run
docker stop sapcon-[SID]
Delete the metadata.db file from the /opt/sapcon/[SID] directory. Run:
rm /opt/sapcon/[SID]/metadata.db
Update the SAP system and the SAP host operating system so that they have matching settings, such as the same time zone. For more information, see the SAP Community Wiki.
Start the container again. Run:
docker start sapcon-[SID]
Other unexpected issues
If you have unexpected issues not listed in this article, try the following steps:
- Reset the connector and reload your logs
- Upgrade the connector to the latest version.
Tip
Resetting your connector and ensuring that you have the latest upgrades are also recommended after any major configuration changes.
Related content
Learn more about the Microsoft Sentinel solution for SAP applications:
- Deploy Microsoft Sentinel solution for SAP applications
- Prerequisites for deploying Microsoft Sentinel solution for SAP applications
- Configure your SAP system for the Microsoft Sentinel solution
- Deploy the solution content from the content hub
- Connect your SAP system by deploying your data connector agent container
- Collect SAP HANA audit logs
Reference files:
- Microsoft Sentinel solution for SAP applications solution data reference
- Microsoft Sentinel solution for SAP applications solution: security content reference
- Kickstart script reference
- Update script reference
- Microsoft Sentinel solution for SAP applications
systemconfig.json
file reference
For more information, see Microsoft Sentinel solutions.