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

## Configuration requirements

To run this collector, there are some configurations detailed below that you need to consider.

| **Configuration** | **Details** |
| --- | --- |
| JumpCloud credentials | It is necessary to have your credentials so you can configure the collector. |
| API token | It is necessary to have API Token. |
| API Key | You need to save your API key. |

> ℹ️ **More information**
> ℹ️ 
> ℹ️ Refer to the [Vendor setup ](#vendor-setup)section to know more about these configurations.

## Overview

**JumpCloud** works as a directory-as-a-service software solution that is designed to manage and connect hundreds of users to their respective applications, files, networks, and systems.

Directory insights allow you to read event logs, view activity in your directory, and monitor user authentications to the console, RADIUS, LDAP, and SSO apps. Directory insights analyze the audit trails that lead to critical events so you know what, where, how, and who of your directory activities.

## 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** |
| --- | --- | --- | --- | --- | --- |
| directory | Logs on activity in the Portal, including admin changes in the directory and admin/user authentications to the Portal. | `/directory/v1/events`  
`data body:`<br>- `service: “`<br>`directory“` | `directory` | `auth.jumpcloud.directory.events` | `v1.0.0` |
| systems | Logs about user authentications to systems including agent related events on lockout, password changes, and File Disk Encryption key updates. | `/directory/v1/events`  
`data body:`<br>- `service: "`<br>`systems"` | `systems` | `auth.jumpcloud.system.events` | `v1.0.0` |
| sso | Logs on user authentications to SAML applications. | `/directory/v1/events`  
`data body:`<br>- `service: "`<br>`sso"` | `sso` | `auth.jumpcloud.sso.events` | `v1.0.0` |
| radius | Logs on user authentications to RADIUS used for wifi and VPNs. | `/directory/v1/events`  
`data body:`<br>- `service: "`<br>`radius"` | `radius` | `auth.jumpcloud.radius.events` | `v1.0.0` |
| ldap | Logs about user authentications to LDAP, including LDAP bind and search events types. | `/directory/v1/eventsdata body:`<br>`service: "`<br>`ldap"` | `ldap` | `auth.jumpcloud.ldap.events` | `v1.0.0` |
| mdm | Logs about MDM command results. | `/directory/v1/events`  
`data body:`<br>- `service: “`<br>`mdm“` | `mdm` | `auth.jumpcloud.mdm.events` | `v1.0.0` |
| All events | Logs about all events. | `/directory/v1/events`  
`data body:`<br>- `service: “`<br>`all“` | `all` | It has autocategorization, it depends on the type of event:<br>- `auth.jumpcloud.directory.events`
- `auth.jumpcloud.system.events`
- `auth.jumpcloud.sso.events`
- `auth.jumpcloud.radius.events`
- `auth.jumpcloud.ldap.events`
- `auth.jumpcloud.mdm.events` | `v1.0.0` |

## Flattening preprocessing

| **Data source** | **Collector service** | **Optional** | **Flattening details** |
| --- | --- | --- | --- |
| Source | Service | `No` | Flattening steps |

## Vendor setup

> Macro (anchor)



There are some requirements to set up this collector:

### Generate API Token

1. Login into [JumpCloud](https://console.jumpcloud.com/login).
2. In the **Administration Center** go to the **username** drop-down in the upper right corner.
  
3. Retrieve your **API key** from the **API settings**.

### API Considerations

This API key is associated with the currently logged-in administrator. The API keys will be different for other administrators. 

> ⚠️ **Keep the API Key**
> ⚠️ 
> ⚠️ Keep this API key secret as it grants full access to any data accessible via your JumpCloud console account. You can also reset your API key in the same location in the JumpCloud Admin Console.

## Minimum configuration required for basic pulling

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

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

| **Setting** | **Details** |
| --- | --- |
| `api_key` | Token for use JumpCloud API |

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

## Accepted authentication methods

| **Authentication method** | **Api key** |
| --- | --- |
| Api key | [REQUIRED] |

## Run the collector

Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (<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 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
> 
> ```
> {
>   "global_overrides": {
>     "debug": False
>   },
>   "jumpcloud_collector": {
>       "id": <short_unique_id>,
>       "enabled": True,
>       "credentials": {
>         "api_key": "<api_key>"
>       },
>       "services": {
>         "<service_name>": {
>           "request_period_in_seconds": <request_period_in_seconds_value>,
>           "historic_date_utc": "<historic_date_utc_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** |
> | `<short_unique_id>` | `int` | `Mandatory` | `YMMDD` | Use this param 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. |
> | `<api_key>` | `str` | `Mandatory` | alphanumeric token | Token for use JumpCloud API |
> | `<service_name>` | `str` | `Mandatory` | The name of a valid service. | The name of the service. It can be one of the following:<br>- `directory`
> - `systems`
> - `sso`
> - `radius`
> - `ldap`
> - `mdm`
> - `all`<br>> ⚠️ Do not use the `all` service together with the others because it has auto-categorization and events could be repeated. |
> | `<request_period_in_seconds_value>` | `int` | `Optional` | Minimum value: 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. |
> | `<historic_date_utc_value>` | `str` | `Optional` | With format: `%Y-%m-%d %H:%M:%S` | This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (1 month back for example) before downloading new events.<br>> ℹ️ This parameter can be removed or commented. |
> 
> ![jumpcloud_10.png](media://32e9af40-d557-419f-ac26-4f2e4fa2a168)
> 
> > 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://a070c444-7f12-4b30-bb60-203320229881)
> 
> > ⚠️ Replace `<product_name>` with the proper value.
> 
> ### Editing the config.yaml file
> 
> ```
> globals:
>   debug: <enable_debug_logs>
>   id: not_used
>   name: jumpcloud_collector
>   persistence:
>     type: filesystem
>     config:
>       directory_name: state
> 
> outputs:
>   devo_1:
>     type: devo_platform
>     config:
>       address: <your-ingestion-endpoint>
>       port: 443
>       type: SSL
>       chain: <chain_filename>
>       cert: <cert_filename>
>       key: <key_filename>
> inputs:
>   jumpcloud_collector:
>     id: <short_unique_id>
>     enabled: True
>     credentials:
>       api_key: <api_key>
>     services:
>       <service_name>:
>         request_period_in_seconds: <request_period_in_seconds_value>
>         historic_date_utc: <historic_date_utc_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** |
> | --- | --- | --- | --- | --- |
> | `<enable_debug_logs>` | `bool` | `Mandatory` | `false` / `true` | This will make the collector generate (or not) log messages with the DEBUG level. |
> | `<your-ingestion-endpoint>` | `str` | `Mandatory` | `collector-us.devo.io`  
> `collector-eu.devo.io` | Use this param to identify the Devo Cloud where the events will be sent. |
> | `<chain_filename>` | `str` | `Mandatory` | Minimum length: 4  
> Maximum length: 20 | Use this param 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  
> Maximum length: 20 | Use this param to identify the `file.cert` downloaded from your Devo domain. |
> | `<key_filename>` | `str` | `Mandatory` | Minimum length: 4  
> Maximum length: 20 | Use this param to identify the `file.key` downloaded from your Devo domain. |
> | `<short_unique_id>` | `int` | `Mandatory` | `YMMDD` | Use this param 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. |
> | `<api_key>` | `str` | `Mandatory` | alphanumeric token | Token for use JumpCloud API |
> | `<service_name>` | `str` | `Mandatory` | The name of a valid service. | The name of the service. It can be one of the following:<br>- `directory`
> - `systems`
> - `sso`
> - `radius`
> - `ldap`
> - `mdm`
> - `all`<br>> ⚠️ Do not use the `all` service together with the others because it has auto-categorization and events could be repeated. |
> | `<request_period_in_seconds_value>` | `int` | `Optional` | Minimum value: 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. |
> | `<historic_date_utc_value>` | `str` | `Optional` | With format: `%Y-%m-%d %H:%M:%S` | This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (1 month back for example) before downloading new events.<br>> ℹ️ This parameter can be removed or commented. |
> 
> ### 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-jumpcloud_if-docker-image-1.3.1.tgz](https://drive.google.com/file/d/1C529_v2SDfEsWZEChVhCZcTo8JhqsEg7/view?usp=drive_link) | `a61c0c2480d445ba591ad8ef1a609b8d443fe289b4d7110146a7adc1b930d805` |
> 
> 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>
>     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:
> 
> ```
> 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.

### 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 -> CollectorJumpCloudPullerSetup(andrea_jumpcloud_test,jumpcloud_collector#12345,mdm#predefined) -> Starting thread
INFO InputProcess::CollectorJumpCloudPullerSetup(andrea_jumpcloud_test,jumpcloud_collector#12345,mdm#predefined) -> Starting the execution of setup()
INFO InputProcess::CollectorJumpCloudPullerSetup(andrea_jumpcloud_test,jumpcloud_collector#12345,mdm#predefined) -> The token/header/authentication is defined
INFO InputProcess::CollectorJumpCloudPullerSetup(andrea_jumpcloud_test,jumpcloud_collector#12345,mdm#predefined) -> The token/header/authentication is valid
INFO InputProcess::CollectorJumpCloudPullerSetup(andrea_jumpcloud_test,jumpcloud_collector#12345,mdm#predefined) -> Finalizing the execution of setup()
INFO InputProcess::CollectorJumpCloudPullerSetup(andrea_jumpcloud_test,jumpcloud_collector#12345,mdm#predefined) -> Setup for module <CollectorJumpCloudPuller> 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::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) Starting the execution of pre_pull()
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Reading persisted data
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Data retrieved from the persistence: {'last_polled_timestamp': 1667460688.0, 'historic_date_utc': 1664564634.0, 'ids_with_same_timestamp': ['63636e50ace1cf7d597b249a'], '@persistence_version': 0}
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Running the persistence upgrade steps
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Running the persistence corrections steps
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Running the persistence resetting steps
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> No changes detected in the persistence
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) Finalizing the execution of pre_pull()
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Starting data collection every 600 seconds
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Pull Started
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Number of mdm events received: 1000
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Removing the duplicate detections if present...
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Number of mdm events sent to Devo: 999
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> State last_polled_timestamp is updated with retrieving timestamp
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Saved state: {'last_polled_timestamp': 1667508039.0, 'historic_date_utc': 1664564634.0, 'ids_with_same_timestamp': ['636427473406b53302125184'], '@persistence_version': 0}
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1667547361635):Number of requests made: 1; Number of events received: 1000; Number of duplicated events filtered out: 1; Number of events generated and sent: 999; Average of events per second: 628.017.
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Number of mdm events received: 186
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Removing the duplicate detections if present...
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Number of mdm events sent to Devo: 186
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> State last_polled_timestamp is updated with retrieving timestamp
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Saved state: {'last_polled_timestamp': 1667547294.0, 'historic_date_utc': 1664564634.0, 'ids_with_same_timestamp': ['6364c09e528074dade39318b'], '@persistence_version': 0}
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1667547361635):Number of requests made: 2; Number of events received: 1186; Number of duplicated events filtered out: 1; Number of events generated and sent: 1185; Average of events per second: 587.138.
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1667547361635):Number of requests made: 2; Number of events received: 1186; Number of duplicated events filtered out: 1; Number of events generated and sent: 1185; Average of events per second: 586.865.
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> The data is up to date!
INFO InputProcess::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Data collection completed. Elapsed time: 2.024 seconds. Waiting for 597.976 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::CollectorJumpCloudPuller(jumpcloud_collector,12345,mdm,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1667547361635):Number of requests made: 2; Number of events received: 1186; Number of duplicated events filtered out: 1; Number of events generated and sent: 1185; Average of events per second: 586.865.
```

> ℹ️ 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 `historic_date_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** |
| --- | --- | --- | --- | --- |
| SetupError | `100` | `The remote data is not pullable with the given credentials. Check the error traces for details.` | This error is raised when remote data cannot be accessed with current credentials. | Check that the credentials are correct and that they have the necessary permissions. |
| `101` | `The token/header/authentication was refreshed but is still expired. Check the error traces for details.` | This error is raised when the token cannot be refreshed. | Check that the credentials are correct and contact the internal team if the problem persists. |
| InitVariablesError | `1` | `The user config did not pass the format validation. Check error traces for details and visit our documentation.` | This error is raised when the user configuration information does not comply with the json schema validation. | Check in the collector documentation what are the allowed parameters and their formats. |
| `2` | `<rate_limiter> setting has been defined with wrong type.'Expected <dict> but received <{type(rate_limiter_config)>` | This error is raised when the required `rate_limiter `property in the `collector_definitions.yaml` is not a dictionary. | This is an internal issue. Contact with Devo Support team. |
| `3` | `The user config did not pass the format validation. Check error traces for details and visit our documentation.` | This error is raised when the user configuration information does not comply with the json schema validation. | Check in the collector documentation what are the allowed parameters and their formats. |
| `10` | `Required setting, historic_date_utc not of expected type: str` | This error is raised when the parameter `historic_date_utc` is not in `str` format. | Update the `historic_date_utc` parameter in the configuration file so that it is in `str` format |
| `11` | `Invalid value is provided for the historic_date. Provide the date in %Y-%m-%d " `  
`f"%H:%M:%S format. Error message: <str(e)>` | This error is raised when the parameter `historic_date_utc` does not meet the required format. | Update the `historic_date_utc` parameter in the configuration file so that it is in the required format. |
| `12` | `Time format for historic date must be <date_format>. e.g. <example_date>` | This error is raised when the parameter `historic_date_utc` does not meet the required format. | Update the `historic_date_utc` parameter in the configuration file so that it is in the required format. |
| `12` | `historic datetime cannot be greater than the present UTC time` | This error is raised when the parameter `historic_date_utc` is greater than the present UTC time. | Modify the `historic_date_utc` parameter in the config file to be less than the current date |
| PullError | `300` | `Error occurred while retrieving events from JumpCloud server. Error details: <str(e)>` | This error is raisedwhen an unknown error occurs in the Jumpcloud request. | This is an internal issue. Contact with Devo Support team. |
| `301` | `The API Key provided is incorrect. Please specify the correct key. Status code: 401. Error message: <response.text>` | This error is raised when the API key entered in the configuration file is incorrect. | Edit the config file with a correct API key. |
| `302` | `The provided API Key is valid but they do not have the permission to get data token. status code: 403. Error message: <response.text>` | This error is raised when the credentials does not have sufficient permissions to access the data. | Give the credentials the correct permissions to access the data. |
| `303` | `Unexpected error occurred at the JumpCloud server. status code: <response.status_code>. Error message: <response.text>` | This error is raised when an unknown error occurs in the Jumpcloud request. | This is an internal issue. Contact with Devo Support team. |
| `304` | `After <max_number_of_retries> retries still getting the too many requests error.` | This error is raised when the maximum number of attempts is reached after a 429 error (too many requests) | This is an internal issue. Contact with Devo Support team. |
</details>

## Collector operations

This section is intended to explain how to proceed with 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 receives 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)` | Displayes 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>

<details>
<summary>Enable/disable the logging debug mode</summary>

Sometimes it is necessary to activate the debug mode of the collector's logging. This debug mode increases the verbosity of the log and allows you to print execution traces that are very helpful in resolving incidents or detecting bottlenecks in heavy download processes.

- To enable this option you just need to edit the configuration file and change the debug_status parameter from false to true and restart the collector.
- To disable this option, you just need to update the configuration file and change the debug_status parameter from true to false and restart the collector.

For more information, visit the configuration and parameterization section corresponding to the chosen deployment mode.
</details>

## Change log for v1.x.x

| **Release** | **Released on** | **Release type** | **Details** | **Recommendations** |
| --- | --- | --- | --- | --- |
| `v1.3.1` | 2/16/2024 | [BUG fixing] |  | `Recommended version` |
| `v1.2.2` | 1/14/2024 | [IMPROVEMENTS][BUG fixing] | **Bug**<br>- Resolved the issue of sending the data at unknown.unknown
  **Upgraded DCSDK from 1.9.2 to 1.10.2**
- Ensure special characters are properly sent to the platform
- 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 | `-` |
| `v1.1.0` | 8/30/2023 | [IMPROVEMENTS] | **Upgraded DCSDK from 1.5.1 to 1.9.2**<br>- New “templates” functionality
- Functionality for detecting some system signals for starting the controlled stopping
- Input objects sends again the internal messages to devo.collectors.out table
- Upgraded DevoSDK to version 3.6.4 to fix a bug related to a connection loss with Devo
- Refactored source code structure
- Changed way of executing the controlled stopping
- Minimized probabilities of suffering a DevoSDK bug related to “sender” to be null
- 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
- Added a lock to enhance sender object
- Added new class attrs to the **setstate** and **getstate** queue methods
- Fix sending attribute value to the **setstate** and **getstate** queue methods
- Added log traces when queues are full and have to wait
- Added log traces of queues time waiting every minute in debug mode
- Added method to calculate queue size in bytes
- Block incoming events in queues when there are no space left
- Send telemetry events to Devo platform
- Upgraded internal Python dependency Redis to v4.5.4
- Upgraded internal Python dependency DevoSDK to v5.1.3
- Fixed obfuscation not working when messages are sent from templates
- New method to figure out if a puller thread is stopping
- Upgraded internal Python dependency DevoSDK to v5.0.6
- Improved logging on messages/bytes sent to Devo platform
- Fixed wrong bytes size calculation for queues
- New functionality to count bytes sent to Devo Platform (shown in console log)
- Upgraded internal Python dependency DevoSDK to v5.0.4
- Fixed bug in persistence management process, related to persistence reset
- Aligned source code typing to be aligned with Python 3.9.x
- Inject environment property from user config
- Obfuscation service can be now configured from user config and module definiton
- Obfuscation service can now obfuscate items inside arrays
- Ensure special characters are properly sent to the platform
- 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
- Upgrade internal dependencies | `-` |
| `v1.0.0` | 11/4/2022 | [NEW FEATURE] | **New features:**<br>Released first version of Jumpcloud collector with the following services:<br>- **directory**: Logs activity in the Admin Portal, including admin changes in the directory and admin/user authentications to the Admin Portal.
- **radius**: Logs user authentications to RADIUS, used for Wi-Fi and VPNs.
- **sso**: Logs user authentications to SAML applications.
- **systems**: Logs user authentications to MacOS, Windows, and Linux systems, including agent-related events on lockout, password changes, and File Disk Encryption key updates.
- **ldap**: Logs user authentications to LDAP, including LDAP Bind and Search event types.
- **mdm**: Logs MDM command results.
- **all**: all the Logs. | `-` |