Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel2
outlinefalse
stylenone
typeflat
printabletrue

Devo collector features

Feature

Details

Allow parallel downloading (multipod)

not allowed

Running environments

  • collector server

  • On premise

Populated Devo events

table

Flattening preprocessing

no

Data sources

Data source

Description

API endpoint

Collector service name

Devo table

Available from release

Domains - BIMI

Get the bimi selectors for a domain

/bimi-selectors

domains_bimi

dmarc.sendmarc.bimi.domain

v1.0.1

Get a bimi selector for a domain

/bimi-selectors/{bimiSelector}

dmarc.sendmarc.bimi.selector

Domains - DKIM

Get the DKIM public keys for a domain

/dkim-public-keys

domains_dkim

dmarc.sendmarc.dkim.domain

Get a DKIM public key for a domain

/dkim-public-keys/{dkimPublicKey}

dmarc.sendmarc.dkim.public_key

Domains - DMARC

Get the DMARC settings for a domain

/dmarc-settings

dmarc_settings

dmarc.sendmarc.setting.dmarc

Domains - IP Addresses Details and Totals

Get Details and totals for a specific IPaddress (source)

/statistics/dmarc/ip-addresses/{source}

ip_address

dmarc.sendmarc.ip_address.source

Domains - IP Addresses Statistics

Get IP addresses statistics for domain

/statistics/dmarc/ip-addresses

dmarc.sendmarc.ip_address.domain

Domains - Senders

Get volume of totals on domain

/statistics/dmarc/volume/totals

dmarc_volume_total

dmarc.sendmarc.volume.total

Get totals according to a group

/statistics/dmarc/volume/totals/grouped/{grouping}

dmarc.sendmarc.volume.group_total

Get details and totals in the IP addresses used by a sender on a domain grouped by date

/statistics/dmarc/volume/timeline

dmarc_volume_timeline

dmarc.sendmarc.volume.timeline

Get aggregate report records for IP addresses

/statistics/dmarc/ip-addresses/{source}/aggregate-report-records

ip_address

dmarc.sendmarc.ip_address.aggregate_records_report

Get timeline statistics for senders on a domain

/statistics/dmarc/senders

senders

dmarc.sendmarc.sender.domain

Get timeline statistics for a sender on a domain

/statistics/dmarc/senders/{sender}

dmarc.sendmarc.sender.domain_detail

Get details and totals of IP addresses used by sender on domain

/statistics/dmarc/senders/{sender}/ip-addresses

dmarc.sendmarc.ip_address.sender

Domains - SPF

Get the SPF settings for a domain

/spf-settings

spf_settings

dmarc.sendmarc.setting.spf

Domain - STS

Get the TLS and STS settings for a domain

/sts-settings

sts_settings

dmarc.sendmarc.setting.sts

Info

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

Accepted authentication methods

user_id

Status
colourGreen
titlerequired

Status
colourGreen
titlerequired

api_key

Status
colourGreen
titlerequired

Status
colourGreen
titlerequired

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 running the collector section for details.

user_id → The user_id for Sendmarc API

api_key → The api_key for Sendmarc API

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
titleCloud 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:

  1. In the Collector Server GUI, access the domain in which you want this instance to be created

  2. Click Add Collector and find the one you wish to add.

  3. In the Version field, select the latest value.

  4. In the Collector Name field, set the value you prefer (this name must be unique inside the same Collector Server domain).

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

  6. In the Parameters section, establish the Collector Parameters as follows below:

Editing the JSON configuration

Code Block
{
  "global_overrides": {
    "debug": false
  },
  "sendmarc": {
    "id": "<short_unique_id>",
    "enabled": true,
    "credentials": {
      "user_id": "<user_id>",
      "api_key": "<api_key>",
      "accounts_url": "<opt_accounts_url>"
    },
    "services": {
      "senders": {
        "request_period_in_seconds": "<opt_request_period_in_seconds>",
        "include_sender_data": "<opt_include_sender_data>",
        "include_sender_ip_address_data": "<opt_include_sender_ip_address_data>",
        "override_devo_tag": "<opt_override_devo_tag>",
        "override_devo_sender_tag": "<opt_override_devo_sender_tag>",
        "override_devo_sender_ip_address_tag": "<opt_override_devo_sender_ip_address_tag>"
      },
      "ip_address": {
        "request_period_in_seconds": "<opt_request_period_in_seconds>",
        "include_ip_address_source": "<opt_include_ip_address_source>"
        "include_ip_address_aggregate_records": "<opt_include_ip_address_aggregate_records>",
        "override_devo_tag": "<opt_override_devo_tag>", 
        "override_devo_ip_address_source_tag": "<opt_override_devo_ip_address_source_tag>",
        "override_devo_ip_address_aggregate_tag": "<opt_override_devo_ip_address_aggregate_tag>"
        },
      "sts_settings": {
        "request_period_in_seconds": "<opt_request_period_in_seconds>",
        "override_devo_tag": "<opt_override_devo_tag>"
        },
      "spf_settings": {
        "request_period_in_seconds": "<opt_request_period_in_seconds>",
        "override_devo_tag": "<opt_override_devo_tag>"
        },
      "dmarc_settings": {
        "request_period_in_seconds": "<opt_request_period_in_seconds>",
        "override_devo_tag": "<opt_override_devo_tag>"
        },
       "domains_dkim": {
        "request_period_in_seconds": "<opt_request_period_in_seconds>",
         "override_devo_tag": "<opt_override_devo_tag>",
         "include_public_key_data": "<opt_include_public_key_data>",
        "override_devo_public_key_tag": "<opt_override_devo_public_key_tag>"
        },
       "domains_bimi": {
        "request_period_in_seconds": "<opt_request_period_in_seconds>",
         "override_devo_tag": "<opt_override_devo_tag>",
         "include_bimi_selector_data": "<opt_include_bimi_selector_data>",
         "override_devo_bimi_selector_tag": "<opt_override_devo_bimi_selector_tag>"
        },
       "dmarc_volume_timeline": {
        "request_period_in_seconds": "<opt_request_period_in_seconds>",
         "override_devo_tag": "<opt_override_devo_tag>"
        },
       "dmarc_volume_total": {
        "request_period_in_seconds": "<opt_request_period_in_seconds>",
         "override_devo_tag": "<opt_override_devo_tag>",
         "group_values": "<group_values>",
        "include_total_group_data": "<opt_include_total_group_data>",
        "override_devo_total_group_tag": "<opt_override_devo_total_group_tag>"
        }
     }
  }
}

