---
title: "SailPoint IdentityNow collector"
canonical: "https://docs.devo.com/space/latest/281575425/SailPoint%20IdentityNow%20collector"
format: markdown
---
> Macro (toc)

## Overview

**SailPoint IdentityNow** is an identity management solution that helps organizations manage employees' permission, digital identities, information security, data access compliance, and more on a unified portal.

## Devo collector features

| **Feature** | **Details** |
| --- | --- |
| Allow parallel downloading (`multipod`) | `Not allowed` |
| Running environments | `Collector server`<br>`On-premise` |
| Populated Devo events | `Table` |
| Flattening preprocessing | `Yes` |

## Data sources

| **Data Source** | **Description** | **API Endpoint** | **Collector service name** | **Devo Table** | **Available from release** |
| --- | --- | --- | --- | --- | --- |
| Account activities | Account activities entries | `/v3/account-activities` | `account_activities` | `iam.sailpoint.identitynow.account_activity` | `v1.0.0` |
| Events | Event related to management console | `/v3/search` | `events` | `iam.sailpoint.identitynow.event` | `v1.0.0` |

For more information on how the events are parsed, [visit our page](https://devodocs.atlassian.net/wiki/spaces/latest/pages/281182295).

## Flattening preprocessing

| **Data source** | **Collector service** | **Optional** | **Flattening details** |
| --- | --- | --- | --- |
| Account activities | account_activities | `No` | Account activities are flattened on the `items` list. |

## Accepted authentication methods

|  |  |  |
| --- | --- | --- |
| **Authentication method** | **Client ID** | **Secret** |
| `OAuth` | [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** |
| --- | --- |
| `base_url` | Base URL for SailPoint instance. |
| `client_id` | The `client_id` obtained from SailPoint for authentication. |
| `client_secret` | The `client_secret` obtained from SailPoint for authentication |

> ℹ️ See the **[Accepted authentication methods](#)** section to verify what settings are required based on the desired authentication method.

## Buffer Time Usage in Collector

The collector is configured to use a **10-minute buffer time** when fetching data. This is necessary because the API does not return incoming data in real time — there is a slight delay before the data becomes available through the API.

If we attempt to fetch data for the most recent 1-minute window, some logs may be missing due to this delay. To ensure data completeness and reliability, the collector instead fetches data that is at least 10 minutes old and sends that data to Devo.

## Vendor setup

There are some requirements to run this collector. In order to retrieve the data, you must configure a `Client_ID` and `Client Secret` for API access to the **SailPoint IdentityNow Portal**. Follow these steps to obtain an `access token`:

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Log into the [SailPoint console](https://id.sailpoint.com/signon/?flowId=005f55bd-aeef-491c-a33e-8cae13a25eb2) using an account with an Administrator role and permissions. 
> 
> > Macro (rw-step)
> 
> Select **Preferences** from the drop-down menu under your username, then** Personal Access Tokens** on the left. 
> 
> > ℹ️ **URL**
> > ℹ️ 
> > ℹ️ You can also use this URL `https://{tenant}.identitynow.com or https://{tenant}.identitynow.com/ui/d/user-preferences/personal-access-tokens`. and replace {`tenant`} with your IdentityNow tenant.
> 
> > Macro (rw-step)
> 
> Select **New Token** and enter a meaningful description to help differentiate the token from others. 
> 
> > ⚠️ **Important**
> > ⚠️ 
> > ⚠️ The **New Token button** will be disabled when you have reached the limit of 10 personal access tokens per user. To avoid reaching this limit, it is recommended you delete any tokens that are no longer needed.
> 
> > Macro (rw-step)
> 
> Select **New Token** and enter a meaningful description to help differentiate the token from others. 
> 
> > Macro (rw-step)
> 
> Select **Create Token** to generate and view the two components that comprise the token: the `Secret` and `Client_ID`. 
> 
> > ⚠️ **Important**
> > ⚠️ 
> > ⚠️ After you create the token, the value of the `Client_ID` will be visible in the **Personal Access Tokens list**, but the corresponding `Secret` will not be visible after you close the window. You will need to store the `Secret` somewhere secure.
> 
> > Macro (rw-step)
> 
> Copy both values somewhere that will be secure and accessible to you when you need to use the token. Select **Save**.

> Macro (anchor)



## 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 (<u>Cloud collector</u>), or deploy and host the collector in your own machine using a Docker image (<u>On-premise collector</u>).

> Macro (rw-ui-tabs-macro)
> 
> > Macro (rw-tab)
> 
> 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 **Parameters** section, establish the **Collector Parameters** as follows below:
> 
> ### Editing the JSON configuration
> 
> ```
> {
>   "global_overrides": {
>     "debug": <debug_status>
>   },
>   "inputs": {
>    "sailpoint": {
>       "id": "<short_unique_id>",
>       "enabled": <input_status>,
>       "base_url": "<base_url>",
>       "credentials": {
>         "client_id": "<client_id>",
>         "client_secret": "<client_secret>"
>       },   
>       "services": {
>         "events": {
>           "initial_start_time_in_utc": "<initial_start_time_in_utc>",
>           "request_period_in_seconds": "<request_period_in_seconds>",
>           "override_tag": "<override_tag_value>",
>           "override_client_page_limit": "<override_client_page_limit_value>"
>         },
>         "account_activities": {
>           "initial_start_time_in_utc": "<initial_start_time_in_utc>",
>           "request_period_in_seconds": "<request_period_in_seconds>",
>           "override_tag": "<override_tag_value>",
>           "override_client_page_limit": "<override_client_page_limit_value>"
> 
>         }
>       }
>     }
>   }
> }
> ```
> 
> > ℹ️ 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.
> 
> Please replace the placeholders with real world values following the description table below:
> 
> |  |  |  |  |  |
> | --- | --- | --- | --- | --- |
> | **Parameter** | **Data Type** | **Type** | **Value Range / Format** | **Details** |
> | `debug_status` | `bool` | `Mandatory` | `false` / `true` | If the value is `true`, the debug logging traces will be enabled when running the collector. If the value is `false`, only the `info`, `warning` and `error` logging levels will be printed. |
> | `short_unique_id` | `int` | `Mandatory` | `Minimum length: 5`<br>`Maximum length: 15` | Use this parameter to give a unique ID to this input service.<br>> ⚠️ 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` | `true / false` | If the value is `true`, the input definition will be executed. If the value is `false`, the service will be ignored. |
> | `base_url` | `str` | `Mandatory` | `Minimum length: 1` | Base URL for SailPoint instance. |
> | `client_secret` | `str` | `Mandatory` | `Minimum length: 1` | The `client_secret` obtained from SailPoint for authentication. |
> | `client_id` | `str` | `Mandatory` | `Minimum length: 1` | The `client_id` obtained from SailPoint for authentication. |
> | `initial_start_time_in_utc` | `str` | Optional | UTC datetime string | This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (one month back for example) before downloading new events.   
> **Format** `<yyyy-MM-dd'T'HH:mm:ss>` **Example:** `2025-04-22T05:28:55`   
> **At least 10 minutes older than the current UTC time**  
> **• Not older than 1 month from the current UTC time**<br>> ℹ️ This parameter should be removed if it is not used. |
> | `request_period_in_seconds_value` | `int` | `Optional` | `Minimum length: 1` | Period in seconds used between each data pulling. This value will overwrite the default value (60 seconds).<br>> ℹ️ This parameter can be removed or commented. |
> | `override_tag_value` | `str` | `Optional` | A devo tag | This parameter allows defining a custom devo tag. |
> | `override_client_page_limit` | `int` | `Optional` | `Minimum length: 1` | This parameter allows defining a custom per page limit. Default limit for event service: 10000 and default limit for account_activities service: 250 |
> 
> ![sailpoint.png](media://06c7b54b-e301-4e36-90f6-c1293f91e48b)
> 
> > Macro (rw-tab)
> 
> 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:
> 
> ```
> <any_directory>
> └── devo-collectors/
>     └── <product_name>/
>         ├── certs/
>         │   ├── chain.crt
>         │   ├── <your_domain>.key
>         │   └── <your_domain>.crt
>         ├── state/
>         └── config/ 
>             └── config.yaml 
> ```
> 
> > ⚠️ 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](media://adef493c-2ec1-4fdd-bcbc-06b4be180c85)
> 
> > ⚠️ Replace `<product_name>` with the proper value.
> 
> ### Editing the config.yaml file
> 
> ```
> globals:
>   debug: false
>   id: not_used
>   name: sailpoint_collector
>   persistence:
>     type: filesystem
>     config:
>       directory_name: state
> outputs:
>   devo_us_1:
>     type: devo_platform
>     config:
>       address: <devo_address>
>       port: 443
>       type: SSL
>       chain: <chain_filename>
>       cert: <cert_filename>
>       key: <key_filename>
> inputs:
>   sailpoint:
>     id: <short_unique_id>
>     enabled: <input_status>
>     base_url: <base_url>
>     credentials:
>       client_secret: <client_secret>
>       client_id: <client_id>
>     services:
>       events:
>         initial_start_time_in_utc: <initial_start_time_in_utc>
>         request_period_in_seconds: <request_period_in_seconds_value>
>         override_tag: <override_tag_value>
>         override_client_page_limit: <override_client_page_limit_value>
>       account_activities:
>         initial_start_time_in_utc: <initial_start_time_in_utc>
>         request_period_in_seconds: <request_period_in_seconds_value>
>         override_tag: <override_tag_value>
>         override_client_page_limit: <override_client_page_limit_value>
> ```
> 
> > ℹ️ 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** |
> | --- | --- | --- | --- | --- |
> | `devo_address` | `str` | `mandatory` | `collector-us.devo.io `<br>`collector-eu.devo.io ` | Use this parameter to identify the Devo Cloud where the events will be sent. |
> | `chain_filename` | `str` | `mandatory` | `minimum length: 4`<br>`maximum length: 20` | Use this parameter to identify the chain.cert file downloaded from your Devo domain. Usually this file's name is: `chain.crt`. |
> | `cert_filename` | `str` | `mandatory` | `minimum length: 4`<br>`maximum length: 20` | Use this parameter to identify the file.cert downloaded from your Devo domain. |
> | `key_filename` | `str` | `mandatory` | `minimum length: 4`<br>`maximum length: 20` | Use this parameter to identify the file.key downloaded from your Devo domain. |
> | `short_unique_id` | `int` | `Mandatory` | `Minimum length: 5`<br>`Maximum length: 15` | Use this parameter to give a unique ID to this input service.<br>> ⚠️ 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` | `true / false` | If the value is `true`, the input definition will be executed. If the value is `false`, the service will be ignored. |
> | `base_url` | `str` | `Mandatory` | `Minimum length: 1` | Base URL for SailPoint instance. |
> | `client_secret` | `str` | `Mandatory` | `Minimum length: 1` | The `client_secret` obtained from SailPoint for authentication. |
> | `client_id` | `str` | `Mandatory` | `Minimum length: 1` | The `client_id` obtained from SailPoint for authentication. |
> | `initial_start_time_in_utc` | `str` | Optional | UTC datetime string | This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (one month back for example) before downloading new events.   
> **Format** `<yyyy-MM-dd'T'HH:mm:ss>` **Example:** `2025-04-22T05:28:55`   
> **At least 10 minutes older than the current UTC time**<br>- **Not older than 1 month from the current UTC time**<br>> ℹ️ This parameter should be removed if it is not used. |
> | `request_period_in_seconds_value` | `int` | `Optional` | `Minimum length: 1` | Period in seconds used between each data pulling. This value will overwrite the default value (60 seconds).<br>> ℹ️ This parameter can be removed or commented. |
> | `override_tag_value` | `str` | `Optional` | A devo tag | This parameter allows defining a custom devo tag. |
> | `override_client_page_limit` | `int` | `Optional` | `Minimum length: 1` | This parameter allows defining a custom per page limit. Default limit for event service: 10000 and default limit for account_activities service: 250 |
> 
> ### 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-sailpoint_identitynow_if-docker-image-1.1.1](https://drive.google.com/file/d/1gM2_QiptnRwCG7_4Kv211cYQR_5hpTGW/view?usp=drive_link) | `7d0b62a5e24808ce43867eacb00b61be9685ce45d924a5268036c384f7623863` |
> 
> Use the following command to add the Docker image to the system:
> 
> ```
> gunzip -c <image_file>-<version>.tgz | docker load
> ```
> 
> > ⚠️ 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>/`
> 
> ```
> 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 
> --restart=always 
> --interactive 
> --tty 
> <image_name>:<version>
> ```
> 
> > ⚠️ Replace `<product_name>`, `<image_name>` and `<version>` with the proper values.
> 
> #### 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.
> 
> ```
> version: '3'
> services:
>   collector-<product_name>:
>     image: <image_name>:${IMAGE_VERSION:-latest}
>     container_name: collector-<product_name>
>     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:
> 
> ```
> IMAGE_VERSION=<version> docker-compose up -d
> ```
> 
> > ⚠️ 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.

### Account activities

<details>
<summary>Verify data collection</summary>

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

#### Setup output

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

```
INFO InputProcess::MainThread -> SailpointPullerSetup(unknown,sailpoint#111,account_activities#predefined) -> Starting thread
INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,account_activities#predefined) -> No API client found
INFO InputProcess::MainThread -> SailpointPuller(sailpoint,111,account_activities,predefined) - Starting thread
WARNING InputProcess::SailpointPullerSetup(unknown,sailpoint#111,account_activities#predefined) -> The token/header/authentication has not been created yet
WARNING InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Waiting until setup will be executed
INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,account_activities#predefined) -> Creating API client.
INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,account_activities#predefined) -> Client fetch method get_account_activities is valid for the given credentials.
INFO OutputProcess::ConsoleSender(standard_senders,console_sender_0) -> {"timestamp": "2023-02-08 13:41:12.721", "tag": "devo.collectors.out.local.info", "content": "{\"msg\": \"Client fetch method get_account_activities is valid for the given credentials.\", \"time\": \"2023-02-08T13:41:12.721867Z\", \"level\": \"info\", \"collector_name\": \"unknown\", \"collector_version\": \"unknown\", \"collector_image\": null, \"input_name\": \"sailpoint\", \"service_name\": \"account_activities\", \"module_name\": \"SailpointPuller\"}"}
INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,account_activities#predefined) -> Setup for module <SailpointPuller> has been successfully executed
```

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

```
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> SailpointPuller(sailpoint,111,account_activities,predefined) Starting the execution of pre_pull()
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Reading persisted data
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Data retrieved from the persistence: {'initial_start_time_in_utc': '2022-01-01T19:26:03.351000Z', 'last_event_time_in_utc': '2023-02-08T02:06:27.485000Z', 'last_ids': ['4014c5538cf74f7388cffb36dd2b8da9'], '@persistence_version': 1}
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Running the persistence upgrade steps
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Running the persistence corrections steps
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Running the persistence corrections steps
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Detected initial start time in UTC change: {'values_changed': {'root': {'new_value': '2023-01-01T19:26:03.351000Z', 'old_value': '2022-01-01T19:26:03.351000Z'}}}. Resetting state to {'initial_start_time_in_utc': '2023-01-01T19:26:03.351000Z', 'last_event_time_in_utc': '2023-01-01T19:26:03.351000Z', 'last_ids': [], '@persistence_version': 1}
WARNING InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Some changes have been detected and the persistence needs to be updated. Previous content: {'initial_start_time_in_utc': '2022-01-01T19:26:03.351000Z', 'last_event_time_in_utc': '2023-02-08T02:06:27.485000Z', 'last_ids': ['4014c5538cf74f7388cffb36dd2b8da9'], '@persistence_version': 1}. New content: {'initial_start_time_in_utc': '2023-01-01T19:26:03.351000Z', 'last_event_time_in_utc': '2023-01-01T19:26:03.351000Z', 'last_ids': [], '@persistence_version': 1}
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Updating the persistence
WARNING InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Persistence has been updated successfully
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> SailpointPuller(sailpoint,111,account_activities,predefined) Finalizing the execution of pre_pull()
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Starting data collection every 60 seconds
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Pull Started
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Retrieving/sending account_activities event(s) having created between 2023-01-01T19:26:03.351000+00:00 and 2023-02-08T13:50:47.042987+00:00
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Retrieved 250 account_activities event(s)
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Flattened 250 account_activities event(s) to 2463 event(s)
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Updating the persistence
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1675864247042):Number of requests made: 1; Number of events received: 250; Number of duplicated events filtered out: 0; Number of events generated and sent: 2463; Average of events per second: 913.145.
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1675864247042):Number of requests made: 3; Number of events received: 300; Number of duplicated events filtered out: 24; Number of events generated and sent: 2937; Average of events per second: 858.817.
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,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:

```
INFO InputProcess::SailpointPuller(sailpoint,111,account_activities,predefined) -> The data is up to date!
```

> ℹ️ The value `@devo_pulling_id` is injected in each event to group all events ingested by the same pull action. You can use it to get the exact events downloaded in that `Pull` action in Devo’s search window.
</details>

<details>
<summary>Restart the persistence</summary>

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 `initial_start_time_in_utc` 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.
</details>

<details>
<summary>Troubleshooting</summary>

This collector has different security layers that detect both an invalid configuration and abnormal operation. This table will help you detect and resolve the most common errors.

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| **Error type** | **Error ID** | **Error message** | **Cause** | **Solution** |
| `InitVariableError` | `1` | `datetime_format is not set in service thread globals.` | Datetime format string not in internal config. | Input datetime format string in service thread globals. |
| `InitVariableError` | `2` | `Datetime format "{datetime_format}" is invalid` | Datetime format string does not render a valid datetime. | Update internal definition file with appropriate datetime format. |
| `InitVariableError` | `3` | `Date {ini_start_time_str} is in the future` | The `initial_start_datetime_in_utc` is a future date. | Update config with appropriate `initial_start_datetime_in_utc `value. |
| `InitVariableError` | `4` | `request_retry_attempts is not set in service thread globals " "or module properties` | The `request_retry_attempts` parameter is not configured. | Set `request_retry_attempts` in the service thread globals or module properties of the definition file. |
| `InitVariableError` | `5` | `request_retry_attempts must be greater than or equal to 0` | The `request_retry_attempts` parameter is less than 0. | Set `request_retry_attempts` parameter to any integer greater than or equal to 0. |
| `InitVariableError` | `6` | `request_retry_attempts must be an integer` | The `request_retry_attempts` parameter must be an integer. | Set `request_retry_attempts` as an integer. |
| `InitVariableError` | `7` | `request_retry_delay_in_seconds is not set in service thread globals " "or module properties` | The `request_retry_delay_in_seconds `parameter is not configured. | Set `request_retry_delay_in_seconds` in the service thread globals or module properties of the definition file. |
| `InitVariableError` | `8` | `request_retry_delay_in_seconds must be greater than or equal to 0` | The `request_retry_delay_in_seconds` parameter is less than 0. | Set `request_retry_delay_in_seconds `parameter to any integer greater than or equal to 0. |
| `InitVariableError` | `9` | `request_retry_delay_in_seconds must be an integer` | The `request_retry_delay_in_seconds `parameter must be an integer. | Set `request_retry_delay_in_seconds`  as an integer. |
| `SetupError` | `101` | `Client fetch method is not valid` | The API wrapper is calling a non-existent API endpoint or lacks a fetch method for that endpoint. | Ensure the internal definition file has correct API endpoints. |
| `SetupError` | `102` | `HTTP Error while making request to Sailpoint API: {error message}` | During the setup test (querying the endpoint), SailPoint responded with an unexpected error. | Review the error message to determine failure. If result of outage, allow collector to attempt authentication during next poll. |
| `PullError` | `350` | `Failed to flatten event: {e} with key {by_key_path}. Exception: {e}` | The flattening method failed to flatten the indicated event. | Ensure that a correct flattening key is utilized for the event. |
</details>

### Events service

<details>
<summary>Verify data collection</summary>

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

#### Setup output

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

```
INFO InputProcess::MainThread -> SailpointPullerSetup(unknown,sailpoint#111,events#predefined) -> Starting thread
INFO InputProcess::MainThread -> SailpointPuller(sailpoint,111,events,predefined) - Starting thread
WARNING InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Waiting until setup will be executed
INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,events#predefined) -> No API client found
WARNING InputProcess::SailpointPullerSetup(unknown,sailpoint#111,events#predefined) -> The token/header/authentication has not been created yet
INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,events#predefined) -> Creating API client.
INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,events#predefined) -> Created request client: <agent.modules.sailpoint.commons.client.SailpointClient object at 0x107e14160>
INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,events#predefined) -> Testing client fetch method get_events...
INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,events#predefined) -> Client fetch method get_events is valid for the given credentials.
INFO InputProcess::SailpointPullerSetup(unknown,sailpoint#111,events#predefined) -> Setup for module <SailpointPuller> has been successfully executed
```

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

```
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> SailpointPuller(sailpoint,111,events,predefined) Starting the execution of pre_pull()
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Reading persisted data
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Data retrieved from the persistence: None
WARNING InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Persistence will be overridden due to the retrieved state is empty
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Running the persistence upgrade steps
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Running the persistence corrections steps
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Running the persistence corrections steps
WARNING InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Some changes have been detected and the persistence needs to be updated. Previous content: None. New content: {'initial_start_time_in_utc': '2023-01-20T19:26:03.351000Z', 'last_event_time_in_utc': '2023-01-20T19:26:03.351000Z', 'last_ids': []}
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Updating the persistence
WARNING InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Persistence has been updated successfully
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> SailpointPuller(sailpoint,111,events,predefined) Finalizing the execution of pre_pull()
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Starting data collection every 60 seconds
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Pull Started
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Retrieving/sending events event(s) having created between 2023-01-20T19:26:03.351000+00:00 and 2023-02-08T13:52:14.171138+00:00
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Retrieved 250 events event(s)
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Updating the persistence
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1675864334171):Number of requests made: 3; Number of events received: 599; Number of duplicated events filtered out: 2; Number of events generated and sent: 597; Average of events per second: 362.864.
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Retrieving/sending events event(s) having created between 2023-02-08T13:52:13.981000+00:00 and 2023-02-08T13:52:14.171138+00:00
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Retrieved 1 events event(s)
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> No events found after filtering. No further queries will be done.
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1675864334171):Number of requests made: 4; Number of events received: 600; Number of duplicated events filtered out: 3; Number of events generated and sent: 597; Average of events per second: 348.494.
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1675864334171):Number of requests made: 4; Number of events received: 600; Number of duplicated events filtered out: 3; Number of events generated and sent: 597; Average of events per second: 348.454.
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> The data is up to date!
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> Data collection completed. Elapsed time: 1.731 seconds. Waiting for 58.269 second(s) until the next one
```

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

```
INFO InputProcess::SailpointPuller(sailpoint,111,events,predefined) -> The data is up to date!
```

> ℹ️ The value `@devo_pulling_id` is injected in each event to group all events ingested by the same pull action. You can use it to get the exact events downloaded in that `Pull` action in Devo’s search window.
</details>

<details>
<summary>Restart the persistence</summary>

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 `initial_start_time_in_utc` 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.
</details>

<details>
<summary>Troubleshooting</summary>

This collector has different security layers that detect both an invalid configuration and abnormal operation. This table will help you detect and resolve the most common errors.

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| **Error type** | **Error ID** | **Error message** | **Cause** | **Solution** |
| `InitVariableError` | `1` | `datetime_format is not set in service thread globals.` | Datetime format string not in internal config. | Input datetime format string in service thread globals. |
| `InitVariableError` | `2` | `Datetime format "{datetime_format}" is invalid` | Datetime format string does not render a valid datetime. | Update internal definition file with appropriate datetime format. |
| `InitVariableError` | `3` | `Date {ini_start_time_str} is in the future` | The `initial_start_datetime_in_utc` is a future date. | Update config with appropriate `initial_start_datetime_in_utc `value. |
| `InitVariableError` | `4` | `request_retry_attempts is not set in service thread globals " "or module properties` | The `request_retry_attempts` parameter is not configured. | Set `request_retry_attempts` in the service thread globals or module properties of the definition file. |
| `InitVariableError` | `5` | `request_retry_attempts must be greater than or equal to 0` | The `request_retry_attempts` parameter is less than 0. | Set `request_retry_attempts` parameter to any integer greater than or equal to 0. |
| `InitVariableError` | `6` | `request_retry_attempts must be an integer` | The `request_retry_attempts` parameter must be an integer. | Set `request_retry_attempts` as an integer. |
| `InitVariableError` | `7` | `request_retry_delay_in_seconds is not set in service thread globals " "or module properties` | The `request_retry_delay_in_seconds `parameter is not configured. | Set `request_retry_delay_in_seconds` in the service thread globals or module properties of the definition file. |
| `InitVariableError` | `8` | `request_retry_delay_in_seconds must be greater than or equal to 0` | The `request_retry_delay_in_seconds` parameter is less than 0. | Set `request_retry_delay_in_seconds `parameter to any integer greater than or equal to 0. |
| `InitVariableError` | `9` | `request_retry_delay_in_seconds must be an integer` | The `request_retry_delay_in_seconds `parameter must be an integer. | Set `request_retry_delay_in_seconds`  as an integer. |
| `SetupError` | `101` | `Client fetch method is not valid` | The API wrapper is calling a non-existent API endpoint or lacks a fetch method for that endpoint. | Ensure the internal definition file has correct API endpoints. |
| `SetupError` | `102` | `HTTP Error while making request to Sailpoint API: {error message}` | During the setup test (querying the endpoint), SailPoint responded with an unexpected error. | Review the error message to determine failure. If result of outage, allow collector to attempt authentication during next poll. |
| `PullError` | `350` | `Failed to flatten event: {e} with key {by_key_path}. Exception: {e}` | The flattening method failed to flatten the indicated event. | Ensure that a correct flattening key is utilized for the event. |
</details>

## Collector operations

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

<details>
<summary>Verify collector operations</summary>

### Initialization

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

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

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

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

```
INFO OutputProcess::SyslogSenderManagerMonitor(standard_senders,sidecar_0) -> Number of available senders: 1, sender manager internal queue size: 0
INFO OutputProcess::SyslogSenderManagerMonitor(standard_senders,sidecar_0) -> enqueued_elapsed_times_in_seconds_stats: {}
INFO OutputProcess::SyslogSenderManagerMonitor(standard_senders,sidecar_0) -> Sender: SyslogSender(standard_senders,syslog_sender_0), status: {"internal_queue_size": 0, "is_connection_open": True}
INFO OutputProcess::SyslogSenderManagerMonitor(standard_senders,sidecar_0) -> Standard - Total number of messages sent: 44, messages sent since "2022-06-28 10:39:22.511671+00:00": 44 (elapsed 0.007 seconds)
INFO OutputProcess::SyslogSenderManagerMonitor(internal_senders,sidecar_0) -> Number of available senders: 1, sender manager internal queue size: 0
INFO OutputProcess::SyslogSenderManagerMonitor(internal_senders,sidecar_0) -> enqueued_elapsed_times_in_seconds_stats: {}
INFO OutputProcess::SyslogSenderManagerMonitor(internal_senders,sidecar_0) -> Sender: SyslogSender(internal_senders,syslog_sender_0), status: {"internal_queue_size": 0, "is_connection_open": True}
INFO OutputProcess::SyslogSenderManagerMonitor(internal_senders,sidecar_0) -> Internal - Total number of messages sent: 1, messages sent since "2022-06-28 10:39:22.516313+00:00": 1 (elapsed 0.019 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.<br>> ℹ️ This value helps detect bottlenecks and needs to increase the performance of data delivery to Devo. This last can be made by increasing the concurrent senders. |
| `Total number of messages sent: 44, messages sent since "2022-06-28 10:39:22.511671+00:00": 21 (elapsed 0.007 seconds)` | Displays the number of events from the last time and following the given example, the following conclusions can be obtained:<br>- 44 events were sent to Devo since the collector started.
- The last checkpoint timestamp was `2022-06-28 10:39:22.511671+00:00.`
- 21 events where sent to Devo between the last UTC checkpoint and now.
- Those 21 events required `0.007 seconds` to be delivered.<br>> ℹ️ By default these traces will be shown every 10 minutes. |
</details>

<details>
<summary>Check memory usage</summary>

To check the memory usage of this collector, look for the following log records in the collector which are displayed every 5 minutes by default, always after running the memory-free process.

- The used memory is displayed by running processes and the sum of both values will give the total used memory for the collector.
- The global pressure of the available memory is displayed in the `global` value.
- All metrics (Global, RSS, VMS) include the value before freeing and after `previous -> after freeing memory`

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

> ℹ️ 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
</details>

## Change log for v1.x.x

| **Release** | **Released on** | **Release type** | **Details** | **Recommendations** |
| --- | --- | --- | --- | --- |
| `v1.1.0` | 4/30/2025 | [Fixed] | **Fixed**<br>- Fixed issue with missing logs. | `Recommended Version` |
| `v1.1.0` | 4/24/2025 | [Fixed]  
[improvement] | **Fixed**<br>- Fixed issue with status code error.<br>**Improvements**<br>- DCSDK update from 1.8.0 to 1.15.0:
  - Changed log level to some messages from info to debug
  - Changed some wrong log messages
  - Upgraded some internal dependencies
  - Changed queue passed to setup instance constructor
  - Ability to validate collector setup and exit without pulling any data
  - Ability to store in the persistence the messages that couldn't be sent after the collector stopped
  - Ability to send messages from the persistence when the collector starts and before the puller begins working
  - Ensure special characters are properly sent to the platform
  - Fixed some bug related to development on MacOS
  - Added an extra validation and fix when the DCSDK receives a wrong timestamp format
  - Added an optional config property for use the Syslog timestamp format in a strict way
  - Fix for SyslogSender related to [UTF-8](https://devoinc.atlassian.net/browse/UTF-8?atlOrigin=eyJpIjoiYjM0MTA4MzUyYTYxNDVkY2IwMzVjOGQ3ZWQ3NzMwM2QiLCJwIjoianN3LWdpdGxhYlNNLWludCJ9)
  - Enhace of troubleshooting. Trace Standardization, Some traces has been introduced
  - Introduced a mechanism to detect "Out of Memory killer" situation
  - Added new sender for relay in house + TLS
  - Added persistence functionality for gzip sending buffer
  - Added Automatic activation of gzip sending
  - Improved behaviour when persistence fails
  - Upgraded DevoSDK dependency
  - Fixed console log encoding
  - Restructured python classes
  - Improved behavior with non-utf8 characters
  - Decreased defaut size value for internal queues (Redis limitation, from 1GiB to 256MiB)
  - New persistence format/structure (compression in some cases)
  - Removed dmesg execution (It was invalid for docker execution)
  - DevoSDK has been updated to version 5.4.0
  - Change internal queue management for protecting against OOMK
  - Extracted ModuleThread structure from PullerAbstract
  - Improve Controlled stop when both processes fails to instantiate
  - Improve Controlled stop when InputProcess is killed
  - Bug related to lost of collector_name , collector_id and job_id
  - Fixed error related a ValueError exception not well controlled
  - Differentiated error codes for SdkPersistenceServiceError.
  - Use of DOCKER_IMAGE environment variable to show docker_image property.
  - Now the property service_thread_execution_periods_in_seconds in collector_definition.yaml is optional.
  - Reduced Redis connections per collector to 2.
  - Implemented a mechanism to control if the certificates have expired.
  - Fixed [CVE-2024](https://devoinc.atlassian.net/browse/CVE-2024?atlOrigin=eyJpIjoiYjM0MTA4MzUyYTYxNDVkY2IwMzVjOGQ3ZWQ3NzMwM2QiLCJwIjoianN3LWdpdGxhYlNNLWludCJ9)-12797 vulnerability in cryptography library (updated from version 44.0.0 to 44.0.1).
- Upgraded dcsdk-docker-base-image to 1.4.1 | `Update` |
| `v1.0.0` | 2/24/2023 | [NEW FEATURE] | Released the first version of SailPoint IdentityNow.  
**New features:**<br>- Account activities: Account activities entries.
- Events: Event related to management console. | `Update` |