Firewalla MSP collector

Overview

Symantec Endpoint Protection, developed by Broadcom Inc., is a security software suite that consists of anti-malware, intrusion prevention and firewall features for server and desktop computers.

Devo collector features

Feature	Details
Allow parallel downloading (`multipod`)	`not allowed`
Running environments	`collector server`
Populated Devo events	`table`
Flattening preprocessing	`no`

Data sources

Data source	Description	API endpoint	Collector service name	Devo table	Available from release
Device	Get list of device	`/v1/device/list`	`devices`	`firewall.firewalla.msp.device`	`v1.0.0`
Device detail	Get device details	`/v1/device/{gid}/{mac}`	`devices`	`firewall.firewalla.msp.device_detail`	`v1.0.0`
Flows	Get flows of the firewall MSP	`/v2/flows`	`flows`	`firewall.firewalla.msp.flow`	`v1.0.0`
Alarm	Get list of alarm	`/v2/alarms`	`alarms`	`firewall.firewalla.msp.alarm`	`v1.0.0`
Alarm Detail	Get Alarm details	`/v2/alarms/{gid}/{aid}`	`alarms`	`firewall.firewalla.msp.alarm_detail`	`v1.0.0`
Box	Get the list of boxes	`/v2/boxes`	`boxes`	`firewall.firewalla.msp.box`	`v1.0.0`

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

Flattening preprocessing

Data source	Collector service	Optional	Flattening details
Device	`devices`	yes	not required
Device detail	`devices`	yes	not required
Flows	`flows`	yes	not required
Alarm	`alarms`	yes	not required
Alarm Detail	`alarms`	yes	not required
Box	`boxes`	yes	not required
Device	`devices`	yes	not required

Accepted Authentication Methods

Authentication method	`api_token`	`msp_domain`
api_token	`REQUIRED`	`REQUIRED`
msp_domain	`REQUIRED`	`REQUIRED`

Minimum configuration required for basic pulling

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

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

Setting	Details
api_token	The api_token for firewalla_msp API
msp_domain	The msp_domain for firewalla_msp API. ex: `https://{msp_domain}.firewalla.net`

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.

This collector can only make 30 requests per hour for each service.

Common Setup outpur for all services

Setup output

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

