Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 14 Next »

Contents

Document Details

Prepared By

Reviewed By

Date

Document Version

Ashima Agarwal

Artem Kalaitan

5-July-2022

V1

Introduction

This document contains multiple knowledge articles related to Synergy.

Articles

GV Icon is greyed out

Refer the attached document for the detailed information about the process

 GV Icon is greyed out

Scenario GV Icon is greyed out

Problem Description

The GV agent ribbon shows grayed out on opening any MS office application for example MS Word.




The issue can occur because any of the following reasons:

Potential Cause 1

Agent cannot connect to the Getvisibility Management Server because of network restrictions

Solution

Add a rule on the Network Firewall to allow the agent to communicate with the backend Getvisibility server on port 59093


Potential Cause 2

Agent hasn’t received the configuration to activate itself.

Solution

Push the configuration from the agent configuration wizard of the dashboard


Potential Cause 3

The Kafka service might be down

Solution

Follow the Prerequisites section to check the status of the Kafka Service




Getting suggestions on the limited document

Problem Description

Agent not throwing suggestions on all kinds of documents, this could occur because the file’s content is quite large for the classifier to process.

Potential Cause

The classifier is timing out while processing the document's content.

Solution

Classifier needs to re-configured to consume the files of bigger size and also spend more time on processing the files before timing out

Reach out to the Getvisibility team support@getvisibility.com in case of this issue is encountered

Agent not receiving suggestions on the defined regex pattern

Refer the attached document for the detailed information about the process

 Agent not receiving suggestions

Scenario - Agent not receiving suggestions on the defined regex pattern

Problem Description

Agent is not giving a classification or compliance tag suggestion on the regex pattern found in the document opened by the user.


Potential Cause 1

The classifier service is down. This service is responsible for sending suggestions to the agent.

Solution

Follow the Prerequisites section to know the steps to check the status and logs of the classifier service

The service status will be reviewed from the Rancher Web UI


Potential Cause 2

The classification confidence level defined for the regex is lower than the defined threshold to provide a suggestion.

Solution

The default classification confidence defined in agent is 0.60 (60 %)

Either you have to bring down the threshold or increase the confidence value defined in the Getvisibility Management server.

The threshold can be brought down by login to the Windows machine where the agent is installed and edit the below mentioned file.

C:\Windows\ServiceProfiles\LocalService\AppData\Roaming\GVClient.Service\GVClient_Service_Properties.config.json


Update the value of variable "ConfidenceSuggestionThreshold" to the required value.

The second approach would be to redefine the classification confidence level of the regex in the classifier service in the Getvisibility Management Server.

Reach out to the GV team to make the required changes to the regex pattern


Potential Cause 3

The regex is mis-configured in the background

Solution

The regex pattern is mis-configured and won’t trigger on the expected pattern.

Reach out to the GV team to make the required changes to the regex pattern

Agent not receiving ML based suggestions

Refer the attached document for the detailed information about the process

 Agent not receiving ML based suggestions

Scenario - Agent not receiving ML based suggestions


Problem Description

Agent is not giving a classification or compliance tag ML suggestion on the document opened by the user.

Potential Cause 1

The classifier service is down. This service is responsible for sending suggestions to the agent.

Solution

Follow the Prerequisites section to know the steps to check the status and logs of the classifier service

The service status will be reviewed from the Rancher Web UI


Potential Cause 2

The classification confidence level not reaching the threshold defined in the agent.

Solution

The default classification confidence defined in agent is 0.60 (60 %)

Either you have to bring down the threshold or increase the confidence value defined in the Getvisibility Management server.

The threshold can be brought down by login to the Windows machine where the agent is installed and edit the below mentioned file.

C:\Windows\ServiceProfiles\LocalService\AppData\Roaming\GVClient.Service\GVClient_Service_Properties.config.json


Update the value of variable "ConfidenceSuggestionThreshold" to the required value.

Restart the “Getvisibility” service.


Potential Cause 3

Agent configuration’s suggestion section is misconfigured

Solution

Agent configuration contains the following section.
The “key” value should be pointing to the right ID.

Each set of tags should have a specific ID defined to that. For Example, Getvisibility default classification tagset is “b4c70d4c-e8af-4331-ba0c-733721d06495” and for Compliance is “00000000-0000-0000-0000-000000002001”

So the custom tag set have a different value, reach out to getvisibility team to know about it.

"suggestionOptions" : [ {

"key" : "b4c70d4c-e8af-4331-ba0c-733721d06495",

"tagset" : "e16409a7-1700-4153-9090-3955bc2f0ae8",

"tag" : "Classification"

}, {

"key" : "00000000-0000-0000-0000-000000002001",

"tagset" : "f14fc1f1-8950-40d5-8a29-45909da947d6",

"tag" : "GDPR/PII"

} ]

Citrix/vSphere incompatibility

Refer the attached document for the detailed information about the process

 Citrix/vSphere incompatibility

Scenario - Citrix/vSphere incompatibility

Problem Description