Parameter

Data type

Type

Value range / Format

Details

<short_unique_id>

int

Mandatory

Minimum Length 5

Use this param to give a unique id to this input service.

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.

<user_id>

str

Mandatory

Minimum Length 1

user_id for Sendmarc API

<api_key>

str

Mandatory

Minimum Length 1

api_key for Sendmarc API

<opt_accounts_url>

str

Optional

Minimum Length 1

If provided it will override the default sendmarc accounts_url. ex: https://<sendmarc_url>/api/v1/accounts

<opt_override_devo_tag>

str

Optional

A devo tag

This parameter allows defining a custom devo tag.

<opt_request_period_in_seconds>

int

Optional

Minimum Length 1

Period in seconds used between each data pulling, this value will override the value. The default value is 86400 seconds

<opt_include_sender_data>

boolean

Optional

false / true

if true collector will fetch data from endpoint /statistics/dmarc/senders/{sender}

<opt_include_sender_ip_address_data>

boolean

Optional

false / true

if true collector will fetch data from endpoint /statistics/dmarc/senders/{sender}/ip-addresses

<opt_include_ip_address_source>

boolean

Optional

false / true

if true collector will fetch data from endpoint /statistics/dmarc/ip-addresses/{source}

<opt_include_total_group_data>

boolean

Optional

false / true

if true collector will fetch data from endpoint /statistics/dmarc/volume/totals/grouped/{grouping}

<opt_include_bimi_selector_data>

boolean

Optional

false / true

if true collector will fetch data from endpoint /bimi-selectors/{bimiSelector}

<opt_include_public_key_data>

boolean

Optional

false / true

if true collector will fetch data from endpoint /dkim-public-keys/{dkimPublicKey}

<opt_include_ip_address_aggregate_records>

boolean

Optional

false / true

if true collector will fetch data from endpoint /statistics/dmarc/ip-addresses/{source}/aggregate-report-records

<group_values>

array

Optional/Mandatory

Minimum Length 1

Array of available group_values. ex:- ["country"] . This field will be mandatory if opt_include_total_group_data is true

<opt_override_devo_sender_tag>

str

Optional

A devo tag

It will override the devo tag for the endpoint statistics/dmarc/senders/{sender}

<opt_override_devo_sender_ip_address_tag>

str

Optional

A devo tag

It will override the devo tag for the endpoint /statistics/dmarc/senders/{sender}/ip-addresses

<opt_override_devo_ip_address_source_tag>

str

Optional

A devo tag

It will override the devo tag for the endpoint /statistics/dmarc/ip-addresses/{source}

<opt_override_devo_ip_address_aggregate_tag>

str

Optional

A devo tag

It will override the devo tag for the endpoint /statistics/dmarc/ip-addresses/{source}/aggregate-report-records

<opt_override_devo_bimi_selector_tag>

str

Optional

A devo tag

It will override the devo tag for the endpoint /bimi-selectors/{bimiSelector}

<opt_override_devo_public_key_tag>

str

Optional

A devo tag

It will override the devo tag for the endpoint /dkim-public-keys/{dkimPublicKey}

<opt_override_devo_total_group_tag>

str

Optional

A devo tag

It will override the devo tag for the endpoint /statistics/dmarc/volume/totals/grouped/{grouping}

Rw tab
titleOn-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:

Code Block
<any_directory>
└── devo-collectors/
    └── <product_name>/
        ├── certs/
        │   ├── chain.crt
        │   ├── <your_domain>.key
        │   └── <your_domain>.crt
        ├── state/
        └── config/ 
            └── config.yaml
Note

Replace <product_name> with the proper value.

Devo credentials

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.

image-20241114-154134.pngImage Added
Note

Replace <product_name> with the proper value.

Editing the config.yaml file

Code Block
globals:
  debug: false
  id: not_used
  name: sendmarc
  persistence:
    type: filesystem
    config:
      directory_name: state

outputs:
  devo_1:
    type: devo_platform
    config:
      address: collector-us.devo.io
      port: 443
      type: SSL
      chain: chain.crt
      cert: <devo_domain>.crt
      key: <devo_domain>.key
  console_1:
    type: console

