Document toolboxDocument toolbox

Forcepoint SWG collector

Overview

Forcepoint secure web gateway services are part of Forcepoint ONE, an all-in-one, cloud-native security platform. Forcepoint ONE SWG enables users to securely access any website or download any document while still enjoying the speed and performance required to stay competitive.

Devo collector features

Feature

Details

Feature

Details

Allow parallel downloading (multipod)

not allowed

Running environments

  • collector server

  • on-premise

Populated Devo events

table

Flattening preprocessing

no

Data sources

Data source

Description

API endpoint

Collector service name

Devo table

Available from release

swgweb logs

Logs generated from general web traffic from users using the SmartEdge agent, pulls logs from the Analyze > Logs > Web dashboard page.

/api/bitglassapi/logs/v1/

swgweb

sse.forcepoint.swgweb.event

v1.0.0

access logs

Logs generated by application activity as seen on the Analyze > Logs > Proxy dashboard page.

/api/bitglassapi/logs/v1/

access

sse.forcepoint.access.event

v1.0.0

admin logs

All admin events within the admin portal as seen on the Analyze > Logs > Admin dashboard page.

/api/bitglassapi/logs/v1/

admin

sse.forcepoint.admin.event

v1.0.0

healthproxy logs

The Health dashboard allows admins to identify if issues that users encounter are brought on by Forcepoint ONE SSE or the backend server

/api/bitglassapi/logs/v1/

swgweb

sse.forcepoint.swgweb.event

v1.0.0

Learn more about these parsers in this article.

Flattening preprocessing

Data source

Collector service

Optional

Flattening details

swgweb logs

swgweb

yes

not required

access logs

access

yes

not required

admin logs

admin

yes

not required

healthproxy logs

healthproxy

yes

not required

Minimum configuration required for basic pulling

Although this collector supports advanced configuration, the fields required to retrieve data with basic configuration are defined below.

This minimum configuration refers exclusively to those specific parameters of this integration. There are more required parameters related to the generic behavior of the collector. Check setting sections for details.

Setting

Details

Setting

Details

username

The username for authentication.

password

The password for authentication.

See the Accepted authentication methods section to verify what settings are required based on the desired authentication method.

Accepted authentication methods

Authentication method

username

password

Authentication method

username

password

Basic auth

REQUIRED

REQUIRED

API limits, delays, & known Issues

The API has a limit of 300 requests per day per endpoint.

Run the collector

Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).

Collector services detail

This section is intended to explain how to proceed with specific actions for services.

dpim incident

Once the collector has been launched, it is important to check if the ingestion is performed in a proper way. To do so, go to the collector’s logs console.

This service has the following components:

Component

Description

Component

Description

Setup

The setup module is in charge of authenticating the service and managing the token expiration when needed.

Puller

The setup module is in charge of pulling the data in a organized way and delivering the events via SDK.

Setup output

A successful run has the following output messages for the setup module:

