Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

File <filename>
Expand
titleTroubleshooting

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.

ErrorType

Error Id

Error Message

Cause

Solution

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

SetupError

100

File 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/.

Unable to refresh token or client Auth was deleted. Detail: <error_message>

To know how the token is regenerated, consult the section Vendor setup.

SetupError

1

101

Error

This error is raised when

the token

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.

InputConfigurationError<input_config_environment_key_path> property must be a string

SetupError

70

104

Operation timed out: <error_message>

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}$'

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

optional value environment does not match the required regex.

Make the value of environment in the configuration file match the indicated format.

GSuiteAlertsPullerConnectionLostException

0HTTP/1.1 503 Service Unavailable at moment - Retrying reconnection: <error_message>

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

1

301

Could not automatically determine credentials.

This error is raised when

the service is not availableDefaultCredentials: <error_message>

credentials are not loaded successfully.

This is an internal issue. Contact the support team.

2

PullError

302

The <next_timestamp> value cannot be calculated, please check the related error logs.

This error is raised when

credentials cannot be automatically determined

1

timestamp is invalid.

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.

PullError

303

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>

: <error_message>

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

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

.

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

.

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
colourGreen
titleIMPROVEMENT

Status
colourRed
titleBUG 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
colourGreen
titleIMPROVEMENT

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
colourGreen
titleIMPROVEMENT
Status
colourPurple
titleNEW 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
colourGreen
titleIMPROVEMENT

Improvements:

  • Updated DCSDK from 1.4.1 to 1.8.0.

Update

v1.5.0

Status
colourGreen
titleIMPROVEMENT

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
colourRed
titleBUG FIX

Bugs fixes:

  • Fixed a bug that prevented Syslog output from being enabled.

Update

v1.4.1

Status
colourGreen
titleIMPROVEMENT

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
colourPurple
titleNEW 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
colourPurple
titleNEW FEATURE

Status
colourGreen
titleIMPROVEMENT

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.

Update