2024-12-17T15:56:52.446    INFO InputProcess::MainThread -> FirewallaMSPPullerSetup(firewalla_msp#123451,devices#predefined) -> Starting thread
2024-12-17T15:56:52.447    INFO InputProcess::MainThread -> FirewallaMSPDevicePuller(firewalla_msp#123451,devices#predefined) - Starting thread
2024-12-17T15:56:52.447    INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated
2024-12-17T15:56:52.447    INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-firewalla-msp/state/df8895fef2a509cbd87fcc9850dc0c81"
2024-12-17T15:56:52.451    INFO OutputProcess::MainThread -> OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-firewalla-msp/state/not_used/OutputLookupConsumer;lookup_senders;0.json.gz
2024-12-17T15:56:52.452 WARNING InputProcess::FirewallaMSPDevicePuller(firewalla_msp#123451,devices#predefined) -> Waiting until setup will be executed
2024-12-17T15:56:52.454    INFO InputProcess::MainThread -> InputMetricsThread -> Started thread for updating metrics values (update_period=10.0)
2024-12-17T15:56:52.456    INFO OutputProcess::MainThread -> OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated
2024-12-17T15:56:52.456    INFO OutputProcess::MainThread -> OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-firewalla-msp/state/865a79c1b99ad39b22becc235c9732cb"
2024-12-17T15:56:52.461    INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-firewalla-msp/state/not_used/DevoSenderManager;internal_senders;devo_1.json.gz
2024-12-17T15:56:52.466    INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated
2024-12-17T15:56:52.466    INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-firewalla-msp/state/e784c94a6fe28de5937e50674407d82e"
2024-12-17T15:56:52.477    INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-firewalla-msp/state/not_used/DevoSender;internal_senders;devo_sender_0.json.gz
2024-12-17T15:56:52.480    INFO InputProcess::MainThread -> [GC] global: 26.6% -> 26.6%, process: RSS(74.55MiB -> 75.05MiB), VMS(825.46MiB -> 825.46MiB)
2024-12-17T15:56:52.481    INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "vendor_requests" created: "Number of requests received from the vendor API", unit: "requests"
2024-12-17T15:56:52.482    INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated
2024-12-17T15:56:52.482    INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_incoming_received" created: "Number of messages received from the vendor API", unit: "1"
2024-12-17T15:56:52.482    INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-firewalla-msp/state/4ff7b345dc444ac050cf75f93e5dcb3b"
2024-12-17T15:56:52.483    INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_incoming_removed" created: "Number of messages removed by the collector", unit: "1"
2024-12-17T15:56:52.483    INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_incoming_filtered" created: "Number of messages filtered by the collector", unit: "1"
2024-12-17T15:56:52.483    INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_enqueued_standard_counter" created: "Number of messages enqueued", unit: "1"
2024-12-17T15:56:52.484    INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_enqueued_standard_bytes" created: "Number of bytes enqueued", unit: "1"
2024-12-17T15:56:52.484    INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_enqueued_lookup_counter" created: "Number of messages enqueued", unit: "1"
2024-12-17T15:56:52.484    INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_enqueued_lookup_bytes" created: "Number of messages enqueued", unit: "1"
2024-12-17T15:56:52.484    INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_enqueued_internal_counter" created: "Number of messages enqueued in the queue", unit: "1"
2024-12-17T15:56:52.485    INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_enqueued_internal_bytes" created: "Number of messages enqueued in the queue", unit: "1"
2024-12-17T15:56:52.485    INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Gauge "module_global_status" created: "Global status of current module", unit: "1"
2024-12-17T15:56:52.487    INFO OutputProcess::MainThread -> OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-firewalla-msp/state/not_used/OutputInternalConsumer;internal_senders;0.json.gz
2024-12-17T15:56:52.491    INFO OutputProcess::MainThread -> OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated
2024-12-17T15:56:52.491    INFO OutputProcess::MainThread -> OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-firewalla-msp/state/10dd360c86621afd5a28a029a0dddcf6"
2024-12-17T15:56:52.493    INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread
2024-12-17T15:56:52.494    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 300 seconds)
2024-12-17T15:56:52.495    INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread
2024-12-17T15:56:52.495    INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-12-17T15:56:52.496    INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-12-17T15:56:52.496    INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> Starting thread
2024-12-17T15:56:52.498    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(lookup_senders,devo_1) -> Starting thread (every 300 seconds)
2024-12-17T15:56:52.500    INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> Starting thread
2024-12-17T15:56:52.502    INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-12-17T15:56:52.503    INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-12-17T15:56:52.504    INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-12-17T15:56:52.504    INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.01
2024-12-17T15:56:52.504    INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread
2024-12-17T15:56:52.505    INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-12-17T15:56:52.506    INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-12-17T15:56:52.506    INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00
2024-12-17T15:56:52.508    INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-12-17T15:56:52.508    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_1) -> Starting thread (every 300 seconds)
2024-12-17T15:56:52.508    INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.01
2024-12-17T15:56:52.508    INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.01
2024-12-17T15:56:52.509    INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> Starting thread
2024-12-17T15:56:52.509    INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-12-17T15:56:52.510    INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-12-17T15:56:52.514    INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-12-17T15:56:52.514    INFO OutputProcess::MainThread -> OutputMetricsThread -> Started thread for updating metrics values (update_period=10.0)
2024-12-17T15:56:52.515    INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00
2024-12-17T15:56:52.515    INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-12-17T15:56:52.517    INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.01
2024-12-17T15:56:52.520    INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_sent_counter" created: "Number of messages sent to the defined output", unit: "1"
2024-12-17T15:56:52.551    INFO MainProcess::MetricsConsumerThread -> OpenTelemetryServer -> [METRIC] Counter "msg_sent_bytes" created: "Number of bytes sent to the defined output", unit: "1"
2024-12-17T15:56:52.552    INFO OutputProcess::MainThread -> [GC] global: 26.7% -> 26.8%, process: RSS(74.80MiB -> 75.18MiB), VMS(1.37GiB -> 1.37GiB)
2024-12-17T15:56:53.207    INFO OutputProcess::DevoSender(internal_senders,devo_sender_0) -> Created a sender: {"name": "DevoSender(internal_senders,devo_sender_0)", "url": "collector-eu.devo.io:443", "chain_path": "/home/md_tausif/gitlab/devo-collector-firewalla-msp/certs/chain.crt", "cert_path": "/home/md_tausif/gitlab/devo-collector-firewalla-msp/certs/int-if-integrations-india.crt", "key_path": "/home/md_tausif/gitlab/devo-collector-firewalla-msp/certs/int-if-integrations-india.key", "transport_layer_type": "SSL", "last_usage_timestamp": null, "socket_status": null}, hostname: "2023-apac-0046", session_id: "137769423454016"
2024-12-17T15:56:53.209    INFO OutputProcess::DevoSender(internal_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-12-17T15:56:53.635    INFO InputProcess::FirewallaMSPPullerSetup(firewalla_msp#123451,devices#predefined) -> Setup for module <FirewallaMSPDevicePuller> has been successfully executed

Boxes

Verify data collection

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.

Puller output

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

Note that the PrePull action is executed only one time before the first run of the Pull action.

2024-12-17T16:08:10.210    INFO InputProcess::FirewallaMSPBoxPuller(firewalla_msp#123451,boxes#predefined) -> Pull Started
2024-12-17T16:08:11.507    INFO InputProcess::FirewallaMSPBoxPuller(firewalla_msp#123451,boxes#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1734431890199):Number of requests made: 1; Number of events received: 2; Number of duplicated events filtered out: 0; Number of events generated and sent: 2; Average of events per second: 1.543.
2024-12-17T16:08:11.508    INFO InputProcess::FirewallaMSPBoxPuller(firewalla_msp#123451,boxes#predefined) -> Sent 2 events to Devo
2024-12-17T16:08:11.508    INFO InputProcess::FirewallaMSPBoxPuller(firewalla_msp#123451,boxes#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1734431890199):Number of requests made: 1; Number of events received: 2; Number of duplicated events filtered out: 0; Number of events generated and sent: 2; Average of events per second: 1.541.
2024-12-17T16:08:11.509    INFO InputProcess::FirewallaMSPBoxPuller(firewalla_msp#123451,boxes#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1734431890199):Number of requests made: 1; Number of events received: 2; Number of duplicated events filtered out: 0; Number of events generated and sent: 2; Average of events per second: 1.541.
2024-12-17T16:08:11.509    INFO InputProcess::FirewallaMSPBoxPuller(firewalla_msp#123451,boxes#predefined) -> The data is up to date!

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

2024-12-17T16:08:11.509    INFO InputProcess::FirewallaMSPBoxPuller(firewalla_msp#123451,boxes#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1734431890199):Number of requests made: 1; Number of events received: 2; Number of duplicated events filtered out: 0; Number of events generated and sent: 2; Average of events per second: 1.541.

devices

Verify data collection

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.

Puller output

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

Note that the PrePull action is executed only one time before the first run of the Pull action.

2024-12-17T16:04:23.075    INFO InputProcess::FirewallaMSPDevicePuller(firewalla_msp#123451,devices#predefined) -> Pull Started
2024-12-17T16:04:24.187    INFO InputProcess::FirewallaMSPDevicePuller(firewalla_msp#123451,devices#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1734431663070):Number of requests made: 1; Number of events received: 34; Number of duplicated events filtered out: 0; Number of events generated and sent: 34; Average of events per second: 30.601.
2024-12-17T16:04:24.188    INFO InputProcess::FirewallaMSPDevicePuller(firewalla_msp#123451,devices#predefined) -> Sent 34 events to Devo
2024-12-17T16:04:24.188    INFO InputProcess::FirewallaMSPDevicePuller(firewalla_msp#123451,devices#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1734431663070):Number of requests made: 1; Number of events received: 34; Number of duplicated events filtered out: 0; Number of events generated and sent: 34; Average of events per second: 30.548.
2024-12-17T16:04:24.189    INFO InputProcess::FirewallaMSPDevicePuller(firewalla_msp#123451,devices#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1734431663070):Number of requests made: 1; Number of events received: 34; Number of duplicated events filtered out: 0; Number of events generated and sent: 34; Average of events per second: 30.528.
2024-12-17T16:04:24.190    INFO InputProcess::FirewallaMSPDevicePuller(firewalla_msp#123451,devices#predefined) -> The data is up to date!

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

2024-12-17T16:04:24.189    INFO InputProcess::FirewallaMSPDevicePuller(firewalla_msp#123451,devices#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1734431663070):Number of requests made: 1; Number of events received: 34; Number of duplicated events filtered out: 0; Number of events generated and sent: 34; Average of events per second: 30.528.

flows

Verify data collection

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.

Puller output

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

Note that the PrePull action is executed only one time before the first run of the Pull action.

2024-12-17T16:58:10.099    INFO InputProcess::FirewallaMSPFlowPuller(firewalla_msp#123451,flows#predefined) -> Pull Started
2024-12-17T16:58:11.535    INFO InputProcess::FirewallaMSPFlowPuller(firewalla_msp#123451,flows#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1734434890089):Number of requests made: 1; Number of events received: 200; Number of duplicated events filtered out: 0; Number of events generated and sent: 200; Average of events per second: 139.372.
2024-12-17T16:58:11.537    INFO InputProcess::FirewallaMSPFlowPuller(firewalla_msp#123451,flows#predefined) -> Sent 200 events to Devo
2024-12-17T16:58:11.538    INFO InputProcess::FirewallaMSPFlowPuller(firewalla_msp#123451,flows#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1734434890089):Number of requests made: 1; Number of events received: 200; Number of duplicated events filtered out: 0; Number of events generated and sent: 200; Average of events per second: 139.012.
2024-12-17T16:58:11.539    INFO InputProcess::FirewallaMSPFlowPuller(firewalla_msp#123451,flows#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1734434890089):Number of requests made: 1; Number of events received: 200; Number of duplicated events filtered out: 0; Number of events generated and sent: 200; Average of events per second: 138.980.
2024-12-17T16:58:11.539    INFO InputProcess::FirewallaMSPFlowPuller(firewalla_msp#123451,flows#predefined) -> The data is up to date!

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

2024-12-17T16:58:11.539    INFO InputProcess::FirewallaMSPFlowPuller(firewalla_msp#123451,flows#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1734434890089):Number of requests made: 1; Number of events received: 200; Number of duplicated events filtered out: 0; Number of events generated and sent: 200; Average of events per second: 138.980.

alarms

Verify data collection

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.

Puller output

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

Note that the PrePull action is executed only one time before the first run of the Pull action.

2024-12-17T16:59:45.823    INFO InputProcess::FirewallaMSPAlarmPuller(firewalla_msp#123451,alarms#predefined) -> Pull Started
2024-12-17T16:59:47.391    INFO InputProcess::FirewallaMSPAlarmPuller(firewalla_msp#123451,alarms#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1734434985808):Number of requests made: 1; Number of events received: 86; Number of duplicated events filtered out: 0; Number of events generated and sent: 86; Average of events per second: 54.917.
2024-12-17T16:59:47.392    INFO InputProcess::FirewallaMSPAlarmPuller(firewalla_msp#123451,alarms#predefined) -> Sent 86 events to Devo
2024-12-17T16:59:47.393    INFO InputProcess::FirewallaMSPAlarmPuller(firewalla_msp#123451,alarms#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1734434985808):Number of requests made: 1; Number of events received: 86; Number of duplicated events filtered out: 0; Number of events generated and sent: 86; Average of events per second: 54.843.
2024-12-17T16:59:47.394    INFO InputProcess::FirewallaMSPAlarmPuller(firewalla_msp#123451,alarms#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1734434985808):Number of requests made: 1; Number of events received: 86; Number of duplicated events filtered out: 0; Number of events generated and sent: 86; Average of events per second: 54.807.
2024-12-17T16:59:47.395    INFO InputProcess::FirewallaMSPAlarmPuller(firewalla_msp#123451,alarms#predefined) -> The data is up to date!

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

2024-12-17T16:59:47.394    INFO InputProcess::FirewallaMSPAlarmPuller(firewalla_msp#123451,alarms#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1734434985808):Number of requests made: 1; Number of events received: 86; Number of duplicated events filtered out: 0; Number of events generated and sent: 86; Average of events per second: 54.807.

Restart the persistance

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_in_utc 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 that this action clears the persistence and cannot be recovered in any way. Resetting persistence could result in duplicate or lost events.

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.

Note: If the error is Failed to establish a new connection: [Errno 110] Connection timed out please check the credentials if they are provided correctly.

Error type	Error ID	Error message	Cause	Solution
`InitVariablesError`	`1`	`"start_time_in_utc" setting from "services" section should be in the following format - YYYY-MM-DDThh:mm:ssZ`	param 'start_time_in_utc' is not in correct format	start_time_in_utc should be in correct format
`InitVariablesError`	`2`	`"start_time_in_utc" {start_time} is in the future`	param 'start_time_in_utc' is not in correct format	start_time_in_utc should be current time or in the past
`InitVariablesError`	`3`	`start_time_in_utc" is not defined. It should be defined`	param 'start_time_in_utc' is not defined	start_time_in_utc should be defined
`SetupError`	`100`	`HTTP Error occurred while checking the server health for firewalla_msp: {error message}`	Credentials error {unauthorized} or mismatch b/w credentials or firewalla_msp server error	Check the credentials or contact developer with required message
`SetupError`	`101`	`Some error occurred while checking the server health for firewalla_msp. Error detailsl {e}.`	Error on the firewalla msp server.	Contact the developer with exact error message.
`PullError`	`300`	`Error related to HTTP, occurred while retrieving events from firewalla_msp server{summery} , {details}`	This error happens when the collector tries to fetch the data from API.	In this error you will find the HTTP error code as well as the summary and details.
`PullError`	`301`	`Error while checking the server health for firewalla_msp. Error: {details}`	Some exceptions occurred while making the API request.	Contact the developer with exact error message.
`PullError`	`302`	`HTTP Error occurred while checking the server health for firewalla_msp: {error message}`	Error while fetching sender_ip_address data	Get the HTTP error code and contact the developer
`PullError`	`303`	`Some error occurred while checking the server health for firewalla_msp. Error details {e}`	Exception while making the API request sender_ip_address	In this error you will find the HTTP error code as well as the summary and details.
`PullError`	`304`	`HTTP Error occurred while checking the server health for firewalla_msp: {error message}`	Error while fetching sender_data data	Contact the developer with required message
`PullError`	`305`	`Some error occurred while checking the server health for firewalla_msp. Error details {e}`	Some exceptions occurred while making the API request.	Contact the developer with required message

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:

2024-12-17T16:59:43.786    INFO InputProcess::MainThread -> FirewallaMSPAlarmPuller(firewalla_msp#123451,alarms#predefined) Starting the execution of init_variables()
2024-12-17T16:59:43.786    INFO InputProcess::MainThread -> Validating service metadata
2024-12-17T16:59:43.786    INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-firewalla-msp/state/not_used/DevoSender;internal_senders;devo_sender_0.json.gz
2024-12-17T16:59:43.787    INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated
2024-12-17T16:59:43.787    INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-firewalla-msp/state/4ff7b345dc444ac050cf75f93e5dcb3b"
2024-12-17T16:59:43.787    INFO OutputProcess::MainThread -> OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-firewalla-msp/state/not_used/OutputInternalConsumer;internal_senders;0.json.gz
2024-12-17T16:59:43.788    INFO InputProcess::MainThread -> Validating defined module definition
2024-12-17T16:59:43.788    INFO OutputProcess::MainThread -> OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated
2024-12-17T16:59:43.788    INFO OutputProcess::MainThread -> OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-firewalla-msp/state/10dd360c86621afd5a28a029a0dddcf6"
2024-12-17T16:59:43.788    INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread
2024-12-17T16:59:43.788    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 300 seconds)
2024-12-17T16:59:43.788    INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread
2024-12-17T16:59:43.789    INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-12-17T16:59:43.789    INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-12-17T16:59:43.789    INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> Starting thread
2024-12-17T16:59:43.789    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(lookup_senders,devo_1) -> Starting thread (every 300 seconds)
2024-12-17T16:59:43.789    INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> Starting thread
2024-12-17T16:59:43.790    INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-12-17T16:59:43.790    INFO InputProcess::MainThread -> Validating common input config
2024-12-17T16:59:43.790    INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-12-17T16:59:43.790    INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-12-17T16:59:43.790    INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00
2024-12-17T16:59:43.791    INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-12-17T16:59:43.791    INFO InputProcess::MainThread -> Validating service input config
2024-12-17T16:59:43.791    INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread
2024-12-17T16:59:43.791    INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-12-17T16:59:43.791    INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-12-17T16:59:43.791    INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00
2024-12-17T16:59:43.791    INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00
2024-12-17T16:59:43.791    INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00
2024-12-17T16:59:43.791    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_1) -> Starting thread (every 300 seconds)
2024-12-17T16:59:43.792    INFO InputProcess::MainThread -> Running overriding rules
2024-12-17T16:59:43.792    INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> Starting thread
2024-12-17T16:59:43.792    INFO InputProcess::MainThread -> Overriding rule #1 - service key <override_devo_tag> with value <my.app.devo.alarm> overrides definition key <devo_tag> with value <None> when the first is not <None>
2024-12-17T16:59:43.792    INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-12-17T16:59:43.792    INFO InputProcess::MainThread -> Validating the rate limiter config given by the user
2024-12-17T16:59:43.792    INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-12-17T16:59:43.792    INFO InputProcess::MainThread -> <requests_limits> setting has not been defined. The generic settings will be used instead.
2024-12-17T16:59:43.792    INFO InputProcess::MainThread -> Adding raw config to the collector store
2024-12-17T16:59:43.792    INFO InputProcess::MainThread -> Running custom validation rules
2024-12-17T16:59:43.792    INFO OutputProcess::MainThread -> OutputMetricsThread -> Started thread for updating metrics values (update_period=10.0)
2024-12-17T16:59:43.793    INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-12-17T16:59:43.793    INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00
2024-12-17T16:59:43.793    INFO InputProcess::MainThread -> FirewallaMSPAlarmPuller(firewalla_msp#123451,alarms#predefined) Finalizing the execution of init_variables()

Events delivery and Devo ingestion

The event delivery module is in charge of receiving the events from the internal queues where all events are injected by the pullers and delivering them using the selected compatible delivery method.

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

2024-10-22T14:35:26.598    INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_1) -> Number of available senders: 1, sender manager internal queue size: 0
2024-10-22T14:35:26.598    INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_1) -> enqueued_elapsed_times_in_seconds_stats: {}
2024-10-22T14:35:26.598    INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_1) -> Sender: DevoSender(lookup_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": False}
2024-10-22T14:35:26.598    INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_1) -> Lookup - Total number of messages sent: 0, messages sent since "2024-10-22 09:00:26.589348+00:00": 0 (elapsed 0.000 seconds)
2024-10-22T14:35:26.599    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,devo_1) -> Number of available senders: 1, sender manager internal queue size: 0
2024-10-22T14:35:26.599    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,devo_1) -> enqueued_elapsed_times_in_seconds_stats: {}
2024-10-22T14:35:26.599    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,devo_1) -> Sender: DevoSender(internal_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": True}
2024-10-22T14:35:26.599    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,devo_1) -> Internal - Total number of messages: 356 messages/bytes sent since/to "2024-10-22T09:00:26.593798+00:00/2024-10-22T09:05:26.599849+00:00": 356/155269, (elapsed 1.448 seconds)

By default, these information traces will be displayed every 10 minutes.

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: 0, messages sent since "2024-12-17 09:00:26.589348+00:00": 0 (elapsed 0.000 seconds)

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

0 events were sent to Devo since the collector started.
The last checkpoint timestamp was 2024-12-17 09:00:26.589348+00:00.
0 events where sent to Devo between the last UTC checkpoint and now.
Those 0 events required 0.000 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

2024-12-17T16:59:50.559    INFO InputProcess::MainThread -> [GC] global: 29.5% -> 29.5%, process: RSS(66.15MiB -> 66.15MiB), VMS(738.87MiB -> 738.87MiB)
2024-12-17T16:59:43.815    INFO OutputProcess::MainThread -> [GC] global: 29.4% -> 29.5%, process: RSS(61.77MiB -> 62.27MiB), VMS(1.07GiB -> 1.07GiB)

Differences between RSS and VMS memory usage:

RSS is the Resident Set Size, which is the actual physical memory the process is using
VMS is the Virtual Memory Size which is the virtual memory that process is using

Change log

Release	Released on	Release type	Details	Recommendations
`v1.0.0`	09 Jan 2025	NEW FEATURE	`Initial Release`	`Recommended Version`