Depending on how did you obtain your credentials, you will have to either fill or delete the following properties on the JSON credentials configuration block.
Authentication Method
Filename
Base64 credentials
Delegated email
Service Account with Base64
Status
colour
Green
title
REQUIRED
Status
colour
Green
title
REQUIRED
Status
colour
Green
title
REQUIRED
...
Download the
...
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).
...
Rw tab
title
Cloud collector
We use a piece of software called Collector Server to host and manage all our available collectors.
To enable the collector for a customer:
In the Collector ServerGUI, access the domain in which you want this instance to be created
Click Add Collector and find the one you wish to add.
In the Version field, select the latest value.
In the Collector Name field, set the value you prefer (this name must be unique inside the same Collector Server domain).
In the sending method select Direct Send. Direct Send configuration is optional for collectors that create Table events, but mandatory for those that create Lookups.
In the Parameters section, establish the Collector Parameters as follows below:
All defined service entities will be executed by the collector. If you do not want to run any of them, just remove the entity from the services object.
Please replace the placeholders with real world values following the description table below:
...
Parameter
...
Data type
...
Type
...
Value range / Format
...
Details
...
debug_status
...
bool
...
Mandatory
...
false / true
...
If the value is true, the debug logging traces will be enabled when running the collector. If the value is false, only the info, warning and error logging levels will be printed.
...
short_unique_id
...
int
...
Mandatory
...
Minimum length: 1 Maximum length: 5
...
Use this param to give an unique id to this input service.
Note
This parameter is used to build the persistence address, do not use the same value for multiple collectors. It could cause a collision.
...
input_status
...
bool
...
Mandatory
...
false / true
...
Use this param to enable or disable the given input logic when running the collector. If the value is true, the input will be run. If the value is false, it will be ignored.
...
requests_per_second_value
...
int
...
Optional
...
Minimum value: 1
...
Customize the maximum number of API requests per second. If not used, the default setting will be used: 100000 requests/sec.
This parameter should be removed if it is not used.
...
environment_value
...
str
...
Optional
...
Minimum length: 1
...
This parameter is used to create the Devo tag. It corresponds to the sixth level of the tag: cloud.gsuite.alerts.<alert_type>.<format_version>.<environment>. If this parameter is removed, the sixth level of the tag will have the value unknown.
This parameter should be removed if it is not used.
...
filename_value
...
str
...
Mandatory
...
Minimum length: 1
...
This parameter is the name that you want to give to the token generated by the Collector. For example: token.pickle
...
content_base64_value
...
str
...
Mandatory
...
Minimum length: 1
...
This parameter is the credentials in base64 format. To know how to obtain this value review the section How to enable the collection in the vendor.
...
delegated_email_value
...
str
...
Mandatory
...
Minimum length: 1
...
This parameter is the email of the user whose domain is delegated to authorize the Service Account to access the alerts. To know how to obtain this value review the section How to enable the collection in the vendor.
Note
Note for later: delegated_email field should contain the email of an real user (you cannot use a Service Account here) with enough access to display the alerts in the Google WorkSpace Admin Console >> Alert Center (https://admin.google.com/ac/ac).
...
source_id
...
str
...
Mandatory
...
Minimum value: 1
...
This parameter will be used when {source_id} placeholder is present when using custom tags. Please use "abc" value when not used.
...
collector_service_name
...
str
...
Mandatory
...
Any collector service names described in the Data sources section.
...
This parameter can be set to any collector service name described in the Data sources section. It is also important to note that there may be more than one service.
The collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table:
Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace <image_file> and <version> with a proper value.
The Docker image can be deployed on the following services:
Docker
Execute the following command on the root directory <any_directory>/devo-collectors/<product_name>/
Replace <product_name>, <image_name> and <version> with the proper values.
Docker Compose
The following Docker Compose file can be used to execute the Docker container. It must be created in the <any_directory>/devo-collectors/<product_name>/ directory.
To run the container using docker-compose, execute the following command from the <any_directory>/devo-collectors/<product_name>/ directory:
Code Block
IMAGE_VERSION=<version> docker-compose up -d
Replace <product_name>, <image_name> and <version> with the proper values.
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).
Rw ui tabs macro
Rw tab
title
Cloud collector
We use a piece of software called Collector Server to host and manage all our available collectors.
To enable the collector for a customer:
In the Collector ServerGUI, access the domain in which you want this instance to be created
Click Add Collector and find the one you wish to add.
In the Version field, select the latest value.
In the Collector Name field, set the value you prefer (this name must be unique inside the same Collector Server domain).
In the sending method select Direct Send. Direct Send configuration is optional for collectors that create Table events, but mandatory for those that create Lookups.
In the Parameters section, establish the Collector Parameters as follows below:
All defined service entities will be executed by the collector. If you do not want to run any of them, just remove the entity from the services object.
Please replace the placeholders with real world values following the description table below:
Expand
title
Restart the persistence
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:
Edit the configuration file.
Change the value of the start_time parameter to a different one.
Save the changes.
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
Note that this action clears the persistence and cannot be recovered in any way. Resetting persistence could result in duplicate or lost events.
Expand
title
Troubleshooting
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.
This error is raised when unknown error occurs while loading token.pickle
Check that the token.pickle is in the correct format and if not, regenerate it again.
GSuiteAlertsPullerCredentialsException
0
HTTP error: <error_message>
This error is raised when an HTTP error appears during setup.
The solution depends on the type of error.. Contact with Devo Support team.
2
File <filename> does not exist. Please, learn how to generate a token pickle on: https://docs.devo.com/confluence/ndt/latest/sending-data-to-devo/collectors/g-suite-collectors/g-suite-alerts-collector
This error is raised when token.pickle does not exist.
Regenerate the token.json and save it in the file devo-collector-gsuite-google-workspace-alerts/credentials/.
To know how the token is regenerated, consult the section Vendor setup.
1
Unable to refresh token or client Auth was deleted. Detail: <error_message>
This error is raised when the token cannot be refreshed. The reason may be that it has been deleted.
Regenerate the token.json and save it in the file devo-collector-gsuite-google-workspace-alerts/credentials/.
To know how the token is regenerated, consult the section Vendor setup.
InputConfigurationError
70
<input_config_environment_key_path> property must be a string
This error is raised when optional value environment is not in the str format.
Edit the value of environment in the configuration file so it is of valid str format.
71
<input_config_environment_key_path> property must fulfil the regex pattern r'^[A-Za-z0-9_-]{1,32}$'
This error is raised when optional value environment does not match the required regex.
Make the value of environment in the configuration file match the indicated format.
GSuiteAlertsPullerConnectionLostException
0
Operation timed out: <error_message>
This error is raised when the maximum time to wait for the connection has been exceeded.
Check that the connection is working properly.
1
HTTP/1.1 503 Service Unavailable at moment - Retrying reconnection: <error_message>
This error is raised when the service is not available.
This is an internal issue. Contact the support team.
2
DefaultCredentials: <error_message>
This error is raised when credentials cannot be automatically determined.
This is an internal issue. Contact the support team.
0
Operation timed out
This error is raised when the maximum time to wait for the connection has been exceeded.
Check that the connection is working properly.
1
HTTP/1.1 503 Service Unavailable at moment - Retrying reconnection.
This error is raised when the service is not available.
This is an internal issue. Contact the support team.
3
<error_message>
This error is raised when credentials cannot be automatically determined.
This is an internal issue. Contact the support team.
GSuiteAlertsPullerCreationException
1
<module_properties_key_path> mandatory property is missing or empty'
This error is raised when module_properties property is not found in collector_definitions.yaml
This is an internal issue. Contact the support team.
2
<module_properties_key_path> property must be a dictionary
This error is raised when module_properties is defined in the collector_definitions.yaml file but the format is not dict.
This is an internal issue. Contact the support team.
3
<module_properties_key_path>.alert_type mandatory property is missing or empty
This error is raised when alert_type property is not found in collector_definitions.yaml
This is an internal issue. Contact the support team.
4
<module_properties_key_path>.alert_type property must be a string
This error is raised when alert_type is defined in the collector_definitions.yaml file but the format is not str.
This is an internal issue. Contact the support team.
5
<module_properties_key_path>.tag_base mandatory property is missing or empty
This error is raised when tag_base property is not found in collector_definitions.yaml
This is an internal issue. Contact the support team.
6
<module_properties_key_path>.tag_base property must be a string
This error is raised when tag_base is defined in the collector_definitions.yaml file but the format is not str.
This is an internal issue. Contact the support team.
7
<module_properties_key_path>.credentials_scopes" mandatory property is missing or empty
This error is raised when credentials_scopes property is not found in collector_definitions.yaml
This is an internal issue. Contact the support team.
8
<module_properties_key_path>.credentials_scopes" property must be a string
This error is raised when credentials_scopes is defined in the collector_definitions.yaml file but the format is not str.
This is an internal issue. Contact the support team.
9
<input_config_key_path> property must be a dictionary
This error is raised when the required property input_config_key_path is not found in the config file.
Add input_config_key_path to config file, for example: gsuit_alerts:
10
<input_config_credentials_key_path> mandatory property is missing or empty
This error is raised when the required property credentials is not found in the config file.
Add credentials dictionary in config.
11
<input_config_credentials_key_path> property must be a dictionary
This error is raised when credentials is defined in the configfile but the format is not dict.
Edit the value of credentials in config file, so it is of valid dict format.
12
<input_config_credentials_key_path>.filename mandatory property is missing or empty
This error is raised when the required property filename is not found in the config file, into credentials dictionary.
Add filename property in config file, into credentials dictionary.
13
<input_config_credentials_key_path>.filename property must be a string
This error is raised when filename is defined in the configfile but the format is not str.
Edit the value of filename in config file, so it is of valid str format.
14
<input_config_credentials_key_path>.content_base64" property must be a string
This error is raised when content_base64 is defined in the configfile but the format is not str.
Edit the value of content_base64 in config file, so it is of valid str format.
15
<input_config_credentials_key_path>.content_base64" must be in a valid base64 format
This error is raised when content_base64 is defined in the configfile but the format is not base64 string.
Edit the value of content_base64 in config file, so it is of valid base64 string format.
16
<input_config_credentials_key_path>.delegated_email mandatory property is missing or empty
This error is raised when the required property delegated_email is not found in the config file, into credentials dictionary.
Add delegated_email property in config file, into credentials dictionary.
17
<input_config_credentials_key_path>.delegated_email property must be a string
This error is raised when delegated_email is defined in the configfile but the format is not str.
Edit the value of delegated_email in config file, so it is of valid str format.
18
<input_config_credentials_key_path>.source_id mandatory property is missing or empty
This error is raised when the required property source_id is not found in the config file, into credentials dictionary.
Add source_id property in config file, into credentials dictionary.
19
<input_config_credentials_key_path}.source_id> property must be a string'
This error is raised when source_id is defined in the configfile but the format is not str.
Edit the value of source_id in config file, so it is of valid str format.
20
\"start_time\" property from configuration file format is invalid
This error is raised when start_time is defined in the configfile but the format is not "%Y-%m-%dT%H:%M:%S.%fZ" or "%Y-%m-%dT%H:%M:%SZ".
Edit the value of start_time in config file, so it is of valid "%Y-%m-%dT%H:%M:%S.%fZ" or "%Y-%m-%dT%H:%M:%SZ" format.
PrePullError
200
The <state> does not meet the structure requirements of this collector version. ' f'The keys <last_alert_timestamp> and <last_alerts_id> are mandatory. State = <state>
This error is raised when the collector is upgraded or downgraded to an incompatible version.
Go back to a compatible version.
Remove persistence by modifying the start_time property.
PullError
300
Puller action cannot be executed when PrePull step failed
This error is raised when the prepull fails for whatever reason.
Check the logs to find the PrePull error.
301
Could not automatically determine credentials. Cause:<exception_message>. Aborting...
This error is raised when credentials cannot be automatically determined.
This is an internal issue. Contact the support team.
302
The <next_timestamp> value cannot be calculated, please check the related error logs.
This error is raised when next_timestampt cannot be calculated for the next request.
Check the logs to find the related errors
Parameter
Data type
Type
Value range / Format
Details
debug_status
bool
Mandatory
false / true
If the value is true, the debug logging traces will be enabled when running the collector. If the value is false, only the info, warning and error logging levels will be printed.
short_unique_id
int
Mandatory
Minimum length: 1 Maximum length: 5
Use this param to give an unique id to this input service.
Note
This parameter is used to build the persistence address, do not use the same value for multiple collectors. It could cause a collision.
input_status
bool
Mandatory
false / true
Use this param to enable or disable the given input logic when running the collector. If the value is true, the input will be run. If the value is false, it will be ignored.
requests_per_second_value
int
Optional
Minimum value: 1
Customize the maximum number of API requests per second. If not used, the default setting will be used: 100000 requests/sec.
This parameter should be removed if it is not used.
environment_value
str
Optional
Minimum length: 1
This parameter is used to create the Devo tag. It corresponds to the sixth level of the tag: cloud.gsuite.alerts.<alert_type>.<format_version>.<environment>. If this parameter is removed, the sixth level of the tag will have the value unknown.
This parameter should be removed if it is not used.
startfilename_time_override_value
str
Optional
UTC with format: YYYY-mm-ddTHH:MM:SS.sssZ
This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (1 month back for example) before downloading new events.
This parameter should be removed if it is not used.
custom_tag
str
Optional
A Devo tag. See for more information see Devo tags
This parameter is used to override the default tag with a new customer defined tag.
This parameter should be removed if it is not used.
Image Removed
Rw tab
title
On-premise collector
This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running.
Structure
The following directory structure should be created for being used when running the collector:
In Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in <product_name>/certs/. Learn more about security credentials in Devo here.
All defined service entities will be executed by the collector. If you do not want to run any of them, just remove the entity from the services object.
Replace the placeholders with your required values following the description table below:
Parameter
Data Type
Type
Value Range
Details
debug_status
bool
Mandatory
false / true
If the value is true, the debug logging traces will be enabled when running the collector. If the value is false, only the info, warning and error logging levels will be printed.
collector_id
int
Mandatory
Minimum length: 1 Maximum length: 5
Use this param to give an unique id to this collector.
collector_name
str
Mandatory
Minimum length: 1 Maximum length: 10
Use this param to give a valid name to this collector.
devo_address
str
Mandatory
collector-us.devo.io collector-eu.devo.io
Use this param to identify the Devo Cloud where the events will be sent.
chain_filename
str
Mandatory
Minimum length: 4 Maximum length: 20
Use this param to identify the chain.cert file downloaded from your Devo domain. Usually this file's name is: chain.crt
cert_filename
str
Mandatory
Minimum length: 4 Maximum length: 20
Use this param to identify the file.cert downloaded from your Devo domain.
key_filename
str
Mandatory
Minimum length: 4 Maximum length: 20
Use this param to identify the file.key downloaded from your Devo domain.
input_id
int
Mandatory
Minimum length: 1 Maximum length: 5
Use this param to give an unique id to this input service.
Note
This parameter is used to build the persistence address, do not use the same value for multiple collectors. It could cause a collision.
input_status
bool
Mandatory
false / true
Use this param to enable or disable the given input logic when running the collector. If the value is true, the input will be run. If the value is false, it will be ignored.
requests_per_second_value
int
Optional
Minimum value: 1
Customize the maximum number of API requests per second. If not used, the default setting will be used: 100000 requests/sec.
Info
This parameter should be removed if it is not used.
environment_value
str
Optional
Minimum length: 1
This parameter is used to create the Devo tag. It corresponds to the sixth level of the tag: cloud.gsuite.alerts.<alert_type>.<format_version>.<environment>. If this parameter is removed, the sixth level of the tag will have the value unknown.
Info
This parameter should be removed if it is not used.
filename_value
str
Mandatory
Minimum length: 1
This parameter is the name that you want to give to the token generated by the Collector. For example: token.pickle
content_base64_value
str
Mandatory
Minimum length: 1
This parameter is the credentials in base64 format. To know how to obtain this value review the section How to enable the collection in the vendor.
delegated_email_value
str
Mandatory
Minimum length: 1
This parameter is the email of the user whose domain is delegated to authorize the Service Account to access the alerts. To know how to obtain this value review the section How to enable the collection in the vendor.
Note
Use a real email
delegated_email field should contain the email of an real user (you cannot use a service Account here) with enough access to display the alerts in the Google WorkSpace Admin Console → Alert Center (https://admin.google.com/ac/ac).
source_id
str
Mandatory
Minimum value: 1
This parameter will be used when {source_id} placeholder is present when using custom tags. Please use abc value when not used.
collector_service_name
str
Mandatory
Any collector service names described in the Data source section.
This parameter can be set to any collector service name described in the Data sources section. It is also important to note that there may be more than one service.
Period in seconds used between each data pulling, this value will overwrite the default value (60 seconds)
Info
This parameter should be removed if it is not used.
start_time_override_value
str
Optional
UTC with format: YYYY-mm-ddTHH:MM:SS.sssZ
This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (1 month back for example) before downloading new events.
Info
This parameter should be removed if it is not used.
custom_tag
str
Optional
A Devo tag. See for more information see Devo tags.
This parameter is used to override the default tag with a new customer defined tag.
Info
This parameter should be removed if it is not used.
Download the Docker image
The collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table:
Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace <image_file> and <version> with a proper value.
The Docker image can be deployed on the following services:
Docker
Execute the following command on the root directory <any_directory>/devo-collectors/<product_name>/
Replace <product_name>, <image_name> and <version> with the proper values.
Docker Compose
The following Docker Compose file can be used to execute the Docker container. It must be created in the <any_directory>/devo-collectors/<product_name>/ directory.
To run the container using docker-compose, execute the following command from the <any_directory>/devo-collectors/<product_name>/ directory:
Code Block
IMAGE_VERSION=<version> docker-compose up -d
Note
Replace <product_name>, <image_name> and <version> with the proper values.
Collector services detail
This section is intended to explain how to proceed with specific actions for services.
Devo categorization and destination
The alerts are ingested in the Devo tables with the format cloud.gsuite.alerts.<alert_type> when alert_type is the alert type of the Alert Center. The alert types are listed below:
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
...
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:
Code Block
INFO InputProcess::GSuiteAlertsPullerSetup(gsuite_collector,gsuite_alerts#1234,activity_rule#predefined) -> Path for credentials file has been transformed to absolute: "token.pickle" -> "/../devo-collector-gsuite-google-workspace-alerts/credentials/token.pickle"
INFO InputProcess::GSuiteAlertsPullerSetup(gsuite_collector,gsuite_alerts#1234,activity_rule#predefined) -> File "/../devo-collector-gsuite-google-workspace-alerts/credentials/token.pickle" has been created from base64 content
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> PrePull method started
Puller output
A successful initial run has the following output messages for the puller module:
Info
Note that the PrePull action is executed only one time before the first run of the Pull action.
Code Block
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> PrePull method started
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> Retrieving persisted data
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> No persisted data found. The content will be initialized.
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> The <initial_start_time> did not change, so the persistence will not be reset
WARNING InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> The persistence changed and it will be updated. Current -> None | New -> {'initial_start_time': '2022-05-26T00:00:00.000Z', 'last_alert_timestamp': '2022-05-26T00:00:00.000Z', 'last_alert_ids': []}
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> PrePull method completed
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> Starting data collection every 60 seconds
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> Unpacking messages to start the delivery
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> Made 1 request(s), received 24 message(s), filtered 0 message(s), delivered 24 message(s), tag used: "cloud.gsuite.alerts.activity_rule.1.unknown". avg_time_per_source_message: 61.463 ms
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> Data collection completed. Elapsed time: 1.480 seconds. Waiting for 58.520 second(s) until the next one
After a successful collector’s execution (that is, no error logs found), you will see the following log message:
Code Block
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> Made 1 request(s), received 24 message(s), filtered 0 message(s), delivered 24 message(s), tag used: "cloud.gsuite.alerts.activity_rule.1.unknown". avg_time_per_source_message: 61.463 ms
Mandatory
Minimum length: 1
This parameter is the name that you want to give to the token generated by the Collector. For example: token.pickle
content_base64_value
str
Mandatory
Minimum length: 1
This parameter is the credentials in base64 format. To know how to obtain this value review the section How to enable the collection in the vendor.
delegated_email_value
str
Mandatory
Minimum length: 1
This parameter is the email of the user whose domain is delegated to authorize the Service Account to access the alerts. To know how to obtain this value review the section How to enable the collection in the vendor.
Note
Note for later: delegated_email field should contain the email of an real user (you cannot use a Service Account here) with enough access to display the alerts in the Google WorkSpace Admin Console >> Alert Center (https://admin.google.com/ac/ac).
source_id
str
Mandatory
Minimum value: 1
This parameter will be used when {source_id} placeholder is present when using custom tags. Please use "abc" value when not used.
collector_service_name
str
Mandatory
Any collector service names described in the Data sources section.
This parameter can be set to any collector service name described in the Data sources section. It is also important to note that there may be more than one service.
Period in seconds used between each data pulling, this value will overwrite the default value (60 seconds)
This parameter should be removed if it is not used.
start_time_override_value
str
Optional
UTC with format: YYYY-mm-ddTHH:MM:SS.sssZ
This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (1 month back for example) before downloading new events.
This parameter should be removed if it is not used.
custom_tag
str
Optional
A Devo tag. See for more information see Devo tags
This parameter is used to override the default tag with a new customer defined tag.
This parameter should be removed if it is not used.
Image Added
Rw tab
title
On-premise collector
This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running.
Structure
The following directory structure should be created for being used when running the collector:
In Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in <product_name>/certs/. Learn more about security credentials in Devo here.
All defined service entities will be executed by the collector. If you do not want to run any of them, just remove the entity from the services object.
Replace the placeholders with your required values following the description table below:
Parameter
Data Type
Type
Value Range
Details
debug_status
bool
Mandatory
false / true
If the value is true, the debug logging traces will be enabled when running the collector. If the value is false, only the info, warning and error logging levels will be printed.
collector_id
int
Mandatory
Minimum length: 1 Maximum length: 5
Use this param to give an unique id to this collector.
collector_name
str
Mandatory
Minimum length: 1 Maximum length: 10
Use this param to give a valid name to this collector.
devo_address
str
Mandatory
collector-us.devo.io collector-eu.devo.io
Use this param to identify the Devo Cloud where the events will be sent.
chain_filename
str
Mandatory
Minimum length: 4 Maximum length: 20
Use this param to identify the chain.cert file downloaded from your Devo domain. Usually this file's name is: chain.crt
cert_filename
str
Mandatory
Minimum length: 4 Maximum length: 20
Use this param to identify the file.cert downloaded from your Devo domain.
key_filename
str
Mandatory
Minimum length: 4 Maximum length: 20
Use this param to identify the file.key downloaded from your Devo domain.
input_id
int
Mandatory
Minimum length: 1 Maximum length: 5
Use this param to give an unique id to this input service.
Note
This parameter is used to build the persistence address, do not use the same value for multiple collectors. It could cause a collision.
input_status
bool
Mandatory
false / true
Use this param to enable or disable the given input logic when running the collector. If the value is true, the input will be run. If the value is false, it will be ignored.
requests_per_second_value
int
Optional
Minimum value: 1
Customize the maximum number of API requests per second. If not used, the default setting will be used: 100000 requests/sec.
Info
This parameter should be removed if it is not used.
environment_value
str
Optional
Minimum length: 1
This parameter is used to create the Devo tag. It corresponds to the sixth level of the tag: cloud.gsuite.alerts.<alert_type>.<format_version>.<environment>. If this parameter is removed, the sixth level of the tag will have the value unknown.
Info
This parameter should be removed if it is not used.
filename_value
str
Mandatory
Minimum length: 1
This parameter is the name that you want to give to the token generated by the Collector. For example: token.pickle
content_base64_value
str
Mandatory
Minimum length: 1
This parameter is the credentials in base64 format. To know how to obtain this value review the section How to enable the collection in the vendor.
delegated_email_value
str
Mandatory
Minimum length: 1
This parameter is the email of the user whose domain is delegated to authorize the Service Account to access the alerts. To know how to obtain this value review the section How to enable the collection in the vendor.
Note
Use a real email
delegated_email field should contain the email of an real user (you cannot use a service Account here) with enough access to display the alerts in the Google WorkSpace Admin Console → Alert Center (https://admin.google.com/ac/ac).
source_id
str
Mandatory
Minimum value: 1
This parameter will be used when {source_id} placeholder is present when using custom tags. Please use abc value when not used.
collector_service_name
str
Mandatory
Any collector service names described in the Data source section.
This parameter can be set to any collector service name described in the Data sources section. It is also important to note that there may be more than one service.
Period in seconds used between each data pulling, this value will overwrite the default value (60 seconds)
Info
This parameter should be removed if it is not used.
start_time_override_value
str
Optional
UTC with format: YYYY-mm-ddTHH:MM:SS.sssZ
This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (1 month back for example) before downloading new events.
Info
This parameter should be removed if it is not used.
custom_tag
str
Optional
A Devo tag. See for more information see Devo tags.
This parameter is used to override the default tag with a new customer defined tag.
Info
This parameter should be removed if it is not used.
Download the Docker image
The collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table:
Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace <image_file> and <version> with a proper value.
The Docker image can be deployed on the following services:
Docker
Execute the following command on the root directory <any_directory>/devo-collectors/<product_name>/
Replace <product_name>, <image_name> and <version> with the proper values.
Docker Compose
The following Docker Compose file can be used to execute the Docker container. It must be created in the <any_directory>/devo-collectors/<product_name>/ directory.
To run the container using docker-compose, execute the following command from the <any_directory>/devo-collectors/<product_name>/ directory:
Code Block
IMAGE_VERSION=<version> docker-compose up -d
Note
Replace <product_name>, <image_name> and <version> with the proper values.
Collector services detail
This section is intended to explain how to proceed with specific actions for services.
Devo categorization and destination
The alerts are ingested in the Devo tables with the format cloud.gsuite.alerts.<alert_type> when alert_type is the alert type of the Alert Center. The alert types are listed below:
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
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:
Code Block
INFO InputProcess::GSuiteAlertsPullerSetup(gsuite_collector,gsuite_alerts#1234,activity_rule#predefined) -> Path for credentials file has been transformed to absolute: "token.pickle" -> "/../devo-collector-gsuite-google-workspace-alerts/credentials/token.pickle"
INFO InputProcess::GSuiteAlertsPullerSetup(gsuite_collector,gsuite_alerts#1234,activity_rule#predefined) -> File "/../devo-collector-gsuite-google-workspace-alerts/credentials/token.pickle" has been created from base64 content
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> PrePull method started
Puller output
A successful initial run has the following output messages for the puller module:
Info
Note that the PrePull action is executed only one time before the first run of the Pull action.
Code Block
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> PrePull method started
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> Retrieving persisted data
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> No persisted data found. The content will be initialized.
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> The <initial_start_time> did not change, so the persistence will not be reset
WARNING InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> The persistence changed and it will be updated. Current -> None | New -> {'initial_start_time': '2022-05-26T00:00:00.000Z', 'last_alert_timestamp': '2022-05-26T00:00:00.000Z', 'last_alert_ids': []}
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> PrePull method completed
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> Starting data collection every 60 seconds
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> Unpacking messages to start the delivery
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> Made 1 request(s), received 24 message(s), filtered 0 message(s), delivered 24 message(s), tag used: "cloud.gsuite.alerts.activity_rule.1.unknown". avg_time_per_source_message: 61.463 ms
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> Data collection completed. Elapsed time: 1.480 seconds. Waiting for 58.520 second(s) until the next one
After a successful collector’s execution (that is, no error logs found), you will see the following log message:
Code Block
INFO InputProcess::GSuiteAlertsPuller(gsuite_alerts,1234,activity_rule,predefined) -> Made 1 request(s), received 24 message(s), filtered 0 message(s), delivered 24 message(s), tag used: "cloud.gsuite.alerts.activity_rule.1.unknown". avg_time_per_source_message: 61.463 ms
Expand
title
Restart the persistence
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:
Edit the configuration file.
Change the value of the start_time parameter to a different one.
Save the changes.
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
Note that this action clears the persistence and cannot be recovered in any way. Resetting persistence could result in duplicate or lost events.
Expand
title
Troubleshooting
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.
This error is raised when token.pickle does not exist.
Regenerate the token.json and save it in the file devo-collector-gsuite-google-workspace-alerts/credentials/. To know how the token is regenerated, consult the section Vendor setup.
SetupError
101
Error
This error is raised when unknown error occurs while loading token.pickle
Check that the token.pickle is in the correct format and if not, regenerate it again.
SetupError
102
HTTP error: <error_message>
This error is raised when an HTTP error appears during setup.
The solution depends on the type of error. Contact with Devo Support team.
SetupError
103
Unable to refresh token or client Auth was deleted. Detail: <error_message>
This error is raised when the token cannot be refreshed. The reason may be that it has been deleted.
Regenerate the token.json and save it in the file devo-collector-gsuite-google-workspace-alerts/credentials/. To know how the token is regenerated, consult the section Vendor setup.
SetupError
104
Operation timed out: <error_message>
This error is raised when the maximum time to wait for the connection has been exceeded.
Check that the connection is working properly.
SetupError
105
HTTP/1.1 503 Service Unavailable at moment - Retrying reconnection: <error_message>
This error is raised when the service is not available.
This is an internal issue. Contact the support team.
SetupError
106
DefaultCredentials: <error_message>
This error is raised when credentials cannot be automatically determined.
This is an internal issue. Contact the support team.
InitVariablesError
1
start_time is not set as per the datetime_format
Start time in config is not as per right format
Put start time in the correct format.
InitVariablesError
2
Date {initial_start_time_str} is in the future
Start time in config is in future
Put start time less than the current UTC time.
PullError
300
Operation timed out: <error_message>
This error is raised when the maximum time to wait for the connection has been exceeded.
Check that the connection is working properly.
PullError
301
Could not automatically determine credentials.
This error is raised when credentials are not loaded successfully.
This is an internal issue. Contact the support team.
PullError
302
The <next_timestamp> value cannot be calculated, please check the related error logs.
This error is raised when timestamp is invalid.
This is an internal issue. Contact the support team.
PullError
303
HTTP/1.1 503 Service Unavailable at moment - Retrying reconnection: <error_message>
This error is raised when the service is not available.
This is an internal issue. Contact the support team.
PullError
304
DefaultCredentialsError
DefaultCredentialsError
This is an internal issue. Contact the support team.
PullError
305
Error detected -> {e.class}: {e.str()}
Some error occurred during the pull cycle.
This is an internal issue. Contact the support team.
Collector operations
This section is intended to explain how to proceed with specific operations of this collector.
...
Release
Released on
Release type
Details
Recommendations
v1.9.0
Status
colour
Green
title
IMPROVEMENT
Status
colour
Red
title
BUG FIX
Improvements
Updated DCSDK from 1.12.4 to 1.13.1
Upgraded Base Docker Image to 1.3.1
Bug Fix
Fixed ingestion stoppage issue
Recommended version
v1.8.0
Status
colour
Green
title
IMPROVEMENT
Improvements
Updated DCSDK from 1.10.2 to 1.12.4
Upgraded Base Docker Image to 1.3.0
Recommended version
v1.7.0
Status
colour
Green
title
IMPROVEMENT
Status
colour
Purple
title
NEW FEATURE
Improvements
Updated DCSDK from 1.8.0 to 1.10.2
New features:
Added new alert types:
Access Approvals request
APNS certificate is expiring soon
APNS certificate has expired
MSA Billing
MSA Legal
MSA Product
MSA Security
Customer abuse detected
Drive settings changed
Email settings changed
Mobile settings changed
New user Added
Suspended user made active
User deleted
User granted Admin privilege
Users Admin privilege revoked
Users password changed
Reporting Rule
Account suspension warning
Chrome devices auto-update expiration warning
Update
v1.6.0
Status
colour
Green
title
IMPROVEMENT
Improvements:
Updated DCSDK from 1.4.1 to 1.8.0.
Update
v1.5.0
Status
colour
Green
title
IMPROVEMENT
Improvements:
The Google Workspace Collector has been divided into two: Google Workspace Alerts and Google Workspace Reports to improve the user experience.
Added base64 validation: Validates whether the credentials token is in the correct base64 format.
Update
v1.4.2
Status
colour
Red
title
BUG FIX
Bugs fixes:
Fixed a bug that prevented Syslog output from being enabled.
Update
v1.4.1
Status
colour
Green
title
IMPROVEMENT
Improvements:
Upgraded underlay Devo Collector SDK from v1.1.4 to v1.4.1.
The resilience has been improved with a new feature that restart the collector when the Devo connections is lost and it cannot be recovered.
When an exception is raised by the Collector Setup, the collector retries after 5 seconds. For consecutive exceptions, the waiting time is multiplied by 5 until hits 1800 seconds, which is the maximum waiting time allowed. No maximum retries are applied.
When an exception is raised by the Collector Pull method, the collector retries after 5 seconds. For consecutive exceptions, the waiting time is multiplied by 5 until hits 1800 seconds, which is the maximum waiting time allowed. No maximum retries are applied.
When an exception is raised by the Collector pre-pull method, the collector retries after 30 seconds. No maximum retries are applied.
Updated the underlying DevoSDK package to v3.6.4 and dependencies, this upgrade increases the resilience of the collector when the connection with Devo or the Syslog server is lost. The collector is able to reconnect in some scenarios without running the self-kill feature.
Support for stopping the collector when a GRACEFULL_SHUTDOWN system signal is received.
Re-enabled the logging to devo.collector.out for Input threads.
Improved self-kill functionality behavior.
Added more details in log traces.
Added log traces for knowing system memory usage.
Update
v1.3.0
Status
colour
Purple
title
NEW FEATURE
New features:
Added new alert types:
Data Loss Prevention
Apps outage
Primary admin changed
SSO profile added
SSO profile updated
SSO profile deleted
Super admin password reset
Update
v1.2.0
Status
colour
Purple
title
NEW FEATURE
Status
colour
Green
title
IMPROVEMENT
New features:
We added to the Alerts puller the feature to restart the persistence when the config start_time is updated at service level.
Improvements:
The performance has been improved after switching the internal delivery method. The events are delivered in batches instead of one by one.