2024-07-31T08:18:46.267 INFO InputProcess::MainThread -> ForcepointSWGPuller(forcepoint_swg,775754,healthproxy,predefined) Starting the execution of init_variables() 2024-07-31T08:18:46.268 INFO InputProcess::MainThread -> Validating service metadata 2024-07-31T08:18:46.271 INFO InputProcess::MainThread -> Validating defined module definition 2024-07-31T08:18:46.281 INFO InputProcess::MainThread -> Validating common input config 2024-07-31T08:18:46.285 INFO InputProcess::MainThread -> Validating service input config 2024-07-31T08:18:46.287 INFO InputProcess::MainThread -> Running overriding rules 2024-07-31T08:18:46.287 INFO InputProcess::MainThread -> Validating the rate limiter config given by the user 2024-07-31T08:18:46.288 INFO InputProcess::MainThread -> <requests_limits> setting has not been defined. The generic settings will be used instead. 2024-07-31T08:18:46.288 INFO InputProcess::MainThread -> Adding raw config to the collector store 2024-07-31T08:18:46.288 INFO InputProcess::MainThread -> Running custom validation rules 2024-07-31T08:18:46.289 INFO InputProcess::MainThread -> ForcepointSWGPuller(forcepoint_swg,775754,healthproxy,predefined) Finalizing the execution of init_variables() 2024-07-31T08:18:46.291 INFO InputProcess::MainThread -> InputThread(forcepoint_swg,775754) - Starting thread (execution_period=60s) 2024-07-31T08:18:46.292 INFO InputProcess::MainThread -> ServiceThread(forcepoint_swg,775754,swgweb,predefined) - Starting thread (execution_period=60s) 2024-07-31T08:18:46.292 INFO InputProcess::MainThread -> ForcepointSWGPullerSetup(unknown,forcepoint_swg#775754,swgweb#predefined) -> Starting thread 2024-07-31T08:18:46.292 INFO InputProcess::MainThread -> ForcepointSWGPuller(forcepoint_swg,775754,swgweb,predefined) - Starting thread 2024-07-31T08:18:46.303 WARNING InputProcess::ForcepointSWGPuller(forcepoint_swg,775754,swgweb,predefined) -> Waiting until setup will be executed 2024-07-31T08:18:46.525 INFO OutputProcess::DevoSender(internal_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system 2024-07-31T08:18:47.005 INFO InputProcess::ForcepointSWGPullerSetup(unknown,forcepoint_swg#775754,healthproxy#predefined) -> Setup for module <ForcepointSWGPuller> has been successfully executed

Puller output

A successful initial run has the following output messages for the puller module:

024-07-31T08:18:49.341 INFO InputProcess::ForcepointSWGPuller(forcepoint_swg,775754,admin,predefined) -> Pull Started 2024-07-31T08:18:49.343 INFO InputProcess::ForcepointSWGPuller(forcepoint_swg,775754,admin,predefined) -> Fetching data From : 2024-07-31T08:18:06Z 2024-07-31T08:18:49.607 INFO InputProcess::ForcepointSWGPuller(forcepoint_swg,775754,access,predefined) -> Updating the persistence 2024-07-31T08:18:49.615 INFO InputProcess::ForcepointSWGPuller(forcepoint_swg,775754,access,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1722413928334):Number of requests made: 1; Number of events received: 1; Number of duplicated events filtered out: 0; Number of events generated and sent: 1; Average of events per second: 0.785. 2024-07-31T08:18:49.616 INFO InputProcess::ForcepointSWGPuller(forcepoint_swg,775754,access,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1722413928334):Number of requests made: 1; Number of events received: 1; Number of duplicated events filtered out: 0; Number of events generated and sent: 1; Average of events per second: 0.784. 2024-07-31T08:18:49.616 INFO InputProcess::ForcepointSWGPuller(forcepoint_swg,775754,access,predefined) -> The data is up to date! 2024-07-31T08:18:49.617 INFO InputProcess::ForcepointSWGPuller(forcepoint_swg,775754,access,predefined) -> Data collection completed. Elapsed time: 1.283 seconds. Waiting for 58.717 second(s) until the next one 2024-07-31T08:18:50.776 INFO InputProcess::ForcepointSWGPuller(forcepoint_swg,775754,swgweb,predefined) -> Sent 150 swgweb events to Devo.

After a successful collector’s execution (that is, no error logs found), you will see the following log message:

2024-07-31T08:19:04.395 INFO InputProcess::ForcepointSWGPuller(forcepoint_swg,775754,swgweb,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1722413929311):Number of requests made: 6; Number of events received: 1475; Number of duplicated events filtered out: 0; Number of events generated and sent: 1475; Average of events per second: 97.856.

This collector uses persistent storage to download events in an orderly fashion and avoid duplicates. In case you want to re-ingest historical data or recreate the persistence, you can restart the persistence of this collector by following these steps:

  1. Edit the configuration file.

  2. Change the value of the initial_start_time_in_utc_value parameter to a different one.

  3. Save the changes.

  4. Restart the collector.

The collector will detect this change and will restart the persistence using the parameters of the configuration file or the default configuration in case it has not been provided.

Note that this action clears the persistence and cannot be recovered in any way. Resetting persistence could result in duplicate or lost events.

This collector has different security layers that detect both an invalid configuration and abnormal operation. This table will help you detect and resolve the most common errors.

Error type

Error ID

Error message

Cause

Solution

InitVariablesError

1

initial_start_time_in_utc is not set as per the datetime_format : {datetime_format}

The date in config is not as per required format

Ensure the date format is correct.

InitVariablesError

2

Date {initial_start_time_str} is in the future

The date in config is greater than current time

Ensure the datetime is less than current time

SetupError

100

HTTP Error occurred while retrieving events from Forcepoint server

Wrong credentials or rate limit reached. Check details in the message

Check the credentials and ensure that the collector has the necessary permissions to access the Forcepoint API

SetupError

101

Some error occurred while retrieving events from Forcepoint server. Error details: {e}

Check the error message details for the cause.

Contact the developer with exact error message.

PullError

300

HTTP Error occurred while retrieving events from Forcepoint server

Forcepoint API call is failing

Contact the developer with exact error message.

PullError

301

Some error occurred while retrieving events from Forcepoint server. Error details: {e}

Forcepoint API call is failing

Contact the developer with exact error message.

Collector operations

To check the memory usage of this collector, look for the following log records in the collector which are displayed every 5 minutes by default, always after running the memory-free process.

  • The used memory is displayed by running processes and the sum of both values will give the total used memory for the collector.

  • The global pressure of the available memory is displayed in the global value.

  • All metrics (Global, RSS, VMS) include the value before freeing and after previous -> after freeing memory

Change log

Release

Released on

Release type

Details

Recommendations

Release

Released on

Release type

Details

Recommendations

v1.0.0

Aug 12, 2024

NEW FEATURE



-

-