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

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

...

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

...

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

...

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.

301

Error while checking the server health for sendmarc. Error: { details}Some exceptions occurred while making the API request.

Contact the developer with required message

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

...

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.

1

0

Status
colourPurple
titlenew feature

-