inputs:
  sendmarc:
    id: <short_unique_id>
    enabled: true
    credentials:
      user_id: <user_id>
      api_key: <api_key>
      accounts_url: <account_url> #optional
    services:
      senders:
        request_period_in_seconds : <request_period_in_seconds> #optional
        include_sender_data: <include_sender_data> #optional
        include_sender_ip_address_data: <include_sender_ip_address_data> #optional
        override_devo_tag: <override_devo_tag> #optional
        override_devo_sender_tag: <override_devo_sender_tag> #optional
        override_devo_sender_ip_address_tag: <override_devo_sender_ip_address_tag> #optional
      ip_address:
        request_period_in_seconds: <request_period_in_seconds> #optional
        include_ip_address_source: <include_ip_address_source> #optional
        include_ip_address_aggregate_records: <include_ip_address_aggregate_records> #optional
        override_devo_tag: <override_devo_tag> #optional
        override_devo_ioverride_devo_bimi_selector_tagp_address_source_tag: <override_devo_ip_address_source_tag> #optional
        override_devo_ip_address_aggregate_tag: <override_devo_ip_address_aggregate_tag> #optional
      sts_settings:
        request_period_in_seconds: <request_period_in_seconds> #optional
        override_devo_tag: <override_devo_tag> #optional
      spf_settings:
        request_period_in_seconds: <request_period_in_seconds> #optional
        override_devo_tag: <override_devo_tag> #optional
      dmarc_settings:
        request_period_in_seconds: <request_period_in_seconds> #optional
        override_devo_tag: <override_devo_tag> #optional
      domains_dkim:
        request_period_in_seconds: <request_period_in_seconds> #optional
        override_devo_tag: <override_devo_tag> #optional
        include_public_key_data: <include_public_key_data> #optional
        override_devo_public_key_tag: <override_devo_public_key_tag> #optional
      domains_bimi:
        request_period_in_seconds: <request_period_in_seconds> #optional
        include_bimi_selector_data: <include_bimi_selector_data> #optional
        override_devo_tag: <override_devo_tag> #optional
        override_devo_bimi_selector_tag: <override_devo_bimi_selector_tag> #optional
      dmarc_volume_timeline:
        request_period_in_seconds: <request_period_in_seconds> #optional
        override_devo_tag: <override_devo_tag> #optional
      dmarc_volume_total:
        group_values: <group_values> # mandatory if include_total_group_data is true
        include_total_group_data: <include_total_group_data>
        request_period_in_seconds: <request_period_in_seconds> #optional
        override_devo_tag: <override_devo_tag> #optional
        override_devo_total_group_tag: <override_devo_total_group_tag>
Info

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 / Format

Details

<short_unique_id>

int

Mandatory

Minimum Length 5

Use this param to give a unique id to this input service.

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.

<user_id>

str

Mandatory

Minimum Length 1

user_id for Sendmarc API

<api_key>

str

Mandatory

Minimum Length 1

api_key for Sendmarc API

<accounts_url>

str

Optional

Minimum Length 1

If provided it will override the default sendmarc accounts_url. ex: https://<sendmarc_url>/api/v1/accounts

<override_devo_tag>

str

Optional

A devo tag

This parameter allows defining a custom devo tag.

<request_period_in_seconds>

int

Optional

Minimum Length 1

Period in seconds used between each data pulling, this value will override the value. The default value is 86400 seconds

<include_sender_data>

boolean

Optional

false / true

if true collector will fetch data from endpoint /statistics/dmarc/senders/{sender}

<include_sender_ip_address_data>

boolean

Optional

false / true

if true collector will fetch data from endpoint /statistics/dmarc/senders/{sender}/ip-addresses

<include_ip_address_source>

boolean

Optional

false / true

if true collector will fetch data from endpoint /statistics/dmarc/ip-addresses/{source}

<include_total_group_data>

boolean

Optional

false / true

if true collector will fetch data from endpoint /statistics/dmarc/volume/totals/grouped/{grouping}

<include_bimi_selector_data>

boolean

Optional

false / true

if true collector will fetch data from endpoint /bimi-selectors/{bimiSelector}

<include_public_key_data>

boolean

Optional

false / true

if true collector will fetch data from endpoint /dkim-public-keys/{dkimPublicKey}

<include_ip_address_aggregate_records>

boolean

Optional

false / true

if true collector will fetch data from endpoint /statistics/dmarc/ip-addresses/{source}/aggregate-report-records

<group_values>

array

Optional/Mandatory

Minimum Length 1

Array of available group_values. ex:- ["country"] . This field will be mandatory if include_total_group_data is true

<override_devo_sender_tag>

str

Optional

A devo tag

It will override the devo tag for the endpoint statistics/dmarc/senders/{sender}

<override_devo_sender_ip_address_tag>

str

Optional

A devo tag

It will override the devo tag for the endpoint /statistics/dmarc/senders/{sender}/ip-addresses

<override_devo_ip_address_source_tag>

str

Optional

A devo tag

It will override the devo tag for the endpoint /statistics/dmarc/ip-addresses/{source}

<override_devo_ip_address_aggregate_tag>

str

Optional

A devo tag

It will override the devo tag for the endpoint /statistics/dmarc/ip-addresses/{source}/aggregate-report-records

<override_devo_bimi_selector_tag>

str

Optional

A devo tag

It will override the devo tag for the endpoint /bimi-selectors/{bimiSelector}

<override_devo_public_key_tag>

str

Optional

A devo tag

It will override the devo tag for the endpoint /dkim-public-keys/{dkimPublicKey}

<override_devo_total_group_tag>

