- Accounts
- Deployment and Upgrade
- Find the Version of your Exabeam Cloud Connectors Platform
- Increase Memory for the Exabeam Cloud Connectors Platform
- Enable HTTP Strict-Transport-Security Response Headers
- Verify Connectivity from the Exabeam Cloud Connectors App to an Integrated SIEM
- Revert Exabeam Cloud Connectors to an Earlier Version
- Logs and Reports
- Send Exabeam Cloud Connectors Logs to Exabeam Support
- Enable Remote Monitoring for on-Premise Deployments
- Opt Out of Health Reporting
- Audit Logging for Exabeam Cloud Connectors
- Set Up a Syslog Receiver that Logs Locally and Forwards to a Remote Destination
- Reduce the Size of Events Sent to Exabeam Data Lake or Exabeam Advanced Analytics
- Decrease Kafka's Data Retention Period
- Increase the Maximum Number of Open Files
- Enrichment
Deployment and Upgrade
Find the Version of your Exabeam Cloud Connectors Platform
Log in to your Exabeam Cloud Connectors platform.
Select Settings > General > License.
Identify the version in the Version field.
Increase Memory for the Exabeam Cloud Connectors Platform
If during the initial sizing of your deployment, you need to allocate additional memory for the Exabeam Cloud Connectors platform, you can do so using the following workflow. Increasing memory can also alleviate memory errors that prevent the Exabeam Cloud Connectors platform from pulling events from Cloud Services.
Note
Before you attempt to change the memory allocation, please contact Exabeam Support to ensure the instance has enough memory and confirm that you are okay to allocate more memory for the container.
To increase memory, you must have an account with root-level permissions.
Run the sudo systemctl cat sk4compose command to verify the working directory for the docker file. You can skip this and the following verification steps if you already know the memory requirements.
$ sudo systemctl cat sk4compose # /etc/systemd/system/sk4compose.service [Unit]After=docker.service Requires=docker.service Description=SkyFormation Compose [Service] WorkingDirectory=/opt/exabeam/data/sk4
In this example, the working directory is
/opt/exabeam/data/sk4
which is common for cloud-delivered deployments. For on-premises deployments, the working directory is either/opt/sk4/
or/var/lib/docker/volume/
. Swap any instances of
for your path in the remaining steps.<workingdir>
To verify sk4appconnect ran out of memory, run the following command on the server that hosts the Exabeam Cloud Connectors platform.
$ sudo grep "OutOfMemoryError"
<workingdir>
/logs/appconnect*This will display any out-of-memory errors in the sk4 logs. When sk4appconnect runs out of memory you may see a log similar to the following:
/opt/exabeam/data/sk4/logs/appconnect-appdatasync.log:java.lang.OutOfMemoryError: GC overhead limit exceeded /opt/exabeam/data/sk4/logs/appconnect-appdatasync.log:INFO [2021-03-27 23:36:01,180] [syncpersona-Sales Cloud-Salesforce Production-sync-persona-3696335] com.skyformation.appdatasync.dataretrieval.AccountTaskWorker:call:366 - Task complete [TaskToExecute{id=3696335, executor=007f084d-2905-4bf5-8016-41e681fde1ff, definitionName=sync-persona, params=GeneralParams{com.skyformation.task.domainobjects.v1.GeneralParams@7fd959b4, data=null}, timeout=PT1H, signalStopPagingAfter=PT45M}]; artifact [GeneralArtifact{taskId=3696335, definitionName='sync-persona', msg='OutOfMemoryError: GC overhead limit exceeded', status=500, createdAt=2021-03-27T23:35:55.799Z, runningTime=PT11M38.316S, count=0, earliestRetrieved=null, latestRetrieved=null}] ; working thread [syncpersona-Sales Cloud-Salesforce Production-sync-persona-3696335] /opt/exabeam/data/sk4/logs/appconnect-etcd.log:java.lang.OutOfMemoryError: Java heap space /opt/exabeam/data/sk4/logs/appconnect-etcd.log:Caused by: java.lang.OutOfMemoryError: GC overhead limit exceeded /opt/exabeam/data/sk4/logs/appconnect-etcd.log:Caused by: java.lang.OutOfMemoryError: GC overhead limit exceeded /opt/exabeam/data/sk4/logs/appconnect-service.log:Caused by: java.lang.OutOfMemoryError: GC overhead limit exceeded
Run the sudo docker stats --no-stream command to verify how much memory that the sk4appconnect container is taking.
$ sudo docker stats --no-stream CONTAINER ID NAME CPU % MEM USAGE / LIMIT MEM % NET I/O BLOCK I/O PIDS f9a731bcd52f sk4appconnect 0.10% 5.046GiB / 14.53GiB 34.73% 18.2GB / 13.6GB 0B / 0B 184 99428f0efc78 sk4siemconsumer 0.26% 1.604GiB / 14.53GiB 11.04% 2.82GB / 5.23GB 0B / 0B 86 [...]
In this example, the above output shows sk4appconnect currently takes 5Gib of memory.
Run the free -h command to verify the available memory.
$ free -h total used free shared buff/cache available Mem: 29G 8.3G 8.5G 1.5G 12G 19G Swap: 0B 0B 0B
Make a copy of docker-compose.
$ sudo cp
<workingdir>
/docker-compose.yml<workingdir>
/docker-compose.yml.backupTo add more memory for sk4appconnect, edit the
Djdk.http.auth.tunneling.disabledSchemes
definition in thedocker-compose.yml
file.For example to add 1 GB of memory, the value would change from
-Xmx3G -Xms3G
to-Xmx4G -Xms4G
.# SK4_VERSION=2.5.160 by default SAAS CC sk4appconnect was allocated with 3G memory /opt/exabeam/data/sk4/docker-compose.yml container_name: sk4appconnect depends_on: - kafka - sk4etcd - nats environment: - >- JAVA_OPTS=-Dsk4TestMode=false -Djavax.net.ssl.trustStore=/data/application-connect/conf/sk4cacerts ${PROXY_OPTIONS} -Djava.net.useSystemProxies=true -Djdk.http.auth.tunneling.disabledSchemes= -Xmx4G -Xms4G -Xloggc:/logs/gc-appconnect.log -verbose:gc -XX:+PrintGCDetails -XX:+PrintGCDateStamps -XX:+PrintGCTimeStamps -XX:+UseGCLogFileRotation -XX:NumberOfGCLogFiles=2 -XX:GCLogFileSize=10M -XX:CompressedClassSpaceSize=128M -XX:MaxMetaspaceSize=512M -XX:MetaspaceSize=512M -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/logs/appconnect-mem-dump.hprof - SKYFORMATION_ENC_KEY=KtseFMbelGQInT63g1FVqIOeYD6IGaj4 - SK4_VERSION=2.5.160
Save your changes when finished.
Run the sudo systemctl restart sk4compose command to restart sk4compose and load the new
docker-compose.yml
file.$ sudo systemctl restart sk4compose
Enable HTTP Strict-Transport-Security Response Headers
For increased security, the Exabeam Cloud Connectors platform with a base version of 2.5.192 or later automatically enables HTTP Strict-Transport-Security (HTHS) response headers. If you upgrade the Exabeam Cloud Connectors from an earlier version, you must manually enable the HTHS response headers.
To perform this configuration, you must have an account with root-level permissions that can act as sudo.
SSH into the machine which hosts the Exabeam Cloud Connectors platform.
Run the
sudo -i
command to run the shell with root-level credentials.Run the
cd /opt/exabeam/data/sk4/conf/shiro
command to change to the shiro directory.Run the
cp client-shiro.ini client-shiro.ini.bak.beforehsts
command to make a backup of the client-shiro.ini file.Use you preferred text editor to make the following edits to the client-shiro.ini file:
Below the [main] section, add a new section:
# configure Shiro's default 'ssl' filter to enabled HSTS: ssl.enabled = true ssl.port = 8443 ssl.hsts.enabled = true ssl.hsts.includeSubDomains = true
Below the [urls] section, replace the existing configuration and
set /login.html = ssl, sk4Authc
./index.html = ssl, sk4Authc, roles[sk4-admin] /onboard.html = ssl, sk4Authc, roles[sk4-admin] /logout = ssl, logout / = ssl, sk4Authc, roles[sk4-admin] /** = ssl, anon
Save and exit the file.
Run the
sudo systemctl restart sk4compose
command to restart sk4compose.
Verify Connectivity from the Exabeam Cloud Connectors App to an Integrated SIEM
Each cloud connector that you add in Exabeam Cloud Connectors is attached to a specific tenant.
To allow Exabeam Cloud Connectors to send events to a SIEM, the cloud connector tenant also be attached to a valid SIEM. After you connect the cloud connector to the SIEM through your tenant, you can verify that the Exabeam Cloud Connectors app sends audit events the SIEM.
Log in to your Exabeam Cloud Connectors app.
Go to Settings > SIEM Integration.
Identify the SIEM for which you want to verify connectivity.
Focus on the SIEM raw and click EDIT.
Verify the SIEM settings, such as syslog port and SIEM DNS address, are aligned with the settings your SIEM expects.
Click TEST CONNECTION to verify connectivity to the SIEM.
A green
OK
response indicates the Exabeam Cloud Connectors app can successfully send audit events to the SIEM.A red
Failed to send
response indicates the Exabeam Cloud Connectors app could not send audit events to the SIEM. Refer to the following list of common issues and possible solutions and then test your connection again:If the firewall between the Exabeam Cloud Connectors app and the SIEM blocks the syslog events, work with your network administrator to see if drop events from the Exabeam Cloud Connectors app are present in firewall audit logs. If so, ask the firewall administrator to allow such communication traffic.
If the SIEM settings configured in the Exabeam Cloud Connectors app are not aligned with the SIEM collectors/listeners settings expected, ask the SIEM administrator to verify the SIEM settings used in the Exabeam Cloud Connectors app match the expected SIEM settings. For example, the SIEM settings on the Exabeam Cloud Connectors app specify syslog with TCP but the SIEM specifies syslog with UDP.
Revert Exabeam Cloud Connectors to an Earlier Version
When you revert to an earlier version, this process will delete the current volumes (and data) and will use the data saved prior to the upgrade (old Cloud Connectors version, volumes, configurations). This means that if you performed changes in the configurations after you upgraded, they will be lost.
The revert process is not supported from the same version as the old one, but it may be forced by using the --revert_same_version flag. Although this is not recommended, you can use the flag for use cases such as when an upgrade failed to download some of the images.
Make sure that you back up the directory. This directory is created prior to the upgrade process. The script will use this directory to roll back your system to its previous state.
Use the -b or --backup_dir flag to back up the directory for the configurations before the upgrade, for example:
curl -L https://download.skyformation.net/v2/download/installer/edge/revert.sh > revert.sh chmod +x revert.sh sudo ./revert.sh --backup_dir=/opt/exabeam/backup
If you do not use the flag, the script will prompt you to enter the backup directory.
If you see the message
Backup directory is not valid. Exiting
, it means that you didn't supply a valid backup directory.Run the
revert.sh
script using the relevant command for your deployment:Without a proxy
sudo bash -c "$(curl -L https://download.skyformation.net/v2/download/installer/edge/revert.sh)" $@ 2>&1 | tee "revert-at-`date --iso-8601=ns`.log"
With a proxy
sudo bash -c "$(curl -x https://<proxyserver>:8080 -L https://download.skyformation.net/v2/download/installer/edge/revert.sh)" $@ 2>&1 | tee "revert-at-`date --iso-8601=ns`.log"
Confirm that you see the message
The system has been reverted to its original state
when the process completed.