---
title: "Zscaler Audit Logs collector"
canonical: "https://docs.devo.com/space/latest/94657543/Zscaler%20Audit%20Logs%20collector"
format: markdown
---
> Macro (toc)

## Service description

[Zscaler ](https://www.zscaler.com/)is a cloud service that offers a centralized door for all the business applications and networks, making easy to control and secure all the data, connecting all the user and employees regardless the location or platform used.

Zscaler records the login name and IP address of every admin who logs in to the ZIA Admin Portal and changes policies or configuration settings. Audit logs display an admin's login and logout record (timestamps, actions, IP, etc.) and any configuration changes they completed. If an admin account makes five unsuccessful attempts to log in within one minute, the account will be locked out for five minutes and the failed attempts will be recorded. The audit logs are stored for up to 6 months.

## Zscaler collector migration guide (from 1.x.x to 2.x.x)

If you need to migrate an old collector version to a more recent one, please check the migration process in [this article](https://docs.devo.com/space/latest/1172570126/Zscaler+Collector+Migration+Guide).

## Devo Collector Features

| Feature | Details |
| --- | --- |
| Allow parallel downloading (multipod) | No |
| Running environments | Collector Server, On Premise |
| Populated Devo events | Table |
| Flattening pre-processing | No |
| Allowed source events obfuscation | Yes |

## Data source description

The Zscaler audit logs allow retrieving activities for these resources:

| **Resource** | **Description** | **API Endpoint** | **Collector Service Name** | **Devo tables** |
| --- | --- | --- | --- | --- |
| Audit logs | - **Timestamp **- The local time of the admin's last login or last logout.
- **User **- Account associated to the Zscaler service.
- **Action **- The action performed by the admin in the ZIA Admin Portal or API.
  - List of all potential actions.
- **AA in Cloud** - Zscaler domain where the data is collected, as an example zscaler*<something>*.net
- **Result **- The outcome of an action.
  - Successful
  - Failure
- **Client IP** - The source IP address for the admin.
- **Interface **- The means by which the user performed their actions.
  - The interface will either be the Admin UI or an API.
- **Category **- A location in the ZIA Admin Portal where the action was performed.
  - List of all potential categories.
- **Sub-Category**
  - List of all potential sub-categories.
- **Resource **- The specific location within a sub-category.
- **Pre Action** - Action programmed to happen before the event.
- **Post Action** - Action programmed to happen after the event. | `/api/v1/auditlogEntryReport` `/api/v1/auditlogEntryReport/download` | `zscaler_audit_logs` | `sse.zscaler.zia.audit` |

## Flattening Preprocessing

There is no flattening of the csv log.

## Source Event Obfuscation

There is no default source obfuscation for this collector.

## Minimum Configuration Required for Basic Pulling

Although this collector supports advanced configuration, below are the fields required for basic data pulling.

> **Note:** This minimum configuration refers exclusively to those specific parameters of this integration. Additional parameters related to the generic behavior of the collector are required. Check the setting sections for details.

| Setting | Details |
| --- | --- |
| `base_url` | The host and basePath for the cloud service API is $zsapi./api/v1. Check which Zscaler cloud name was provisioned for your organization and use it to replace . You must be assigned an admin role that includes the Authentication Configuration functional scope. Go to Administration > Cloud Service API Security. On the OAuth 2.0 Authorization Servers tab, the base URL is displayed within the table. |
| `username` | The username of the admin |
| `password` | The password of the admin |
| `api_key` | The key generated in setup |

## API Limits, Delays, Known Issues

There are duplicate data from API side, it's not collector issue.

## Accepted Authentication Methods

| **Authentication Method** | **base_url** | **api_key** | **username** | **password** |
| --- | --- | --- | --- | --- |
| **Api Key/Token** | **Required** | **Required** | **Required** | **Required** |

## Setup

1. Go to the Zscaler site **https://admin.*****<Zscaler Cloud Name>*****.net**
2. Enter your Login ID and Password and click the **Sign In** button.
3. Click on the **Administration **menu on the left. Then, select **API Key Management**.
4. Click on **Add API Key**. We will use this key to get the Audit logs.

## 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 **Zscaler - Integration factory.**
> 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:
> 
> > ℹ️ Replace the placeholders `<id>`, `<cloud>`, `<user_name>`, `<user_password>`, `<api_key>`, `<time_range_in_days valid range>`, `<audit_logs_page_size_in_items>`, `<start_time_in_epoch_milliseconds`>, and `<audit_logs_check_interval_in_seconds`> with the proper values.
> 
> ### Editing the JSON configuration
> 
> ```
> {
>   "global_overrides": {
>     "debug": false
>   },
>   "inputs": {
>     "zscaler": {
>       "id": "<short_unique_id>",
>       "enabled": true,
>       "base_url": "<zscaler customer domain · example -> https://admin.zscalerbeta.net>",
>       "credentials": {
>         "username": "<username_value>",
>         "password": "<password_value>",
>         "api_key": "<api_key_value>"
>       },
>       "services": {
>         "zscaler_audit_logs": {
>           "time_range_in_days": "<valid range -> 1 to 31>",
>           "audit_logs_page_size_in_items": "<valid range -> 10 to 500>",
>           "initial_start_time_in_utc": "<initial_start_time_in_utc_value>",
>           "audit_logs_check_interval_in_seconds": "<valid range -> 5 to 20>",
>           "types": [
>             "audit_logs"
>           ],
>           "override_tag": "<override base tag>",
>           "requests_limits": [
>             {
>               "period": "<period_value>",
>               "number_of_requests": "<number_of_requests>"
>             }
>           ],
>           "request_period_in_seconds": "<request_period_in_seconds>"
>         }
>       }
>     }
>   }
> }
> ```
> 
> > ℹ️ The value chosen for the `id` field will be used internally for having independent persistence areas
> 
> ![10_vmare carbon cloud.png](media://5147942c-5171-477f-887b-ae1ec85cf67b)
> 
> The following table outlines the parameters available for configuring the collector. Each parameter is categorized by its necessity (mandatory or optional), data type, acceptable values or formats, and a brief description.
> 
> | **Parameter** | **Data Type** | **Requirement** | **Value Range / Format** | **Description** |
> | --- | --- | --- | --- | --- |
> | `short_unique_id` | `str` | Mandatory | Min length: 1, Max length: 5 | Short, unique ID for input service, used in persistence addressing. Avoid duplicates to prevent collisions. |
> | `base_url` | `str` | Mandatory | Min length: 1 | For example: [zsapi.zscalerbeta.net](http://zsapi.zscalerbeta.net), [zsapi.zscalerone.net](http://zsapi.zscalerone.net), [zsapi.zscalertwo.net](http://zsapi.zscalertwo.net), [zsapi.zscalerthree.net](http://zsapi.zscalerthree.net), [zsapi.zscaler.net](http://zsapi.zscaler.net), [zsapi.zscloud.net](http://zsapi.zscloud.net), To locate your base URL:Log in to the ZIA Admin Portal using your admin credentials. |
> | `api_key` | `str` | Mandatory | Min length: 1 | Api Key |
> | `username` | `str` | Mandatory | Min length: 1 | Username for login |
> | `password` | `str` | Mandatory | Min length: 1 | Password of user |
> | `time_range_in_days` | `int` | Mandatory | Min: 1 Max: 31 | Amount of days you want to start lookback. |
> | `audit_logs_page_size_in_items` | `int` | Mandatory | Min: 10 Max: 500 | Page size returned. Set to 500. |
> | `initial_start_time_in_utc` | `str` | Mandatory | UTC format date | Initial time period used when fetching data from the endpoint.   
> **Format** `<yyyy-MM-dd'T'HH:mm:ss'Z'>` **Example:** `2024-10-21T10:15:30Z` |
> | `audit_logs_check_interval_in_seconds` | `int` | Mandatory | Min: 5 Max: 20 | 5 is usually fine |
> | `types` | `array` | Mandatory | audit logs | Array of log types, for now audit logs is the only acceptable one. |
> | `period_value` | `str` | Mandatory | number follow with [s,m,h,d,w,M,y] | Defines the reference time period used by the rate limiter. By default there is no limitation: 60 seconds.   
> `s: second`   
> `m: minute`   
> `h: hour`   
> `d: day`   
> `w: week`   
> `M: month`   
> `y: year`   
> **Example:** "30s" , "1m", "1h"   
> If you do not need this feature (Local Rate Limiter), remove the following definition from the service/endpoint:   
> **requests_limits: **<br>- **period: <period_value>**
> - **number_of_requests: <number_of_requests>** |
> | `number_of_requests` | `int` | Mandatory | Minimum value: 1 | Defines the maximum number of calls that can be made in the period_value.   
> If you do not need this feature (Local Rate Limiter), remove the following definition from the service/endpoint:   
> **requests_limits: **<br>- **period: <period_value>**
> - **number_of_requests: <number_of_requests>** |
> | `override_tag_value` | `str` | Optional | A devo tag | This parameter allows defining a custom devo tag. |
> | `request_period_in_seconds` | `int` | Optional | minimum length: 1 | Period in seconds used between each data pulling. This value will overwrite the default value (1800 seconds). This parameter can be removed or commented. |
> 
> **Note**: Parameters marked as "Mandatory" are required for the collector's configuration. Optional parameters can be omitted or removed if not used, but they provide additional customization and control over the collector's behavior.
> 
> 
> > 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 Zscaler collector:
> 
> ```
> <any_directory>
> └── devo-collectors/
>     └── devo-collector-zscaler/
>           ├── certs/
>           │ ├── chain.crt
>           │ ├── <your_domain>.key
>           │ └── <your_domain>.crt
>           └── config/
>             └── config-zscaler.yaml
> ```
> 
> ### Devo credentials
> 
> In Devo, go to **Administration → Credentials → X.509 Certificates**, download the **Certificate**, **Private key** and **Chain CA** and save them in `devo-collector-zscaler/certs`/ Learn more about security credentials in Devo [here](https://devodocs.atlassian.net/wiki/spaces/latest/pages/94763701).
> 
> ![image](media://30ad85e8-1003-436b-97d8-8dba1c749364)
> 
> ### Editing the config-zscaler.yaml file
> 
> ```
> globals:
>   debug: false
>   id: not_used
>   name: zscaler_collector
>   persistence:
>     type: filesystem
>     config:
>       directory_name: state
> outputs:
> #  devo_1:
> #    type: devo_platform
> #    config:
> #      address: <choose one -> collector-eu.devo.io or collector-us.devo.io>
> #      port: 443
> #      type: SSL
> #      chain: chain.crt
> #      cert: <devo_domain>.crt
> #      key: <devo_domain>.key
>   console_1:
>     type: console
> inputs:
>   zscaler:
>     id: <short_unique_id>
>     enabled: true
>     base_url: <zscaler customer domain · example -> https://admin.zscalerbeta.net>
>     credentials:
>       username: <username_value>
>       password: <password_value>
>       api_key: <api_key_value>
>     services:
>       zscaler_audit_logs:
>         time_range_in_days: <valid range -> 1 to 31>
>         audit_logs_page_size_in_items: <valid range -> 10 to 500>
>         initial_start_time_in_utc: <initial_start_time_in_utc_value>
>         audit_logs_check_interval_in_seconds: <valid range -> 5 to 20>
>         types:
>           - audit_logs
>         override_tag: <override base tag>
>         requests_limits:
>           - period: <period_value>
>             number_of_requests: <number_of_requests>
>         request_period_in_seconds: <request_period_in_seconds>
> ```
> 
> The following table outlines the parameters available for configuring the collector. Each parameter is categorized by its necessity (mandatory or optional), data type, acceptable values or formats, and a brief description.
> 
> | **Parameter** | **Data Type** | **Requirement** | **Value Range / Format** | **Description** |
> | --- | --- | --- | --- | --- |
> | `collector_id_value` | `str` | Mandatory | Min length: 1, Max length: 5 | Unique identifier for the collector. |
> | `collector_name_value` | `str` | Mandatory | Min length: 1, Max length: 10 | Name assigned to the collector. |
> | `devo_address` | `str` | Mandatory | One of: `collector-us.devo.io`, `collector-eu.devo.io` | Devo Cloud destination for events. |
> | `chain_filename` | `str` | Mandatory | Min length: 4, Max length: 20 | Filename of the `chain.crt` file from your Devo domain. |
> | `cert_filename` | `str` | Mandatory | Min length: 4, Max length: 20 | Filename of the `file.cert` from your Devo domain. |
> | `key_filename` | `str` | Mandatory | Min length: 4, Max length: 20 | Filename of the `file.key` from your Devo domain. |
> | `short_unique_id` | `str` | Mandatory | Min length: 1, Max length: 5 | Short, unique ID for input service, used in persistence addressing. Avoid duplicates to prevent collisions. |
> | `base_url` | `str` | Mandatory | Min length: 1 | For example: [zsapi.zscalerbeta.net](http://zsapi.zscalerbeta.net), [zsapi.zscalerone.net](http://zsapi.zscalerone.net), [zsapi.zscalertwo.net](http://zsapi.zscalertwo.net), [zsapi.zscalerthree.net](http://zsapi.zscalerthree.net), [zsapi.zscaler.net](http://zsapi.zscaler.net), [zsapi.zscloud.net](http://zsapi.zscloud.net), To locate your base URL:Log in to the ZIA Admin Portal using your admin credentials. |
> | `api_key` | `str` | Mandatory | Min length: 1 | Api Key |
> | `username` | `str` | Mandatory | Min length: 1 | Username for login |
> | `password` | `str` | Mandatory | Min length: 1 | Password of user |
> | `time_range_in_days` | `int` | Mandatory | Min: 1 Max: 31 | Amount of days you want to start lookback. |
> | `audit_logs_page_size_in_items` | `int` | Mandatory | Min: 10 Max: 500 | Page size returned. Set to 500. |
> | `initial_start_time_in_utc` | `str` | Mandatory | UTC format date | Initial time period used when fetching data from the endpoint.   
> **Format** `<yyyy-MM-dd'T'HH:mm:ss'Z'>` **Example:** `2024-10-21T10:15:30Z` |
> | `audit_logs_check_interval_in_seconds` | `int` | Mandatory | Min: 5 Max: 20 | 5 is usually fine |
> | `types` | `array` | Mandatory | audit logs | Array of log types, for now audit logs is the only acceptable one. |
> | `period_value` | `str` | Mandatory | number follow with [s,m,h,d,w,M,y] | Defines the reference time period used by the rate limiter. By default there is no limitation: 60 seconds.   
> `s: second`   
> `m: minute`   
> `h: hour`   
> `d: day`   
> `w: week`   
> `M: month`   
> `y: year`   
> **Example:** "30s" , "1m", "1h"   
> If you do not need this feature (Local Rate Limiter), remove the following definition from the service/endpoint:   
> **requests_limits: **<br>- **period: <period_value>**
> - **number_of_requests: <number_of_requests>** |
> | `number_of_requests` | `int` | Mandatory | Minimum value: 1 | Defines the maximum number of calls that can be made in the period_value. Check in Netskope site your limits per endpoint based on your Netskope tier.   
> If you do not need this feature (Local Rate Limiter), remove the following definition from the service/endpoint:   
> **requests_limits: **<br>- **period: <period_value>**
> - **number_of_requests: <number_of_requests>** |
> | `override_tag_value` | `str` | Optional | A devo tag | This parameter allows defining a custom devo tag. |
> | `request_period_in_seconds` | `int` | Optional | minimum length: 1 | Period in seconds used between each data pulling. This value will overwrite the default value (1800 seconds). This parameter can be removed or commented. |
> 
> **Note**: Parameters marked as "Mandatory" are required for the collector's configuration. Optional parameters can be omitted or removed if not used, but they provide additional customization and control over the collector's behavior.
> 
> 
> ### 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-zscaler_if-docker-image-2.0.3.tgz](https://drive.google.com/file/d/1C6Zb0mO3Mr5t4hYdQqqEMWfwEYiYSKu6/view?usp=drive_link) | fce69c6c1a1496e5da9d738f673fc4be8ae13dc8cbd898ea8731bed6a0358090 |
> 
> Use the following command to add the Docker image to the system:
> 
> ```
> gunzip -c collector-zscaler-docker-image-<version>.tgz | docker load
> ```
> 
> > ℹ️ Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace "`<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/devo-collector-zscaler/`
> 
> ```
> docker run \
> --name collector-zscaler\
> --volume $PWD/certs:/devo-collector/certs \
> --volume $PWD/config:/devo-collector/config \
> --volume $PWD/state:/devo-collector/state \
> --env CONFIG_FILE=config-zscaler.yaml \
> --rm -it docker.devo.internal/collector/zscaler:<version>
> ```
> 
> > ⚠️ Replace `<version>` with the required value.
> 
> #### 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/devo-collector-zscaler/` directory.
> 
> ```
> version: '3'
> services:
>    collector-zscaler:
>      image: docker.devo.com/collector/zscaler:${IMAGE_VERSION:-latest}
>      volumes:
>        - ./certs:/devo-collector/certs
>        - ./config:/devo-collector/config
>        - ./state:/devo-collector/state
>      environment:
>        - CONFIG_FILE=${CONFIG_FILE:-config-zscaler.yaml}
> ```
> 
> To run the container using docker-compose, execute the following command from the `<any_directory>/devo-collectors/devo-collector-zscaler/` directory:
> 
> ```
> IMAGE_VERSION=<version> docker-compose up -d
> ```
> 
> > ⚠️ Replace `<version>` with the required value.

## API limitations

The API limitations can be seen in the next table: 

| **Resource URI** | **GET** | **POST** | **PUT** | **DELETE** |
| --- | --- | --- | --- | --- |
| /auditlogEntryReport | 2/sec and 1000/day | 10/min and 1000/day | - | 2/sec and 1000/hr |
| /auditlogEntryReport/download | 2/sec and 1000/day | - | - | - |

## Collector Services Detail

This section is intended to explain how to proceed with specific actions for services.

### Audit (`audit`)

If you would like to learn more about the Zia Audit logs click [here](https://help.zscaler.com/zia/about-audit-logs#action)

#### Internal Process and Deduplication Method

There is no deduplication method for this collector.

#### Devo Categorization and Destination

All events of this service are ingested into the table `sse.zscaler.zia.audit`.

#### Setup Output

```
2024-04-09T09:56:19.561389088Z 2024-04-09T09:56:19.561 WARNING InputProcess::zscalerPullerSetup(zscaler,zscaler#56752,audit#predefined) -> Testing fetch from 
2024-04-09T09:56:19.771898077Z 2024-04-09T09:56:19.771    INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,relay_0) -> Number of available senders: 1, sender manager internal queue size: 0
2024-04-09T09:56:19.772167710Z 2024-04-09T09:56:19.771    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,relay_0) -> Number of available senders: 1, sender manager internal queue size: 0
2024-04-09T09:56:19.772327665Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,relay_0) -> enqueued_elapsed_times_in_seconds_stats: {}
2024-04-09T09:56:19.772395427Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,relay_0) -> enqueued_elapsed_times_in_seconds_stats: {}
2024-04-09T09:56:19.772425735Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,relay_0) -> Sender: DevoSender(internal_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": True}
2024-04-09T09:56:19.772519048Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,relay_0) -> Sender: DevoSender(lookup_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": False}
2024-04-09T09:56:19.772601144Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,relay_0) -> Internal - Total number of messages: 6333 messages/bytes sent since/to "2024-04-09T09:51:19.771169+00:00/2024-04-09T09:56:19.772408+00:00": 25/13762, (elapsed 0.052 seconds)
2024-04-09T09:56:19.772631900Z 2024-04-09T09:56:19.772    INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,relay_0) -> Lookup - Total number of messages sent: 0, messages sent since "2024-04-09 09:51:19.770969+00:00": 0 (elapsed 0.000 seconds)
2024-04-09T09:56:20.261298432Z 2024-04-09T09:56:20.261    INFO InputProcess::zscalerPullerSetup(zscaler,zscaler#56752,audit#predefined) -> Successfully tested fetch from /mcm/audit. Source is pullable.
2024-04-09T09:56:20.262730750Z 2024-04-09T09:56:20.262    INFO InputProcess::zscalerPullerSetup(zscaler,zscaler#56752,audit#predefined) -> Setup for module <zscalerPuller> has been successfully executed
```

#### Puller Output

```
2024-04-09T09:56:22.704294203Z 2024-04-09T09:56:22.704    INFO InputProcess::zscalerPuller(zscaler,56752,audit,predefined) -> Pull Started
2024-04-09T09:56:23.124016843Z 2024-04-09T09:56:23.123    INFO InputProcess::zscalerPuller(zscaler,56752,audit,predefined) -> Updating the persistence
2024-04-09T09:56:23.124811682Z 2024-04-09T09:56:23.124    INFO InputProcess::zscalerPuller(zscaler,56752,audit,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1712656582704):Number of requests made: 535; Number of events received: 2; Number of duplicated events filtered out: 0; Number of events generated and sent: 2; Average of events per second: 4.759.
```

#### Restart the persistence

Update the unique Id of the collector and restart, this will remove the Id values that have been pulled. This may cause duplicates.

## Troubleshooting

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

#### Common Logic

| Error Type | Error Id | Error Message | Cause | Solution |
| --- | --- | --- | --- | --- |
| ApiError | 496 | Connection Error - Ensure the URL parameters are correct and that host has access to server. | Could Not connect to the Host | Ensure the endpoint is reachable with the credentials |
| ApiError | 497 | Max Retries Error - Request attempts with {retries} retries failed. \n{reason} | Max Retries Hit | Update rate limits |
| SetUpError | 102 | Failed to fetch from {endpoint}. Error: {e} | The collector was unable to access the specified endpoint. | Ensure the endpoint is reachable with the credentials |

## Collector operations 

### Verify collector operations

#### Initialization

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

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

|  |
| --- |
|  |
| 2023-01-10T15:22:57.146 INFO MainProcess::MainThread -> Loading configuration using the following files: {"full_config": "config-test-local.yaml", "job_config_loc": null, "collector_config_loc": null}<br>2023-01-10T15:22:57.146 INFO MainProcess::MainThread -> Using the default location for "job_config_loc" [file: "/etc/devo/job/job_config.json](#)"<br>2023-01-10T15:22:57.147 INFO MainProcess::MainThread -> "\etc\devo\job" does not exists<br>2023-01-10T15:22:57.147 INFO MainProcess::MainThread -> Using the default location for "collector_config_loc" [file: "/etc/devo/collector/collector_config.json](#)"<br>2023-01-10T15:22:57.148 INFO MainProcess::MainThread -> "\etc\devo\collector" does not exists<br>2023-01-10T15:22:57.148 INFO MainProcess::MainThread -> Results of validation of config files parameters: {"config": "C:\git\collectors2\devo-collector-<name>\config\config.yaml", "config_validated": True, "job_config_loc": "/etc/devo/job/job_config.json", "job_config_loc_default": True, "job_config_loc_validated": False, "collector_config_loc": "/etc/devo/collector/collector_config.json", "collector_config_loc_default": True, "collector_config_loc_validated": False}<br>2023-01-10T15:22:57.171 WARNING MainProcess::MainThread -> [WARNING] Illegal global setting has been ignored -> multiprocessing: False |

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

```
2023-01-10T15:23:00.788    INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread
2023-01-10T15:23:00.789    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 300 seconds)
2023-01-10T15:23:00.790    INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread
2023-01-10T15:23:00.842    INFO OutputProcess::MainThread -> global_status: {"output_process": {"process_id": 18804, "process_status": "running", "thread_counter": 21, "thread_names": ["MainThread", "pydevd.Writer", "pydevd.Reader", "pydevd.CommandThread", "pydevd.CheckAliveThread", "DevoSender(standard_senders,devo_sender_0)", "DevoSenderManagerMonitor(standard_senders,devo_1)", "DevoSenderManager(standard_senders,manager,devo_1)", "OutputStandardConsumer(standard_senders_consumer_0)",
```

#### Sender services

The Integrations Factory Collector SDK has 3 different sender services depending on the event type to deliver (internal, standard, and lookup). This collector uses the following Sender Services:

|  |  |
| --- | --- |
| 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 the collector executed the pull logic. 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 were sent to Devo between the last UTC checkpoint and now.
- Those 21 events required 0.007 seconds to be delivered.
  By default these traces will be shown every 10 minutes. |

#### 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. |
| Standard - Total number of messages sent: 57, messages sent since "2023-01-10 16:09:16.116750+00:00": 0 (elapsed 0.000 seconds | Displays the number of events from the last time the collector executed the pull logic. Following the given example, the following conclusions can be obtained:<br>- 44 events were sent to Devo since the collector started.
- The last checkpoint timestamp was 2023-01-10 16:09:16.116750+00:00.
- 21 events were sent to Devo between the last UTC checkpoint and now.
- Those 21 events required 0.00 seconds to be delivered. |

#### Check memory usage

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

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

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

## Change log

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| **Release** | **Released on** | **Release Type** | **Details** | **Recommended actions** |
| `2.0.3` | April 18, 2025 | Fixed | - Fixed the issue for `Waiting until setup will be executed`. | Recommended version |
| `2.0.1` | April 04, 2025 | Fixed | - Fixed the issue for invalid session error. | Update |
| `2.0.0` | March 11th, 2025 | Changed | - Refactor code and upgraded DCSDK to 1.15.0
- Upgraded docker base image to 1.4.0
- Sending data to new table `sse.zscaler.zia.audit` | Update |
| `1.0.0` | April 9th, 2024 | New collector | Initial Release | > Macro (nested-table) |

## Related articles

- [Zscaler](https://docs.devo.com/space/latest/94657536/Zscaler)
- [Zscaler ZIA integration](https://docs.devo.com/space/latest/94657608/Zscaler+ZIA+integration)
- [Deployment overview](https://docs.devo.com/space/latest/94657636/Deployment+overview)
- [Integration deployment](https://docs.devo.com/space/latest/94657666/Integration+deployment)