str

Optional

A devo tag

It will override the devo tag for the endpoint /statistics/dmarc/volume/totals/grouped/{grouping}

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:

Collector Docker image

SHA-256 hash

collector-sendmarc_if-docker-image-1.0.1

b595b80836bf93c78291d4bce965671ee2832f8337467a5811cb76c8cf40a68f

Use the following command to add the Docker image to the system:

Code Block
gunzip -c <image_file>-<version>.tgz | docker load
Note

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

Code Block
docker run 
--name collector-<product_name> 
--volume $PWD/certs:/devo-collector/certs 
--volume $PWD/config:/devo-collector/config 
--volume $PWD/state:/devo-collector/state 
--env CONFIG_FILE=config.yaml 
--rm 
--interactive 
--tty 
<image_name>:<version>

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.

Code Block
version: '3'
services:
 collector-<product_name>:
   image: <image_name>:${IMAGE_VERSION:-latest}
   container_name: collector-<product_name>
   restart: always
   volumes:
     - ./certs:/devo-collector/certs
     - ./config:/devo-collector/config
     - ./credentials:/devo-collector/credentials
     - ./state:/devo-collector/state
   environment:
     - CONFIG_FILE=${CONFIG_FILE:-config.yaml}

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.

Expand
titleCommon setup output for all the services
Code Block
2024-10-22T18:40:34.001    INFO MainProcess::MainThread -> Started all objects from "MainProcess" process
2024-10-22T18:40:34.003    INFO InputProcess::MainThread -> Process started (pid=23008, ppid=22978, multiprocessing.start_method="fork")
2024-10-22T18:40:34.022    INFO InputProcess::MainThread -> SendMarcBasePuller(sendmarc#123451,senders#predefined) -> [PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-sendmarc/state/not_used/sendmarc;123451;senders;predefined;SendMarcBasePuller.json
2024-10-22T18:40:34.023    INFO InputProcess::MainThread -> SendMarcBasePuller(sendmarc#123451,senders#predefined) -> [PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated
2024-10-22T18:40:34.023    INFO InputProcess::MainThread -> SendMarcBasePuller(sendmarc#123451,senders#predefined) -> [PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 2), filename_path: "/home/md_tausif/gitlab/devo-collector-sendmarc/state/330ed6ca6825ea26199bf8f0161f15e6"
2024-10-22T18:40:34.023    INFO InputProcess::MainThread -> SendMarcBasePuller(sendmarc#123451,senders#predefined) -> [PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-sendmarc/state/4ec2dbb861d0d8af5fa1fa3cc3d224f2"
2024-10-22T18:40:34.023    INFO InputProcess::MainThread -> SendMarcBasePuller(sendmarc#123451,senders#predefined) -> [PERSISTENCE_SYSTEM] Checking if old persisted data must be removed
2024-10-22T18:40:34.023    INFO InputProcess::MainThread -> SendMarcBasePuller(sendmarc#123451,senders#predefined) -> [PERSISTENCE_SYSTEM] No previous persistence file exists (Version 2), filename_path: "/home/md_tausif/gitlab/devo-collector-sendmarc/state/330ed6ca6825ea26199bf8f0161f15e6"
2024-10-22T18:40:34.023    INFO InputProcess::MainThread -> SendMarcBasePuller(sendmarc#123451,senders#predefined) -> [PERSISTENCE_SYSTEM] No previous persistence file exists (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-sendmarc/state/4ec2dbb861d0d8af5fa1fa3cc3d224f2"
2024-10-22T18:40:34.024    INFO InputProcess::MainThread -> SendMarcBasePuller(sendmarc#123451,senders#predefined) Starting the execution of init_variables()
2024-10-22T18:40:34.024    INFO InputProcess::MainThread -> Validating service metadata
2024-10-22T18:40:34.026    INFO InputProcess::MainThread -> Validating defined module definition
2024-10-22T18:40:34.031    INFO InputProcess::MainThread -> Validating common input config
2024-10-22T18:40:34.033    INFO InputProcess::MainThread -> Validating service input config
2024-10-22T18:40:34.035    INFO InputProcess::MainThread -> Running overriding rules
2024-10-22T18:40:34.035    INFO InputProcess::MainThread -> Validating the rate limiter config given by the user
2024-10-22T18:40:34.035    INFO InputProcess::MainThread -> <requests_limits> setting has not been defined. The generic settings will be used instead.
2024-10-22T18:40:34.036    INFO InputProcess::MainThread -> Adding raw config to the collector store
2024-10-22T18:40:34.036    INFO InputProcess::MainThread -> Running custom validation rules
2024-10-22T18:40:34.036    INFO InputProcess::MainThread -> SendMarcBasePuller(sendmarc#123451,senders#predefined) Finalizing the execution of init_variables()
2024-10-22T18:40:34.037    INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-sendmarc/state/not_used/DevoSenderManager;standard_senders;devo_1.json.gz
2024-10-22T18:40:34.037    INFO InputProcess::MainThread -> InputThread(sendmarc,123451) - Starting thread (execution_period=60s)
2024-10-22T18:40:34.037    INFO InputProcess::MainThread -> ServiceThread(sendmarc,123451,senders,predefined) - Starting thread (execution_period=60s)
2024-10-22T18:40:34.038    INFO InputProcess::MainThread -> SendMarcPullerSetup(sendmarc,sendmarc#123451,senders#predefined) -> Starting thread
2024-10-22T18:40:34.038    INFO InputProcess::MainThread -> SendMarcBasePuller(sendmarc#123451,senders#predefined) - Starting thread
2024-10-22T18:40:34.038 WARNING InputProcess::SendMarcPullerSetup(sendmarc,sendmarc#123451,senders#predefined) -> The token/header/authentication has not been created yet
2024-10-22T18:40:34.038    INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated
2024-10-22T18:40:34.038    INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-sendmarc/state/5bdbabbd30e1988d6e2b0b74b6ec3289"
2024-10-22T18:40:34.038 WARNING InputProcess::SendMarcBasePuller(sendmarc#123451,senders#predefined) -> Waiting until setup will be executed
2024-10-22T18:40:34.041    INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-sendmarc/state/not_used/DevoSender;standard_senders;devo_sender_0.json.gz
2024-10-22T18:40:34.043    INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated
2024-10-22T18:40:34.043    INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-sendmarc/state/b1ee30ea2c4b3be1eb50c8b2ca80d8d8"
2024-10-22T18:40:34.045    INFO OutputProcess::MainThread -> OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-sendmarc/state/not_used/OutputStandardConsumer;standard_senders;0.json.gz
2024-10-22T18:40:34.046    INFO OutputProcess::MainThread -> OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated
2024-10-22T18:40:34.046    INFO OutputProcess::MainThread -> OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-sendmarc/state/de28663278a264d05d531fbc1db51a93"
2024-10-22T18:40:34.047    INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-sendmarc/state/not_used/DevoSenderManager;lookup_senders;devo_1.json.gz
2024-10-22T18:40:34.048    INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] There is no data persisted with the latest format, any previous persisted data will be migrated
2024-10-22T18:40:34.048    INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] No previous persistence file exists to migrate (Version 1), filename_path: "/home/md_tausif/gitlab/devo-collector-sendmarc/state/a28c135f3fc69ece87d8fc2fdb029e8c"
2024-10-22T18:40:34.051    INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-sendmarc/state/not_used/DevoSender;lookup_senders;devo_sender_0.json.gz
2024-10-22T18:40:34.052    INFO InputProcess::MainThread -> [GC] global: 30.2% -> 30.3%, process: RSS(42.00MiB -> 42.00MiB), VMS(424.98MiB -> 424.98MiB)
2024-10-22T18:40:34.053    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-10-22T18:40:34.053    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-sendmarc/state/df8895fef2a509cbd87fcc9850dc0c81"
2024-10-22T18:40:34.054    INFO OutputProcess::MainThread -> OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-sendmarc/state/not_used/OutputLookupConsumer;lookup_senders;0.json.gz
2024-10-22T18:40:34.055    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-10-22T18:40:34.055    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-sendmarc/state/865a79c1b99ad39b22becc235c9732cb"
2024-10-22T18:40:34.057    INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-sendmarc/state/not_used/DevoSenderManager;internal_senders;devo_1.json.gz
2024-10-22T18:40:34.057    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-10-22T18:40:34.057    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-sendmarc/state/e784c94a6fe28de5937e50674407d82e"
2024-10-22T18:40:34.059    INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-sendmarc/state/not_used/DevoSender;internal_senders;devo_sender_0.json.gz
2024-10-22T18:40:34.059    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-10-22T18:40:34.059    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-sendmarc/state/4ff7b345dc444ac050cf75f93e5dcb3b"
2024-10-22T18:40:34.060    INFO OutputProcess::MainThread -> OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-sendmarc/state/not_used/OutputInternalConsumer;internal_senders;0.json.gz
2024-10-22T18:40:34.060    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-10-22T18:40:34.060    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-sendmarc/state/10dd360c86621afd5a28a029a0dddcf6"
2024-10-22T18:40:34.061    INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread
2024-10-22T18:40:34.061    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 300 seconds)
2024-10-22T18:40:34.061    INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread
2024-10-22T18:40:34.061    INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-10-22T18:40:34.061    INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-10-22T18:40:34.061    INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> Starting thread
2024-10-22T18:40:34.062    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(lookup_senders,devo_1) -> Starting thread (every 300 seconds)
2024-10-22T18:40:34.062    INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> Starting thread
2024-10-22T18:40:34.062    INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-10-22T18:40:34.062    INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-10-22T18:40:34.062    INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread
2024-10-22T18:40:34.063    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_1) -> Starting thread (every 300 seconds)
2024-10-22T18:40:34.063    INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-10-22T18:40:34.063    INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00
2024-10-22T18:40:34.063    INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> Starting thread
2024-10-22T18:40:34.063    INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-10-22T18:40:34.064    INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-10-22T18:40:34.064    INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00
2024-10-22T18:40:34.064    INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-10-22T18:40:34.064    INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-10-22T18:40:34.064    INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00
2024-10-22T18:40:34.076    INFO OutputProcess::MainThread -> [GC] global: 30.3% -> 30.3%, process: RSS(41.60MiB -> 41.72MiB), VMS(929.25MiB -> 929.25MiB)
2024-10-22T18:40:34.076    INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-10-22T18:40:34.076    INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.01
2024-10-22T18:40:34.076    INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-10-22T18:40:34.076    INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.01
2024-10-22T18:40:34.077    INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-10-22T18:40:34.077    INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.01
2024-10-22T18:40:34.586    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-sendmarc/certs/chain.crt", "cert_path": "/home/md_tausif/gitlab/devo-collector-sendmarc/certs/int-if-integrations-india.crt", "key_path": "/home/md_tausif/gitlab/devo-collector-sendmarc/certs/int-if-integrations-india.key", "transport_layer_type": "SSL", "last_usage_timestamp": null, "socket_status": null}, hostname: "2023-apac-0046", session_id: "138689817995632"
2024-10-22T18:40:34.586    INFO OutputProcess::DevoSender(internal_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-10-22T18:40:36.701    INFO InputProcess::SendMarcPullerSetup(sendmarc,sendmarc#123451,senders#predefined) -> Setup for module <SendMarcBasePuller> has been successfully executed
Expand
titleSenders

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.

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

Code Block
2024-10-22T14:30:29.692    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,senders#predefined) -> Pull Started
2024-10-22T14:31:12.831    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,senders#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1729587629690):Number of requests made: 1; Number of events received: 19; Number of duplicated events filtered out: 0; Number of events generated and sent: 19; Average of events per second: 0.440.
2024-10-22T14:31:12.831    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,senders#predefined) -> Sent 19 events to Devo for account: <account> and domain: <domain>

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

Code Block
2024-10-22T14:31:12.831    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,senders#predefined) -> Statistics for t
Expand
titleip_address

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

Code Block
2024-10-22T14:30:30.696    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,ip_address#predefined) -> Pull Started
2024-10-22T14:32:50.646    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,ip_address#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1729587630693):Number of requests made: 1; Number of events received: 42; Number of duplicated events filtered out: 0; Number of events generated and sent: 42; Average of events per second: 0.300.
2024-10-22T14:32:50.646    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,ip_address#predefined) -> Sent 42 events to Devo for account: <account> and domain: <domain>

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

Code Block
2024-10-22T14:32:50.646    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,ip_address#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1729587630693):Number of requests made: 1; Number of events received: 42; Number of duplicated events filtered out: 0; Number of events generated and sent: 42; Average of events per second: 0.300.
Expand
titlests_settings

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

Code Block
2024-10-22T14:30:30.701    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,sts_settings#predefined) -> Pull Started
2024-10-22T14:30:33.663    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,sts_settings#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1729587630696):Number of requests made: 3; Number of events received: 30; Number of duplicated events filtered out: 0; Number of events generated and sent: 30; Average of events per second: 10.130.
2024-10-22T14:30:33.663    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,sts_settings#predefined) -> Sent 10 events to Devo for account: <account> and domain: <domain>

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

Code Block
2024-10-22T14:30:33.663    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,sts_settings#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1729587630696):Number of requests made: 3; Number of events received: 30; Number of duplicated events filtered out: 0; Number of events generated and sent: 30; Average of events per second: 10.130.
Expand
titlespf_settings

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

Code Block
2024-10-22T14:30:29.697    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,spf_settings#predefined) -> Pull Started
2024-10-22T14:30:31.708    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,spf_settings#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1729587629695):Number of requests made: 2; Number of events received: 22; Number of duplicated events filtered out: 0; Number of events generated and sent: 22; Average of events per second: 10.942.
2024-10-22T14:30:31.708    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,spf_settings#predefined) -> Sent 11 events to Devo for account: <account> and domain: <domain>
Code Block
2024-10-22T14:30:31.708    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,spf_settings#predefined) -> Statistic
Expand
titledmarc_settings

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

Code Block
2024-10-22T14:30:30.699    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,dmarc_settings#predefined) -> Pull Started
2024-10-22T14:30:31.665    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,dmarc_settings#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1729587630701):Number of requests made: 1; Number of events received: 7; Number of duplicated events filtered out: 0; Number of events generated and sent: 7; Average of events per second: 7.303.
2024-10-22T14:30:31.665    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,dmarc_settings#predefined) -> Sent 7 events to Devo for account: <account> and domain: <domain>

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

Code Block
2024-10-22T14:30:31.665    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,dmarc_settings#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1729587630701):Number of requests made: 1; Number of events received: 7; Number of duplicated events filtered out: 0; Number of events generated and sent: 7; Average of events per second: 7.303.
Expand
titledomains_bimi

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

Code Block
2024-10-22T14:30:30.705    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,domains_bimi#predefined) -> Pull Started
2024-10-22T14:30:31.674    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,domains_bimi#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1729587630701):Number of requests made: 1; Number of events received: 0; Number of duplicated events filtered out: 0; Number of events generated and sent: 0; Average of events per second: 0.000.
2024-10-22T14:30:31.675    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,domains_bimi#predefined) -> Sent 0 events to Devo for account: <account> and domain: <domain>

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

Code Block
2024-10-22T14:30:31.674    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,domains_bimi#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1729587630701):Number of requests made: 1; Number of events received: 0; Number of duplicated events filtered out: 0; Number of events generated and sent: 0; Average of events per second: 0.000.
Expand
titledomains_dkim

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

Code Block
2024-10-22T14:30:30.704    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,domains_dkim#predefined) -> Pull Started
2024-10-22T14:30:33.673    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,domains_bimi#predefined) -> Data collection completed. Elapsed time: 2.972 seconds. Waiting for 86397.028 second(s) until the next one
2024-10-22T14:30:34.428    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,domains_dkim#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1729587630699):Number of requests made: 1; Number of events received: 3; Number of duplicated events filtered out: 0; Number of events generated and sent: 3; Average of events per second: 0.806.

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

Code Block
2024-10-22T14:30:34.428    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,domains_dkim#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1729587630699):Number of requests made: 1; Number of events received: 3; Number of duplicated events filtered out: 0; Number of events generated and sent: 3; Average of events per second: 0.806.
Expand
titledmarc_volume_total

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

Code Block
2024-10-22T14:30:29.716    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,dmarc_volume_total#predefined) -> Pull Started
2024-10-22T14:30:32.672    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,dmarc_volume_total#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1729587629713):Number of requests made: 3; Number of events received: 27; Number of duplicated events filtered out: 0; Number of events generated and sent: 27; Average of events per second: 9.136.
2024-10-22T14:30:32.672    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,dmarc_volume_total#predefined) -> Sent 27 events to Devo for account: <account> and domain: <domain>

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

Code Block
2024-10-22T14:30:32.672    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,dmarc_volume_total#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1729587629713):Number of requests made: 3; Number of events received: 27; Number of duplicated events filtered out: 0; Number of events generated and sent: 27; Average of events per second: 9.136.
Expand
titledmarc_volume_timeline

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

Code Block
2024-10-22T14:30:30.706    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,dmarc_volume_timeline#predefined) -> Pull Started
2024-10-22T14:30:31.665    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,dmarc_volume_timeline#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1729587630701):Number of requests made: 1; Number of events received: 7; Number of duplicated events filtered out: 0; Number of events generated and sent: 7; Average of events per second: 7.303.
2024-10-22T14:30:31.665    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,dmarc_volume_timeline#predefined) -> Sent 7 events to Devo for account: <account> and domain: <domain>

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

Code Block
2024-10-22T14:30:31.665    INFO InputProcess::SendMarcBasePuller(sendmarc#123451,dmarc_volume_timeline#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1729587630701):Number of requests made: 1; Number of events received: 7; Number of duplicated events filtered out: 0; Number of events generated and sent: 7; Average of events per second: 7.303.
Expand
titleRestart 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:

  1. Edit the configuration file.

  2. Change the value of the request_period_in_seconds parameter to a different one.

  3. Save the changes.

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

Expand
titleTroubleshooting

Error Type

Error Id

Error Message

Cause

Solution

SetupError

100

HTTP Error occurred while checking the server health for sendmarc: {error message}

Credentials error {unauthorized} or mismatch b/w credentials or Sendmarc server error

Check the credentials or contact developer with required message

101

Some error occurred while checking the server health for sendmarc. Error detailsl {e}.

Error on the Sendmarc server.

Contact the developer with exact error message.

102

HTTP Error occurred while checking the server health for sendmarc: {error message}

Error occurred while fetching the domains

Contact the developer with exact error message

103

Some error occurred while checking the server health for sendmarc. Error detailsl {e}

Exception while making the API request

Contact the developer with exact error message

104

HTTP Error occurred while checking the server health for sendmarc: {error message}

Error while checking the accounts

Contact the developer with exact error message

105

Some error occurred while checking the server health for sendmarc. Error detailsl {e}

Exception while making the API request

Contact the developer with exact error message

PullError

300

Error related to HTTP, occurred while retrieving events from Sendmarc 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.

301

Error while checking the server health for sendmarc. Error: {details}

Some exceptions occurred while making the API request.

Contact the developer with exact error message.

302

HTTP Error occurred while checking the server health for sendmarc: {error message}

Error while fetching sender_ip_address data

Get the HTTP error code and contact the developer

303

Some error occurred while checking the server health for sendmarc. 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.

304

HTTP Error occurred while checking the server health for sendmarc: {error message}

Error while fetching sender_data data

Contact the developer with required message

305

Some error occurred while checking the server health for sendmarc. Error details {e}

Some exceptions occurred while making the API request.

Contact the developer with required message

306

HTTP Error occurred while checking the server health for sendmarc {error message}

Error while fetching data from server for source_ip_address

Contact the developer with required message

307

Some error occurred while checking the server health for sendmarc. Error details {e}

Exceptions while making the API request.

Contact the developer with required message

308

HTTP Error occurred while checking the server health for sendmarc {error message}

This error happens when the collector tries to fetch the data from API

Contact the developer with required message

309

Some error occurred while checking the server health for sendmarc. Error details {e}

Some exceptions occurred while making the API request.

Contact the developer with required message

310

HTTP Error occurred while checking the server health for sendmarc {error message}

Error while fetching the data

Contact the developer with required message

311

Some error occurred while checking the server health for sendmarc. Error details {e}

Some exceptions occurred while making the API request

Contact the developer with required message

312

HTTP Error occurred while checking the server health for sendmarc {error message}

Exception while making the API request for DKIM data

Contact the developer with required message

313

Some error occurred while checking the server health for sendmarc. Error details {e}

Error while fetching making the API request

Contact the developer with required message

314

HTTP Error occurred while checking the server health for sendmarc {error message}

Exception while making the API request for bimi data

Contact the developer with required message

315

Some error occurred while checking the server health for sendmarc. Error details {e}

Some exceptions occurred while making the API request

Contact the developer with required message

Collector operations

Expand
titleVerifying 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:

Code Block
2024-10-22T15:01:19.538    INFO InputProcess::MainThread -> SendMarcBasePuller(sendmarc#123451,senders#predefined) Starting the execution of init_variables()
2024-10-22T15:01:19.538    INFO InputProcess::MainThread -> Validating service metadata
2024-10-22T15:01:19.539    INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-sendmarc/state/not_used/DevoSender;lookup_senders;devo_sender_0.json.gz
2024-10-22T15:01:19.540    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-10-22T15:01:19.540    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-sendmarc/state/df8895fef2a509cbd87fcc9850dc0c81"
2024-10-22T15:01:19.540    INFO OutputProcess::MainThread -> OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-sendmarc/state/not_used/OutputLookupConsumer;lookup_senders;0.json.gz
2024-10-22T15:01:19.540    INFO InputProcess::MainThread -> Validating defined module definition
2024-10-22T15:01:19.541    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-10-22T15:01:19.541    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-sendmarc/state/865a79c1b99ad39b22becc235c9732cb"
2024-10-22T15:01:19.541    INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-sendmarc/state/not_used/DevoSenderManager;internal_senders;devo_1.json.gz
2024-10-22T15:01:19.542    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-10-22T15:01:19.542    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-sendmarc/state/e784c94a6fe28de5937e50674407d82e"
2024-10-22T15:01:19.543    INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-sendmarc/state/not_used/DevoSender;internal_senders;devo_sender_0.json.gz
2024-10-22T15:01:19.544    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-10-22T15:01:19.544    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-sendmarc/state/4ff7b345dc444ac050cf75f93e5dcb3b"
2024-10-22T15:01:19.544    INFO OutputProcess::MainThread -> OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Created persistence instance, filename_path: /home/md_tausif/gitlab/devo-collector-sendmarc/state/not_used/OutputInternalConsumer;internal_senders;0.json.gz
2024-10-22T15:01:19.545    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-10-22T15:01:19.545    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-sendmarc/state/10dd360c86621afd5a28a029a0dddcf6"
2024-10-22T15:01:19.545    INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread
2024-10-22T15:01:19.545    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 300 seconds)
2024-10-22T15:01:19.545    INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread
2024-10-22T15:01:19.545    INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-10-22T15:01:19.545    INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-10-22T15:01:19.546    INFO InputProcess::MainThread -> Validating common input config
2024-10-22T15:01:19.546    INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> Starting thread
2024-10-22T15:01:19.546    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(lookup_senders,devo_1) -> Starting thread (every 300 seconds)
2024-10-22T15:01:19.546    INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> Starting thread
2024-10-22T15:01:19.546    INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-10-22T15:01:19.546    INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-10-22T15:01:19.547    INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread
2024-10-22T15:01:19.547    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_1) -> Starting thread (every 300 seconds)
2024-10-22T15:01:19.547    INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> Starting thread
2024-10-22T15:01:19.547    INFO InputProcess::MainThread -> Validating service input config
2024-10-22T15:01:19.547    INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-10-22T15:01:19.548    INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-10-22T15:01:19.548    INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00
2024-10-22T15:01:19.548    INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-10-22T15:01:19.548    INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-10-22T15:01:19.548    INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.00
2024-10-22T15:01:19.549    INFO InputProcess::MainThread -> Running overriding rules
2024-10-22T15:01:19.549    INFO InputProcess::MainThread -> Overriding rule #1 - service key <override_devo_tag> with value <my.app.sendmarc_devo.tag> overrides definition key <devo_tag> with value <None> when the first is not <None>
2024-10-22T15:01:19.549    INFO InputProcess::MainThread -> Overriding rule #2 - service key <override_devo_sender_tag> with value <my.app.sendmarc_sender.tag> overrides definition key <devo_sender_tag> with value <None> when the first is not <None>
2024-10-22T15:01:19.550    INFO InputProcess::MainThread -> Overriding rule #3 - service key <override_devo_sender_ip_address_tag> with value <my.app.sendmarc_sender_ip.tag> overrides definition key <devo_sender_ip_address_tag> with value <None> when the first is not <None>
2024-10-22T15:01:19.550    INFO InputProcess::MainThread -> Validating the rate limiter config given by the user
2024-10-22T15:01:19.550    INFO InputProcess::MainThread -> <requests_limits> setting has not been defined. The generic settings will be used instead.
2024-10-22T15:01:19.550    INFO InputProcess::MainThread -> Adding raw config to the collector store
2024-10-22T15:01:19.550    INFO InputProcess::MainThread -> Running custom validation rules
2024-10-22T15:01:19.551    INFO InputProcess::MainThread -> SendMarcBasePuller(sendmarc#123451,senders#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:

Code Block
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 sender 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-10-22 09:00:26.589348+00:00": 0 (elapsed 0.000 seconds)

Displays the number of events from the last time the collector executed the pull logic. 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 2024-10-22 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.

Expand
titleCheck 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

Code Block
2024-10-22T14:33:26.704    INFO InputProcess::MainThread -> [GC] global: 27.6% -> 27.6%, process: RSS(50.77MiB -> 50.77MiB), VMS(2.10GiB -> 2.10GiB)
2024-10-22T14:34:26.634    INFO OutputProcess::MainThread -> [GC] global: 27.7% -> 27.7%, process: RSS(45.96MiB -> 45.96MiB), VMS(929.64MiB -> 929.64MiB)

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

Recommendations

v1.0.1

Status
colourYellow
titlebug fixing

Recommended version

Expand
titleDetails

Bug Fixes

  • Added `inputs` to example_params to resolve the bug

v1.0.0

Status
colourPurple
titlenew feature

-