Skip to content

Latest commit

 

History

History
186 lines (103 loc) · 7.08 KB

faqs_troubleshooting_gi.md

File metadata and controls

186 lines (103 loc) · 7.08 KB

FAQs and Troubleshooting for Guardium Insights

  1. How many universal connections can be configured at once?

It depends on the Open Shift cluster resources. No limit is defined.

  1. The connection is taking more than 15 minutes to start up.

It may take time, up to 15 minutes. Wait and refresh the connection status.

  1. Upload plug-in failed.

Copy the plug-in package from the official location and retry. Link to official location: https://github.com/IBM/universal-connectors/blob/main/docs/available_plugins.md

  1. Connection creation fails.

• Connect via CLI to your OpenShift cluster.

Example:

cloudctl login -a https://cp-console.apps.lions-king.cp.fyre.ibm.com --skip-ssl-validation -u
admin -p
AHippopotamusPlaysHopscotchWithAnElephant -n
staging

• Find the universal connector manager pod and check the pod's status. The status should be 1/1 running, as in the following example.

Example:

oc get pods | grep universal

staging-universal-connector-manager-794c5bb44c-

cdp9g              1/1     Running     

0               2d15h

• Check the UC-manager logs for errors.

Example:

oc logs staging-universal-connector-manager-

794c5bb44c-cdp9g
  1. The connection is in red or yellow and has an unhealthy Connectivity status on the Connections page.

• Connect via CLI to your OpenShift cluster.

Example:

 cloudctl login -a https://cp-console.apps.lions-refaelnew.cp.fyre.ibm.com --skip-ssl-validation -
 u admin -p

 AHippopotamusPlaysHopscotchWithAnElephant -n
 staging

• Find universal connector pods and check that the pods' statuses are running 1/1, as in the following example. If the status of the universal connector pods is not running or not 1/1, perform the steps from question 4: check uc-manager logs.

Example:

  oc get pods | grep universal
  staging-universal-connector-manager-7cc4c6849b-
  s72tc              1/1     Running     0             15d

 stagingksultnyrrzbspmyqfppnd61-universal-
 connector-0              1/1     Running     0             15d

stagingksultnyrrzbspmyqfppnd63-universal-
connector-0              1/1     Running     
0             13d

• Enter the universal connector container pod and check UC logstash_stdout_stderr.log for errors and exceptions:

Example:

oc exec -it stagingksultnyrrzbspmyqfppnd61-universal-connector-0 bash
cd /var/log/uc
ls  -ltr
cat logstash_stdout_stderr.log

• Enable the Guardium Insights operator, delete the old connection, and create a new connection. To enable the Guardium Insights operator: connect via CLI to your cluster and run what appears in the following example.

Example:

oc scale $( oc get deploy -oname | grep
  guardiuminsights-controller-manager | awk

  '{print $1}') --replicas=1
  1. Does MustGather support the Guardium universal connector?

Yes, every MustGather option includes logs for the Guardium universal connector.

  1. Data is missing from reports.

Check the following steps:

a. Go to the Guardium Insights Connections page and see whether the connection is in green and healthy connectivity status.

  • If the status is red, perform the item from question #3 above (Copy the plug-in package from the official location and retry. )

  • If the status turns to green, continue trying the points below. If it remains red, continue trying to get a green, healthy connectivity status.

b. Check if traffic is running on the data source.

c. Check if auditing is set correctly on the data source.

d. Check that the auditing logs are created in the expected location on the data source

e. Check that the connection settings are set correctly on the data source side.

Example:

For a Mongo over Filebeat configuration, check on the data source that:

• The Mongo database auditing is configured in a mongod.conf file, Mongo service is running , and that a Mongo audit log file is created.

• In the filebeat.yml file , in Filebeat.inputs: check the path to the audit logs. It should be same path as the one configured in the MongoDB configuration file in the auditing section.

• In the filebeat.yml file, check that the tags are identical to the ones in the connection configuration details in on the Guardium Insights connection page.

To check the data source tag on Guardium Insights :Go to the connection page, select your connection, click on connection name, check the data source tag in Universal Connector Configuration

• Check that the server certificate is downloaded from the connection page and uploaded to the data source. Check that the path to the certificate is set in the filebeat.yml and uncommented.

Example: (fragment from filebeat.yml) ssl.certificate_authorities: ["/etc/pki/client/lions-dev7/GuardiumInsightsCA.pem"]

• In the filebeat.yml, check that the output.logstash section is uncommented and that the output.elasticsearch is commented

• In the filebeat.yml , in the output.logstash section, check the connection hosts and port. They should be identical to the ones in the connection details on the Guardium Insights Connections page. (Port is 443 by default).

Example:

hosts: ["usuj7iib4hsg2yutp9i3ca3-universal-
connector.perf-ded-wdc06-
0a94651246c65639d6ebe7da606c2479-0000.us-
east.containers.appdomain.cloud:443"]

• Restart Filebeat service after editing the filebeat.yml file and checking status after restart

Example:

service filebeat restart
service filebeat status

• Check the Filebeat log files. Enable the logging section in the filebeat.yml, restart Filebeat , go to filebeat logs located by path , configured in filebeat.yml logging section, and check the Filebeat logs for errors and exceptions.

f. Check that communication between the database server and the managed unit is not blocked (Guardium Insights is accessible from the database server).

  1. The universal connector started but Guardium is not showing any events.

• Verify that a policy with a log full details rule is created and installed, and that no other policy blocks it.

• Check the steps from question 6 above.

• Set the debug level in the uc_logstahs log and check “Guardium Events” in the log. If you found events in uc_logstahs.log, the problem may be in the minisnif.

To setup UC debug logs level:

a) connect with CLI to your cluster

b) enter the universal connector pod

c) run the command: ${UC_SCRIPTS}/set_uc_log_level.sh "debug"

d) Create a MustGather and look for the universal connector log

Plug-in questions

  1. The universal connector does not start with your plug-in or configuration

See Installing and testing the filter or input plug-in on a staging Guardium system for details on how to collect diagnostic data by running a must gather command.

  1. Is Java required to create a plug-in?

No, you can develop by using Ruby, especially when Guardium knows how to parse your data source commands. However, if you need to parse the commands for a new data source type, Java is the best choice.

  1. How much time does it take to develop a plug-in? Give yourself 4 - 5 weeks, maybe a bit more to perfect it.