Cisco Umbrella collector

Overview

The collector retrieves events information from the Cisco Umbrella service using AWS S3.

Devo collector features

Feature	Details
Allow parallel downloading (`multipod`)	`not allowed`
Running environments	`collector server` `on-premise`
Populated Devo events	`table`
Flattening preprocessing	`no`
Allowed source events obfuscation	`yes`

Data sources

Data source	Description	AWS S3 subfolder	Collector service name	Devo table	Available from release
DNS logs	DNS logs show traffic that has reached our DNS resolvers.	`/dnslogs`	dnslogs	`sig.cisco.umbrella.dns`	v1.0.0
IP logs	IP logs	`/iplogs`	iplogs	`sig.cisco.umbrella.ip`	v1.0.0
Proxy Logs	Proxy logs show traffic that has passed through the Umbrella secure web gateway (SWG) or the Selective Proxy.	`/proxylogs`	proxylogs	`sig.cisco.umbrella.proxy`	v1.0.0
Firewall Traffic	Cloud Firewall logs show traffic that has been handled by network tunnels.	`/firewalllogs`	firewalllogs	`sig.cisco.umbrella.firewall`	v1.0.0
Admin Audit Logs	Admin Audit logs show changes made by your administrative team in your organization's Umbrella settings.	`/auditlogs`	auditlogs	`sig.cisco.umbrella.audit`	v1.0.0
Intrusion IPS Traffic	IPS logs show traffic, events, and possible threats detected by Umbrella's Intrusion Prevention System.	`/intrusionlogs`	intrusionlogs	`sig.cisco.umbrella.intrusion`	v1.0.0
DLP Traffic	DLP logs show information about DLP events where data identifiers were triggered and a violation occurred. DLP logs are available in all versions.	`/dlplogs`	dlplogs	`sig.cisco.umbrella.dlp`	v1.0.0

For more information on how the events are parsed, visit our page.

Flattening preprocessing

This collector does not implement flattening.

Source event obfuscation

This collector obfuscates credentials by default:

aws_access_key
aws_access_secret

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
`aws_access_key`	The AWS Access key for the AWS account.
`aws_access_secret`	The AWS Access secret for the AWS account.

Accepted authentication methods

Authentication method	AWS Access Key	AWS Access Secret
AWS Authentication	Required	Required

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.

Custom service

Internal process and deduplication method

This collector loops through the folders of an S3 bucket that are generated in 10-minute intervals. The folders are traversed with pagination. Inside each folder there are compressed files with the logs that are not ordered. Every time a folder is read, the logs are sent to devo in order from oldest to newest.

To avoid duplicates, the date of the last folder read is stored in persistence and if the collector crashes, the next folder will be read (which will be 10 minutes longer than the previous one).

Devo categorization and destination

All events of this service are ingested into the table sig.cisco.umbrella.{log_type}

Values of log_type:

dns
ip
proxy
firewall
audit
intrusion
dlp

Setup output

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

INFO InputProcess::MainThread -> CiscoUmbrellaPullerPullerSetup(cisco_umbrella_collector,cisco_umbrella#12345,dnslogs#custom) -> Starting thread
WARNING InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> Waiting until setup will be executed
WARNING InputProcess::CiscoUmbrellaPullerPullerSetup(cisco_umbrella_collector,cisco_umbrella#12345,dnslogs#custom) -> The token/header/authentication has not been created yet
INFO InputProcess::CiscoUmbrellaPullerPullerSetup(cisco_umbrella_collector,cisco_umbrella#12345,dnslogs#custom) -> Setup for module <CiscoUmbrellaPuller> has been successfully executed

Puller output

INFO InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) Starting the execution of pre_pull()
INFO InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> Reading persisted data
INFO InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> Data retrieved from the persistence: None
WARNING InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> start_time_in_utc has not been found in the configuration, the start date will be: 2023-10-05 07:14:31.652299+00:00
WARNING InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> Persistence will be overridden due to the retrieved state is empty
INFO InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> Running the persistence upgrade steps
INFO InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> Running the persistence corrections steps
INFO InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> Running the persistence corrections steps
WARNING InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> Some changes have been detected and the persistence needs to be updated. Previous content: None. New content: {'@persistence_version': 1, 'start_time_utc_str': '2023-10-05-07-14', 'last_pull_time_str': '2023-10-05-07-14', 'first_run': True}
INFO InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> Updating the persistence
WARNING InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> Persistence has been updated successfully
INFO InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) Finalizing the execution of pre_pull()
INFO InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> Starting data collection every 600 seconds
INFO InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> Pull Started
INFO InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1696490671652):Number of requests made: 1; Number of events received: 17603; Number of duplicated events filtered out: 0; Number of events generated and sent: 17603; Average of events per second: 7973.731.
INFO InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> Statistics for this pull cycle (@devo_pulling_id=1696490671652):Number of requests made: 1; Number of events received: 17603; Number of duplicated events filtered out: 0; Number of events generated and sent: 17603; Average of events per second: 7972.979.
INFO InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> The data is up to date!
INFO InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> Data collection completed. Elapsed time: 2.225 seconds. Waiting for 597.775 second(s) until the next one

After a successful collector’s execution (this is, no error logs were found), you should be able to see the following log message:

INFO InputProcess::CiscoUmbrellaPuller(cisco_umbrella,12345,dnslogs,custom) -> Statistics for this pull cycle (@devo_pulling_id=1696490671652):Number of requests made: 1; Number of events received: 17603; Number of duplicated events filtered out: 0; Number of events generated and sent: 17603; Average of events per second: 7972.979.

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

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.