The agent first fails to install, and then fails to start the client process when installed via SCCM to the Citrix Workspace One

Solution

The issue is that the agent is not starting right away after installation meaning the PC must be restarted.

When the Workspace One agent installs the package in the background no window is shown to the user.

The issue was resolved by:

 

  • Adjusting the installer to start the agent right after installation is done (not after window is closed)

  • The Install Context in Workspace One must be set as ‘User’ as seen below

UIWPF Loader Crashed

Refer the attached document for the detailed information about the process

 UIWPF Loader Crashed

Scenario - UIWPF Loader Crashed

Problem Description

The agent ribbon bar button is not responding on clicking it

Potential Cause

So the scenario should like this:

  1. Start Agent and service

  2. Classify a document (eg. set compliance)

  3. Change configuration → add new tag for compliance

  4. Try to classify the document from point 2 again via explorer

  5. The Agent will crash because it still has the old ClassificationEvent with less tags than the current configuration, making necessary the changes.

Solution

Manually rerun the “gvclient.uiwpf.loader” process if it has crashed.

This is the path of the file:

C:\Program Files (x86)\GVClient\GVClient.UIWPF.Loader.exe



Also, restart the Getvisibility service to make sure the agent has stabilized now

Slowness in receiving AI/ML Suggestion

Refer the attached document for the detailed information about the process

 Slowness in receiving AI/ML Suggestion

Scenario - Slowness in receiving AI/ML Suggestion

Problem Description

Agent is taking more than 5 minutes to produce the classification suggestion.

Solution

The suggestion prompt timestamp is defined in the below file which is present on the machine where the agent is installed

C:\Windows\ServiceProfiles\LocalService\AppData\Roaming\GVClient.Service\GVClient_Service_Properties.config.json


The suggestions prompt can be made faster by updating the below variable with a smaller value like 3000 i.e., 3 secs

"FileTextEventDebounceMilis": 3000


Restart the Getvisibility service.


The slowness can also occur when GVClient Service has lost connectivity to the Kafka bus. Verify the status of Kafka bus before reporting the issue.

Agent does not receive newest configuration

Refer the attached document for the detailed information about the process

 Agent does not receive newest configuration

Scenario - Agent does not receive newest configuration

Problem Description

The agent dialog box doesn’t show the updated classification tagset or is not working on the latest defined rules in the configuration.

Potential Cause 1

Agent is not connected to the the Getvisibility Management server

Solution

Follow the Prerequisites section to check the status of the Kafka Service

Check if the port “443” and “80” is open on the network firewall for the agent to communicate to the Getvisibility Management Server

Potential Cause 2

The configuration pushed is not compatible with the Agent

Solution

Check the version defined in the agent configuration, it should be the same as the version of the agent installed but only till the first decimal value.

For Example, for the agent with version 2.9.0 will be compatible with the configuration with the version defined as “2.9”

The snippet of the agent configuration:

