Page Comparison

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.

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.

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.

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.

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.

Choose one of our available services:

• customer_takeout_initiated

• misconfigured_whitelist

• malware_reclassification

• phishing_reclassification

• suspicious_message_reported

• user_reported_phishing

• user_reported_spam_spike

• leaked_password

• suspicious_login

• suspicious_login_less_secure_app

• suspicious_programmatic_login

• user_suspended

• user_suspended_spam

• user_suspended_spam_through_relay

• user_suspended_suspicious_activity

• google_operations

• government_attack_warning

• device_compromised

• suspicious_activity

• appmaker_default_cloud_sql_setup

• activity_rule

• configuration_problem

• data_loss_prevention

• apps_outage

• primary_admin_changed

• sso_profile_added

• sso_profile_updated

• sso_profile_deleted

• super_admin_password_reset

For example:

services: 
    customer_takeout_initiated: 
        request_period_in_seconds: 60
    misconfigured_whitelist:
         request_period_in_seconds: 60

request_period_in_seconds_value

int

Optional

Minimum length: 1

Period in seconds used between each data pulling, this value will overwrite the default value (60 seconds)

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.

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.

collector-google_workspace_alerts_if-docker-image-1.5.0

c7c2420e52d567f83e30a2dd7a347c1cee83defdfd39ef573b316801dcd64be6

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.

GSuiteAlertsSetupException

1

Error loading token pickle file: <exception_message>

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 How to enable the collection in the vendor.

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 How to enable the collection in the vendor.

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.

1. Go back to a compatible version.

2. 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.

internal_senders

In charge of delivering internal metrics to Devo such as logging traces or metrics.

standard_senders

In charge of delivering pulled events to Devo.

Number of available senders: 1

Displays the number of concurrent senders available for the given Sender Service.

sender manager internal queue size: 0

Displays the items available in the internal sender queue.

Total number of messages sent: 44, messages sent since "2022-06-28 10:39:22.511671+00:00": 21 (elapsed 0.007 seconds)

Displayes the number of events from the last time and following the given example, the following conclusions can be obtained:

• 44 events were sent to Devo since the collector started.

• The last checkpoint timestamp was 2022-06-28 10:39:22.511671+00:00.

• 21 events where sent to Devo between the last UTC checkpoint and now.

• Those 21 events required 0.007 seconds to be delivered.