Error Type	Error Id	Error Message	Cause	Solution
InitVariableError	1	Invalid start_time_in_utc: {datetime_utc_now}. Must be in the past.	The user has set the start_time_utc parameter in the future	Set the start_time_utc parameter to a date and time earlier than the current one in the configuration file.
ApiError	401	Encountered an AWS request client error: {e}	This is an AWS authentication error. The error message itself will explain the reason, it is likely that the data is incorrectly set (bucket, prefix, region...) or that the user does not have enough permissions.	Check that all the parameters are set correctly. Remember that if it is a bucket managed by the customer, the customer_bucket parameter is necessary and if it is a bucket managed by Cisco, the prefix_s3_name, region_name and bucket parameters are necessary. Also check user permissions.

Collector operations

This section is intended to explain how to proceed with specific operations of this collector.

Verify collector operations

Initialization

The initialization module is in charge of setup and running the input (pulling logic) and output (delivering logic) services and validating the given configuration.

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

INFO MainThread -> (CollectorMultithreadingQueue) standard_queue_multithreading -> max_size_in_messages: 10000, max_size_in_mb: 1024, max_wrap_size_in_items: 100
WARNING MainThread -> [INTERNAL LOGIC] DevoSender::_validate_kwargs_for_method__init__ -> The <address> does not appear to be an IP address and cannot be verified: collector-us.devo.io
WARNING MainThread -> [OUTPUT] OutputLookupSenders -> <threshold_for_using_gzip_in_transport_layer> setting has been modified from 1.1 to 1.0 due to this configuration increases the Lookup sender performance.
WARNING MainThread -> [INTERNAL LOGIC] DevoSender::_validate_kwargs_for_method__init__ -> The <address> does not appear to be an IP address and cannot be verified: collector-us.devo.io
INFO MainThread -> [OUTPUT] OutputMultithreadingController(threatquotient_collector) -> Starting thread
INFO MainThread -> [OUTPUT] DevoSender(standard_senders,devo_sender_0) -> Starting thread
INFO MainThread -> [OUTPUT] DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 600 seconds)
INFO MainThread -> [OUTPUT] DevoSenderManager(standard_senders,manager,devo_1)(devo_1) -> Starting thread
INFO MainThread -> [OUTPUT] DevoSender(lookup_senders,devo_sender_0) -> Starting thread
INFO MainThread -> [OUTPUT] DevoSenderManagerMonitor(lookup_senders,devo_1) -> Starting thread (every 600 seconds)
INFO MainThread -> [OUTPUT] DevoSenderManager(lookup_senders,manager,devo_1)(devo_1) -> Starting thread
INFO MainThread -> InitVariables Started
INFO MainThread -> start_time_value initialized
INFO MainThread -> verify_host_ssl_cert initialized
INFO MainThread -> event_fetch_limit_in_items initialized
INFO MainThread -> InitVariables Terminated
INFO MainThread -> [INPUT] InputMultithreadingController(threatquotient_collector) - Starting thread (executing_period=300s)
INFO MainThread -> [INPUT] InputThread(threatquotient_collector,threatquotient_data_puller#111) - Starting thread (execution_period=600s)
INFO MainThread -> [INPUT] ServiceThread(threatquotient_collector,threatquotient_data_puller#111,events#predefined) - Starting thread (execution_period=600s)
INFO MainThread -> [SETUP] ThreatQuotientDataPullerSetup(threatquotient_collector,threatquotient_data_puller#111,events#predefined) - Starting thread
INFO MainThread -> [INPUT] ThreatQuotientDataPuller(threatquotient_collector,threatquotient_data_puller#111,events#predefined) - Starting thread

Sender services

The Integrations Factory Collector SDK has 3 different senders services depending on the event type to delivery (internal, standard, and lookup). This collector uses the following Sender Services:

Sender services	Description
`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.

Sender statistics

Each service displays its own performance statistics that allow checking how many events have been delivered to Devo by type:

Logging trace

Description

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.

This value helps detect bottlenecks and needs to increase the performance of data delivery to Devo. This last can be made by increasing the concurrent senders.

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

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

By default these traces will be shown every 10 minutes.

Check memory usage

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

INFO InputProcess::MainThread -> [GC] global: 20.4% -> 20.4%, process: RSS(34.50MiB -> 34.08MiB), VMS(410.52MiB -> 410.02MiB)
INFO OutputProcess::MainThread -> [GC] global: 20.4% -> 20.4%, process: RSS(28.41MiB -> 28.41MiB), VMS(705.28MiB -> 705.28MiB)

Change log

Release	Released on	Release type	Details	Recommendations
`v1.4.0`	18 Sep 2024	IMPROVEMENTS	Improvements Updated DC SDK from `v1.12.2` to version `v1.12.4` Change internal queue management for protecting against OOMK Extracted ModuleThread structure from PullerAbstract Improve Controlled stop when both processes fails to instantiate Improve Controlled stop when InputProcess is killed Fixed error related a ValueError exception not well controlled. Fixed error related with loss of some values in internal messages	`Recommendend version`
`v1.3.0`	15 Aug 2024	IMPROVEMENTSBUG FIXES	Improvements Updated DC SDK to version `v1.12.2` Updated Docker image base to version `v1.3.0` in Dockerfile Bug fixes Fixed an exception raised by a date conversion when extracting the date from an event.	`Upgrade`
`v1.2.0`	12 Mar 2024	IMPROVEMENTS BUG FIXES	Improvements Deduplication within the Cisco Umbrella bucket. Bug fixes Added a time delay because events do not appear in real time in the Cisco Umbrella bucket	`Upgrade`
`v1.1.0`	29 Feb 2024	BUG FIX	Bug fixes: Fixed the way timestamps were handled for the state file	`Upgrade`
`v1.0.0`	26 Oct 2023	FEATURE	Initial release	`Initial release`