{

"id": "8e808d12-fdc4-4fc9-8938-853b0a4a5d3d",

"timeStamp": "2021-12-15T10:45:07.523+01:00[Europe/London]",

"version": "2.9",

"notes": "Sample configuration": {

"id": "e16409a7-1700-4153-9090-3955bc2f0ae8",

"tags": [

"Public",

"General Business Use",

"Confidential",

"Highly-Confidential"

]

},
...

Configuration Wizard unable to push the json on the Dashboard

Refer the attached document for the detailed information about the process

 Configuration Wizard unable to push the json on the Dashboard

Scenario - Configuration Wizard unable to push the json on the Dashboard


Problem Description

Unable to push the agent configuration from the agent wizard of the Getvisibility Dashboard.

Potential Cause 1

The configuration service might not be running

Solution

The service status and logs canl be reviewed from the Rancher Web UI

Follow the Prerequisites section to know the steps to check the status and review the logs of the classifier service

Potential Cause 2

Follow the Prerequisites section to check the status of the Kafka Service

Check if the port “443” and “80” is open on the network firewall for the agent to communicate to the Getvisibility Management Server

Potential Cause 3

The configuration json pushed via “Expert Mode” is shown as not valid.

Solution

Use a json validator to review the configuration and make the correction and re-push it.

One of the good online json validator would be https://jsonlint.com/

Agent not listed on the Agent management console

Refer the attached document for the detailed information about the process

 Agent not listed on the Agent management console

Scenario - Agent not listed on the Agent management console

Problem Description

The GV agent that is installed and communicating with the Getvisibilty Management server is not present in the list of connected agents.

And also the status of the used plugins is not getting updated.

Potential Cause 1

The agent and the audit service are not running.

Solution

Follow the Prerequisites section to know the steps to check the status and logs of the agent and the audit service

The service status will be reviewed from the Rancher Web UI

Potential Cause 2

Follow the Prerequisites section to check the status of the Kafka Service

Check if the port “443” and “80” is open on the network firewall for the agent to communicate to the Getvisibility Management Server

Firewall Whitelisting – Synergy

Refer the attached document for the detailed information about the process

 Firewall Whitelisting – Synergy

Firewall Whitelisting - Synergy

The list of the endpoints need to be accessible from GV Management Server to keep the system updated.

*.k3s.getvisibility.com

git.rancher.io

docker.io

quay.io

gcr.io

registry.opensource.zalan.do

github.co

storage.googleapis.com

*.k3s.io

github.com

*.amazonaws.com

Following firewall rules should be set. Firewall Port Opening Matrix:

Sn

Source

Destination

Port

Protocol

Direction

Comments

1

User’s Windows Machine

Getvisibility Management Server

443,80

TCP

Bi-direction

Source machine will have Synergy Agent installed on it and will communicate with the Focus Server

2

Windows machine with Browser,ssh,scp enabled

Getvisibility Management Server

443,80,22

TCP

Single direction from source to destination

To access the Focus machine via ssh and its services via browser.

3

Getvisibility Management Server

File Server

137,139,445

TCP/UDP

Single direction from source to destination

To access the file server from the GV server during the File/AD scan

Supporting Services – Synergy

Refer the attached document for the detailed information about the process

 Supporting Services – Synergy

Supporting Services- Synergy

Below services are involved in supporting the Getvisibility Platform. They need to be up and running

Kafka

Postgresql

Consul

K3s


K3 service is running as systemd service and its status can be known by running “systemctl status k3s” on the CLI of the Getvisibility Management Server.

If the service is not running then execute “sudo systemctl start k3s.service”

The basic level of health checkup of the remaining services can be performed by using the Rancher Web UI.

Status of individual services by following the steps mentioned below

Login to Rancher UI dashboard > Select Cluster Node > Workload > Search for the service in the “Filter” search box

The keyword “Active” is the current status of the service, which means the service is up.


Note: The rancher Web UI link will be shared by the Getvisibility team

Collecting Logs – Synergy

Refer the attached document for the detailed information about the process

 Collecting Logs – Synergy

Collecting Logs - Synergy

The logs of the service can be accessed by selecting the service and clicking on it

Click on the triple dot sign present on the right most end of the service and click on the “view logs”



Note: The rancher Web UI link will be shared by the Getvisibility team

Agent’s Service Logs

C:\Windows\ServiceProfiles\LocalService\AppData\Roaming\GVClient.Service\Logs

Agent Service logs

%appdata%\GVClient.Service

%appdata%\GVClient.Plugins

%appdata%\GVClient.UIWPF

Kafka service Down

Refer the attached document for the detailed information about the process

 Kafka service Down

The Kafka service might be down

Follow the Prerequisites section to check the status of the Kafka Service


Prerequisites

List of prerequisites that need to be fulfilled to ensure the working of all the features of the synergy product.

Firewall Whitelisting

The list of the endpoints need to be accessible from GV Management Server to keep the system updated.

*.k3s.getvisibility.com

git.rancher.io

docker.io

quay.io

gcr.io

registry.opensource.zalan.do

github.co

storage.googleapis.com

*.k3s.io

github.com

*.amazonaws.com

Following firewall rules should be set. Firewall Port Opening Matrix:

Sn

Source

Destination

Port

Protocol

Direction

Comments

1

User’s Windows Machine

Getvisibility Management Server

443,80

TCP

Bi-direction

Source machine will have Synergy Agent installed on it and will communicate with the Focus Server

2

Windows machine with Browser,ssh,scp enabled

Getvisibility Management Server

443,80,22

TCP

Single direction from source to destination

To access the Focus machine via ssh and its services via browser.

3

Getvisibility Management Server

File Server

137,139,445

TCP/UDP

Single direction from source to destination

To access the file server from the GV server during the File/AD scan

Supporting Services

Below services are involved in supporting the Getvisibility Platform. They need to be up and running

Kafka

Postgresql

Consul

K3s


K3 service is running as systemd service and its status can be known by running “systemctl status k3s” on the CLI of the Getvisibility Management Server.

If the service is not running then execute “sudo systemctl start k3s.service”

The basic level of health checkup of the remaining services can be performed by using the Rancher Web UI.

Status of individual services by following the steps mentioned below

Login to Rancher UI dashboard > Select Cluster Node > Workload > Search for the service in the “Filter” search box

The keyword “Active” is the current status of the service, which means the service is up.


Note: The rancher Web UI link will be shared by the Getvisibility team

Collecting Logs

The logs of the service can be accessed by selecting the service and clicking on it

Click on the triple dot sign present on the right most end of the service and click on the “view logs”



Note: The rancher Web UI link will be shared by the Getvisibility team

Agent’s Service Logs

C:\Windows\ServiceProfiles\LocalService\AppData\Roaming\GVClient.Service\Logs

Agent Service logs

%appdata%\GVClient.Service

%appdata%\GVClient.Plugins

%appdata%\GVClient.UIWPF

Agent cannot connect to the GV Management Server

Agent cannot connect to the GV Management Server because of network restrictions

Solution

Add a rule on the Network Firewall to allow the agent to communicate with the backend Getvisibility server on port 59093

The classifier is timing out while processing the document's content

Solution

Classifier needs to re-configured to consume the files of bigger size and also spend more time on processing the files before timing out

Reach out to the Getvisibility team support@getvisibility.com in case of this issue is encountered

The classifier service is down

Refer the attached document for the detailed information about the process

 The classifier service is down

The classifier service is down

The classifier service is down. This service is responsible for sending suggestions to the agent.

Solution

Follow the Prerequisites section to know the steps to check the status and logs of the classifier service

The service status will be reviewed from the Rancher Web UI

Prerequisites

List of prerequisites that need to be fulfilled to ensure the working of all the features of the synergy product.

Firewall Whitelisting

The list of the endpoints need to be accessible from GV Management Server to keep the system updated.

*.k3s.getvisibility.com

git.rancher.io

docker.io

quay.io

gcr.io

registry.opensource.zalan.do

github.co

storage.googleapis.com

*.k3s.io

github.com

*.amazonaws.com

Following firewall rules should be set. Firewall Port Opening Matrix:

Sn

Source

Destination

Port

Protocol

Direction

Comments

1

User’s Windows Machine

Getvisibility Management Server

443,80

TCP

Bi-direction

Source machine will have Synergy Agent installed on it and will communicate with the Focus Server

2

Windows machine with Browser,ssh,scp enabled

Getvisibility Management Server

443,80,22

TCP

Single direction from source to destination

To access the Focus machine via ssh and its services via browser.

3

Getvisibility Management Server

File Server

137,139,445

TCP/UDP

Single direction from source to destination

To access the file server from the GV server during the File/AD scan

Supporting Services

Below services are involved in supporting the Getvisibility Platform. They need to be up and running

Kafka

Postgresql

Consul

K3s


K3 service is running as systemd service and its status can be known by running “systemctl status k3s” on the CLI of the Getvisibility Management Server.

If the service is not running then execute “sudo systemctl start k3s.service”

The basic level of health checkup of the remaining services can be performed by using the Rancher Web UI.

Status of individual services by following the steps mentioned below

Login to Rancher UI dashboard > Select Cluster Node > Workload > Search for the service in the “Filter” search box

The keyword “Active” is the current status of the service, which means the service is up.


Note: The rancher Web UI link will be shared by the Getvisibility team

Collecting Logs

The logs of the service can be accessed by selecting the service and clicking on it

Click on the triple dot sign present on the right most end of the service and click on the “view logs”



Note: The rancher Web UI link will be shared by the Getvisibility team

Agent’s Service Logs

C:\Windows\ServiceProfiles\LocalService\AppData\Roaming\GVClient.Service\Logs

Agent Service logs

%appdata%\GVClient.Service

%appdata%\GVClient.Plugins

%appdata%\GVClient.UIWPF

The classification confidence level defined for the regex is lower than the defined threshold to provide a suggestion.

Solution

The default classification confidence defined in agent is 0.60 (60 %)

Either you have to bring down the threshold or increase the confidence value defined in the Getvisibility Management server.

The threshold can be brought down by login to the Windows machine where the agent is installed and edit the below mentioned file.

C:\Windows\ServiceProfiles\LocalService\AppData\Roaming\GVClient.Service\GVClient_Service_Properties.config.json


Update the value of variable "ConfidenceSuggestionThreshold" to the required value.

The second approach would be to redefine the classification confidence level of the regex in the classifier service in the Getvisibility Management Server.

Reach out to the GV team support@getvisibility.com to make the required changes to the regex pattern

The regex is mis-configured in the background

Solution

The regex pattern is mis-configured and won’t trigger on the expected pattern.

Reach out to the GV team to make the required changes to the regex pattern

The configuration pushed is not compatible with the Agent

Check the version defined in the agent configuration, it should be the same as the version of the agent installed but only till the first decimal value.

For Example, for the agent with version 2.9.0 will be compatible with the configuration with the version defined as “2.9”

The snippet of the agent configuration:

{

"id": "8e808d12-fdc4-4fc9-8938-853b0a4a5d3d",

"timeStamp": "2021-12-15T10:45:07.523+01:00[Europe/London]",

"version": "2.9",

"notes": "Sample configuration": {

"id": "e16409a7-1700-4153-9090-3955bc2f0ae8",

"tags": [

"Public",

"General Business Use",

"Confidential",

"Highly-Confidential"

]

},
...

The agent and the audit service are not running.

Refer the attached document for the detailed information about the process

 The agent and the audit service are not running

Agent and the audit service are not running.

Solution

Follow the Prerequisites section to know the steps to check the status and logs of the agent and the audit service

The service status will be reviewed from the Rancher Web UI

Prerequisites

List of prerequisites that need to be fulfilled to ensure the working of all the features of the synergy product.

Firewall Whitelisting

The list of the endpoints need to be accessible from GV Management Server to keep the system updated.

*.k3s.getvisibility.com

git.rancher.io

docker.io

quay.io

gcr.io

registry.opensource.zalan.do

github.co

storage.googleapis.com

*.k3s.io

github.com

*.amazonaws.com

Following firewall rules should be set. Firewall Port Opening Matrix:

Sn

Source

Destination

Port

Protocol

Direction

Comments

1

User’s Windows Machine

Getvisibility Management Server

443,80

TCP

Bi-direction

Source machine will have Synergy Agent installed on it and will communicate with the Focus Server

2

Windows machine with Browser,ssh,scp enabled

Getvisibility Management Server

443,80,22

TCP

Single direction from source to destination

To access the Focus machine via ssh and its services via browser.

3

Getvisibility Management Server

File Server

137,139,445

TCP/UDP

Single direction from source to destination

To access the file server from the GV server during the File/AD scan

Supporting Services

Below services are involved in supporting the Getvisibility Platform. They need to be up and running

Kafka

Postgresql

Consul

K3s


K3 service is running as systemd service and its status can be known by running “systemctl status k3s” on the CLI of the Getvisibility Management Server.

If the service is not running then execute “sudo systemctl start k3s.service”

The basic level of health checkup of the remaining services can be performed by using the Rancher Web UI.

Status of individual services by following the steps mentioned below

Login to Rancher UI dashboard > Select Cluster Node > Workload > Search for the service in the “Filter” search box

The keyword “Active” is the current status of the service, which means the service is up.


Note: The rancher Web UI link will be shared by the Getvisibility team

Collecting Logs

The logs of the service can be accessed by selecting the service and clicking on it

Click on the triple dot sign present on the right most end of the service and click on the “view logs”



Note: The rancher Web UI link will be shared by the Getvisibility team

Agent’s Service Logs

C:\Windows\ServiceProfiles\LocalService\AppData\Roaming\GVClient.Service\Logs

Agent Service logs

%appdata%\GVClient.Service

%appdata%\GVClient.Plugins

%appdata%\GVClient.UIWPF

Excel is working slowly

If the user is facing the issue that excel is working slow then in the config of the agent change the excelTextForwardingActive = False, this will help resolve the issue.

Excel App crashing

A generic solution is to capture the logs as per the document attached.

 Excel App crashing

Excel App crashing

Collect the logs from the application

The logs of the service can be accessed by selecting the service and clicking on it

Click on the triple dot sign present on the right most end of the service and click on the “view logs”



Note: The rancher Web UI link will be shared by the Getvisibility team

Agent’s Service Logs

C:\Windows\ServiceProfiles\LocalService\AppData\Roaming\GVClient.Service\Logs

Agent Service logs

%appdata%\GVClient.Service

%appdata%\GVClient.Plugins

%appdata%\GVClient.UIWPF

Agent is writing incorrect column order in the dialog configuration block

This is a known issue and will be resolved in future releases.

Compatibility with MDM devices

We need to provide a list what MDM we support - i.e. SCCM, workspace1, mac mdm solutions - Jamf

We do not support mobile solutions but sometimes clients will install software using the install packages on the MDM devices like Microsoft System Center Configuration Manage (SCCM),Google - Workspace1 and Apple - Jamf.

Excel "Save as - Browse" functionality not working. User can’t save a file to chosen directory

This is a known issue and will be resolved in future releases.

Powerpoint unable to enforce ForceTaggingDirtyBuffers setting

This is a known issue and will be resolved in future releases.

Unable to install agent because of limited access level

Refer the attached document for the detailed information about the process

 Unable to install agent because of limited access level
Unable to render {include} The included page could not be found.

Unable to Install agent in the offline environment (that has no outbound access to internet)

Refer the attached document for the detailed information about the process

 Unable to Install agent in the offline environment
Unable to render {include} The included page could not be found.

Unable to open Synergy dashboard

Refer the attached document for the detailed information about the process

 Unable to open Synergy dashboard

Unable to open the Synergy dashboard

If certain services like Dashboard, Fabio are not working then it might cause issue with opening of Synergy dashboard.

Supporting Services

Below services are involved in supporting the Getvisibility Platform. They need to be up and running

  • Kafka

  • Postgresql

  • Consul

  • K3s


K3 service is running as systemd service and its status can be known by running “systemctl status k3s” on the CLI of the Getvisibility Management Server.

If the service is not running then execute “sudo systemctl start k3s.service”

The basic level of health checkup of the remaining services can be performed by using the Rancher Web UI.

Status of individual services by following the steps mentioned below

Login to Rancher UI dashboard > Select Cluster Node > Workload > Search for the service in the “Filter” search box

The keyword “Active” is the current status of the service, which means the service is up.


Note: The rancher Web UI link will be shared by the Getvisibility team

Collecting Logs

The logs of the service can be accessed by selecting the service and clicking on it

Click on the triple dot sign present on the right most end of the service and click on the “view logs”



Note: The rancher Web UI link will be shared by the Getvisibility team

Agent’s Service Logs

C:\Windows\ServiceProfiles\LocalService\AppData\Roaming\GVClient.Service\Logs

Agent Service logs

%appdata%\GVClient.Service

%appdata%\GVClient.Plugins

%appdata%\GVClient.UIWPF

License Management Process

Refer the attached document for the detailed information about the process

 License Management Process

Contents

This license management page is accessible only by Forcepoint/Getvisibility backend team. Partners/Distributors/Customers needs to request license from Forcepoint/Getvisibility sales team.

Introduction

This document gives a high-level overview of how the license management process works.

License Management Process

The steps involved in the License management Process is as follows:

  • Getvisibility(GV) will register its resellers in the customer management system.

  • The success code of registration and URL will be sent to ForcePoint (FP)

  • FP will use GV customer management API to register a new customer (Check the open API specification for more details)

    • New Customer Name

    • License Type

    • Region

    • Number of Users

    • Expiration Time

  • Based on the information received GV will return via API response the registration command for the customer in the specific region like:

    • EMEA

    • US

    • India

  • On the clusters GV will perform:

    • Deploy Essential Services

    • Deploy Monitoring Tools

    • Deploy GV Services

  • After the basic deployment, GV tools are ready for use.

Hold/Revoke License

The steps involved in revoking the license are as follows:

  • Using the Monitoring tools enabled, GV will receive various statistics related to user usage.

  • The statistics are stored in the GV databases.

  • As soon as the number of users exceeds the specified customer limit as per the license, a trigger is generated in GV.

  • The FP sales engineer can make a decision to disable the UI and plugins.

Hold-Revoke License

Refer the attached document for the detailed information about the process

 License Management Process

Contents

This license management page is accessible only by Forcepoint/Getvisibility backend team. Partners/Distributors/Customers needs to request license from Forcepoint/Getvisibility sales team.

Introduction

This document gives a high-level overview of how the license management process works.

License Management Process

The steps involved in the License management Process is as follows:

  • Getvisibility(GV) will register its resellers in the customer management system.

  • The success code of registration and URL will be sent to ForcePoint (FP)

  • FP will use GV customer management API to register a new customer (Check the open API specification for more details)

    • New Customer Name

    • License Type

    • Region

    • Number of Users

    • Expiration Time

  • Based on the information received GV will return via API response the registration command for the customer in the specific region like:

    • EMEA

    • US

    • India

  • On the clusters GV will perform:

    • Deploy Essential Services

    • Deploy Monitoring Tools

    • Deploy GV Services

  • After the basic deployment, GV tools are ready for use.

Hold/Revoke License

The steps involved in revoking the license are as follows:

  • Using the Monitoring tools enabled, GV will receive various statistics related to user usage.

  • The statistics are stored in the GV databases.

  • As soon as the number of users exceeds the specified customer limit as per the license, a trigger is generated in GV.

  • The FP sales engineer can make a decision to disable the UI and plugins.

Installation -Upgrade K3s: - Register Server – Reseller

Refer the attached document for the detailed information about the process

 Installation -Upgrade K3s
Unable to render {include} The included page could not be found.

Installation -Upgrade K3s: - Deploy Synergy – Reseller

Refer the attached document for the detailed information about the process

 Installation -Upgrade K3s: - Deploy Synergy – Reseller
Unable to render {include} The included page could not be found.

Installation -Upgrade K3s: - Install Server – Client

Refer the attached document for the detailed information about the process

 Installation -Upgrade K3s: - Install Server – Client
Unable to render {include} The included page could not be found.

Installation -Upgrade K3s:- Update – Client

Refer the attached document for the detailed information about the process

 Installation -Upgrade K3s:- Update – Client
Unable to render {include} The included page could not be found.

Installation -Upgrade K3s:- Backup – Client

Refer the attached document for the detailed information about the process

 Installation -Upgrade K3s:- Backup – Client
Unable to render {include} The included page could not be found.

Troubleshooting Synergy with Sentry

Refer the attached document for the detailed information about the process

 Troubleshooting Synergy with Sentry

Sentry is accessible only by authorized by people at Getvisibility and Forcepoint.

Contents

Sentry Overview

Sentry is an application that is used for real time error tracking in production which would happen due to security bug, invalid data etc. and understand the end customer experiences. It also helps in boosting efficiency and improving the end-user experience. In the below sections we will navigate into Sentry and explore various options.

Sign In

Sentry provides multiple options to Sign into the system, chose the option relevant to your organizations. In the e.g., below we use the Sign in with Google option.

Link: https://sentry.io/auth/login/

A confirmation link will be sent to the email address and once the email validation is completed user will be able to login into the application.

The landing page after the login is displayed as below:

On the left side of the application there are options to perform various activities. In the sections below we will go through each of the option one by one.

Projects

On the Projects sections, user will be able to see the different projects he is has access to. This page is like an overview of all the projects using Sentry. Right now, we can see Synergy and Scan Manager. The user can also create a new project but only with the right access

The Join Team gives the option to join another team in the organisation. Clicking on the Join team button will navigate the user to Teams page where we only have one team as seen below.

Clicking on the Project name, user will navigate to the Project Details page which provides an overview over errors, performance, and the health of your releases.

Project Details

This page gives the options to filter the details of the project based on Environment or the number of days (defaulted to 14 Days).

The four cards displayed on the project details page is as below:

  • Crash free sessions - The percentage of sessions in the provided time range that did not terminate in a crash of the application is the crash-free sessions number.

  • Crash free users - The percentage of distinct users that did not suffer a crash during the specified time period is the crash-free user’s number.

  • Number of releases - This shows the number of releases for this particular project.

  • Apdex - This is a statistic for tracking and measuring user satisfaction based on the reaction times of your application.

There are two graphs displayed on the screen which can be toggled using the display option. The total 8 graphs that can be viewed are:

On the very bottom of the Project Detail page the consolidated view of the issues is displayed, with a clickable link that will navigate to the details of the issue.

Issues

This page displays information about errors in your application. This page is like an overview of all the issues in the project. The user can view the issue by filtering based on Project, Environment and Time.

The page is organized into tabs, each corresponding to a list of issues.

  • All Unresolved: All unresolved issues, including issues that need review.

  • For Review: Issues that need to be reviewed; for-review issues are a sub-set of all unresolved issues.

    • Ignored: All ignored issues.

    • Saved Searches: Select from a set of recommended and custom saved searches. The name of the tab changes based on your selection. The different options here are:

      • Assigned to Me

      • Errors Only

      • My Issues

      • Needs Triage

      • New Today

      • Unhandled Errors

For each issue, the page displays:

  • Error type and message: Like in the example below it says Consumer Error

  • Brief description of the issue: “ssl://Focus-server.forcepoint…

    • Associated project: Synergy-1H

    • Issue timing: 11 min ago-2mo Old

    • Graph: Shows a 24-hr timeline of the issue.

    • Events: This is the number of similar events in the last 14 Days i.e. 1.6k

    • Users: Number of users facing the same issue. E.g., 1

    • Assignee: To whom is the issue assigned from the team to work on.

Issue Details

This page helps you to gain further insight into the source of the issue and the impact it has on your application's users. The color on the issue name describes types of issue as below:

  • Error - orange

  • Info - blue

  • Warning - yellow

  • Fatal - red

  • Debug - gray

  • Sample – purple

The multiple tabs that can been seen on this page are:

  • Details: This is the default tab when user opens the Issues and it has all the details about the issue like IP address, Server Name, OS, Environment etc.

  • Activity: This tab logs all the activity related to the issue like if there are any status change or if any user has posted comment on the issue.

  • User Feedback: If user has provided any information, it will be displayed here.

  • Attachments: The attachments related to the issue can be found on this tab

  • Tags: Tags help in indexing and searching the issue on various categories.

  • Events: This tab will categories the issues based on the events occurred on that day.

  • Merged Issues: If there are issues merged it will be displayed here.

  • Similar Issues: Similar kinds of issues are displayed on this tab.

If the user scrolls below on the Detail tab, he will be able to see the breadcrumbs. Sentry creates a trail of activities that occurred prior to an issue by using breadcrumbs. These events are comparable to standard logs, but they have the ability to record more structured data.

Link Jira Issue: User can link the issue to Jira using the link present on the right side of the Issue Detail page. All the Details are pre-populated while creating the issue.

Performance

Sentry watches application performance, measures parameters like throughput and latency, and illustrates the effect of mistakes across various services via performance monitoring. The page includes graphs that depict transactions or trends, as well as a table that allows you to view important transactions and drill down for more information. The 4 tabs on this page is:

  • All Transactions

  • Web Vitals

  • Front End

  • Back End

  • Mobile

The graphs can be toggled, and other important metrics can be shown as below:

If the user scrolls further down the individual transaction with a clickable link is displayed, which will give further details about the performance of the application.

After clicking on the Transaction link, the details are displayed as below:

Releases

A release is a version of your code that has been delivered to a system. When you tell Sentry about a release, you may quickly detect new issues and regressions, as well as determine whether an issue will be resolved in the following release.

The Release page has the option to filer using the environment and the number of days. The page gives an overview of the releases done like

  • Project Name

  • Adoption: This shows how many numbers of users have started using the new release.

  • Time

  • Crash Free Rate

  • Crashes

  • New Issues

If the user clicks on any of the releases it will be navigated to the Release detail page where one can find additional information about the release.

  • Crash Free Session Rate

  • Crash Free Session Rate

  • Failure Rate

  • Session Duration p50

  • Session Count

  • User Count

  • Error Count

  • Transaction Count

The release detail page will also show the list of issues associated with the release.

User Feedback

Users that encountered an error while using your application can leave comments on the User Feedback page. Each submission includes the user's name and email address, as well as a description of what went wrong to cause the issue. When the user clicks on the link, the page will be redirected to the Issues page for further investigation.

Alerts

Alerts give you real-time visibility into code issues and their consequences for your users. There are a variety of notifications to choose from to make the alerts highly informative. Clicking on the alert will display the details related to the alert and the issue related to it.

User can also create new alerts as per the events he wants to get notified immediately. List of conditions can be selected from the below displayed options.

Discover

By building on and improving existing error data, Discover delivers visibility into your data across environments. You can run queries to learn more about the health of your entire system and receive answers to important questions. There are some predefined queries that the user can use or can also create his own quires.

Dashboard

This page allows you to traverse through error and performance data across various projects to get a broad picture of your application's health. Dashboard comprises of multiple widgets to display the information and widgets utilize the discover query to get the required data. Multiple templates are provided to get user started. User can also create its custom dashboard.

Clicking on one of the dashboards gives us the below details.

Activity

This page logs all the activity related to the application that has taken place like if there are any new user, or new project.

Stats

This page gives information about Usage, Issues and Health of the various projects using Sentry in the organisation.

Usage: The details on the page show high-level event usage statistics, such as the total number of events for the time and which were accepted, filtered, or rejected.

Issues: This page indicates how many new issues were discovered, how many resolved issues regressed, and how they were triaged for issues assigned to your team.

Health: This page how’s information on your projects' overall health; the crash-free sessions, alerts etc.

Settings

This page gives the ability to manage settings at the organizational level, only members with access can edit the settings

In settings under the integrations page the user will find multiple options to integrate Sentry with other tools. These settings can only be accessible to the user with manager/owner role.

Synergy Agent – Auto Update Feature

Refer the attached document for the detailed information about the process

 Synergy Agent – Auto Update Feature

Contents

Introduction

This document gives a high-level understanding of how auto update feature will work in Synergy Agent. The end user will not have to do anything, and the latest updates related to Synergy will be updated automatically, the document just explains the technical side of how this feature functions.

Basic Information

Configuring Artifacts URI

  • The Artifacts URI is the location from which update artifacts (in form of .zip packages) will be fetched and applied.

  • Now, the default URI for the auto-update feature is the same as the agent edge.

  • Default URI in case of ForcePoint will be FPs GV server.

  • Default config that we will give to FP is that every FP customer will have their own auto-update deployment version.

  • GV will manage the artifacts for FP through normal deployment process.

  • The URI can be specified in the installerConfig.json file of the generic installer:

{

...

"AutoUpdateArtifactsUri": ""

}

The URI can be in one of the following formats:

Local filesystem path

Local Filesystem path -

The path has to point to an existing directory on the clients PC:

e.g. C:\Autoupdate\Artifacts.

AutoUpdate Process

During the installation of GVClient a new Windows Service is installed on the machine which will check for updates during:

  • Startup

  • Periodically, all agents in all the customers would be checking the updates every 5 to 15mins (can be changed in AutoUpdateService config - C:\Windows\SysWOW64\config\systemprofile\AppData\Roaming\GVClient.Windows.AutoUpdateService\GVClient_Windows_AutoUpdateService_Properties.config.json )

During the check for updates routine, the service lists all packages from the provided URI and applies the Upgrade (or Downgrade) in the following scenarios:

  • Upgrade - when the latest available version is higher than the current version

  • Downgrade - when the latest available version is lower than the current version

 By default the application is installed under C:\Program Files (x86)\GVClient\app-x.x.x

The 'x' stands for the current version.

Upgrade Process

When a newer version will be encountered, the AutoUpdateService will execute the following steps:

  • Download the latest package to a temp folder

  • Extract the package to the installation directory but under a new version folder. e.g. when the application was installed under C:\Program Files (x86)\GVClient\, the new package version is 2.9.1, then the package will be extracted to C:\Program Files (x86)\GVClient\app-2.9.1.

  • Start a new AutoUpdateService process (with the argument -execute_version_apply {version}).

  • The new process will execute the following steps:

    • Update plugin registry keys to point to the new version

    • Update AgentUI autorun registry to point to the new version

    • Kill PlatformHub service

    • Kill any running AutoUpdateService

    • Update PlatformHub service to point to the new version and start it

    • Update AutoUpdateService to point to the new version and start it

    • Update installed version registry keys

    • Exit

Downgrade Process

All the steps are similar to upgrade process, but all configs will be adjusted to point to the lower version.

Basic Installation Method – Synergy

Refer the attached document for the detailed information about the process

 Basic Installation Method – Synergy
Unable to render {include} The included page could not be found.

Installation through CLI - Synergy

Refer the attached document for the detailed information about the process

 Installation through CLI - Synergy
Unable to render {include} The included page could not be found.

Installation through group policy (GPO) – Synergy

Refer the attached document for the detailed information about the process

 Installation through group policy (GPO) – Synergy
Unable to render {include} The included page could not be found.

Installation through SCCM – Synergy

Refer the attached document for the detailed information about the process

 Installation through SCCM – Synergy
Unable to render {include} The included page could not be found.

Installation of the Generic Agent-Synergy

Refer the attached document for the detailed information about the process

 Installation of the Generic Agent-Synergy
Unable to render {include} The included page could not be found.

Deployment of Forcepoint Classification Using Rancher

Refer the attached document for the detailed information about the process

 Deployment of Forcepoint Classification Using Rancher
Unable to render {include} The included page could not be found.

End Of Document

  • No labels