Table of Contents | ||||
---|---|---|---|---|
|
...
Data source | Description | API endpoint | Collector service name | Devo table | Available from release | ||
Alerts | Represents potential security issues within a customer’s tenant that Microsoft or partner security solutions have identified. Refer to Microsoft documentation about Alert Resource Type for more information. |
|
| Starting from v1.2.0, the destination table depends on the tag_version configuration parameter:
|
| ||
Secure scores | Represents a tenant's secure score per day of scoring data, at the tenant and control level. By default, 90 days of data is held. Refer to the Microsoft documentation for more information about Secure scores resources types. |
|
| Starting from v1.2.0, the destination table depends on the
|
| ||
Secure score control profiles | Represents a tenant's secure score per control data. Refer to the Microsoft documentation for more information about Secure score control profiles. |
|
| Starting from v1.2.0, the destination table depends on the
|
| ||
Directory audit | Represents the directory audit items and its collection. Refer to the Microsoft documentation for more information about Directory audit. |
|
|
|
| ||
Provisioning | Represents an action performed by the Azure AD Provisioning service and its associated properties. Refer to the Microsoft documentation for more information about Provisioning. |
|
|
|
| ||
Sign-in | Details user and application sign-in activity for a tenant (directory). Refer to the Microsoft documentation for more information about Sign-in.
|
|
|
|
|
...
Note |
---|
You need the Admin level permissions on the Azure portal as the subscription setup will require admin consent API permissions, authentications, and audits. |
Action | Steps | |||
1 | Register and configure the application |
| ||
2 | Grant the required permissions |
| ||
3 | Obtain the requires credentials for the collector |
|
...
Rw ui tabs macro | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. StructureThe following directory structure should be created for being used when running the collector:
Devo credentialsIn Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in
Editing the config.yaml file
Replace the placeholders with your required values following the description table below: | ||||||||||||||
Parameter | Data type | Type | Value range / Format | Details | ||||||||||
|
|
|
| If the value is | ||||||||||
|
|
| Minimum length: | Use this param to give a unique id to this collector. | ||||||||||
|
|
| Minimum length: | Use this param to give a valid name to this collector, like | ||||||||||
|
|
|
| Use this param to identify the Devo Cloud where the events will be sent. | ||||||||||
|
|
| Minimum length: | Use this param to identify the chain.cert file downloaded from your Devo domain. Usually this file's name is: | ||||||||||
|
|
| Minimum length: | Use this param to identify the |
|
|
alerts_v2:
request_period_in_seconds: <request_period_in_seconds_value>
reset_persistence_auth: <reset_persistence_auth_value>
start_time: <start_time_value>
override_time_delta_in_days: <override_time_delta_in_days_value>
ms_365_environment: <ms_365_environment_value>
custom_endpoints:
override_base_url_main: <override_base_url_main_value>
override_base_url_vendor: <override_base_url_vendor_value>
override_base_url_vendor_with_sub_provider: <override_base_url_vendor_with_sub_provider_value>
override_login_url: <override_login_url_value>
override_scope: <override_scope_value> |
Info |
---|
All defined service entities will be executed by the collector. If you do not want to run any of them, just remove the entity from the |
Replace the placeholders with your required values following the description table below:
Parameter | Data type | Type | Value range / Format | Details | ||||
---|---|---|---|---|---|---|---|---|
|
|
|
| If the value is | ||||
|
|
| Minimum length: | Use this param to give a unique id to this collector. | ||||
|
|
| Minimum length: | Use this param to give a valid name to this collector, like | ||||
|
|
|
| Use this param to identify the Devo Cloud where the events will be sent. | ||||
|
|
| Minimum length: | Use this param to identify the chain.cert file downloaded from your Devo domain. Usually this file's name is: | ||||
|
|
| Minimum length: | Use this param to identify the | ||||
|
|
| Minimum length: | Use this param to identify the | ||||
|
|
| Minimum length: | Use this param to give a unique id to this input service.
| ||||
|
|
|
| Use this param to enable or disable the given input logic when running the collector. If the value is | ||||
|
|
| Minimum value: | Customize the maximum number of API requests per second. If not used, the default setting will be used:
| ||||
|
|
| UUID format | This is the Tenant’s ID you created in Azure AD. You can obtain it from the Overview page in your registered application. | ||||
|
|
| UUID format | This is the Tenant’s ID you created in Azure AD. You can obtain it from the Overview page in your registered application. | ||||
|
|
| Any non-whitespace character | This is the Client’s secret you created in Azure AD. You can obtain it from the Certificates & secrets page in your registered application. | ||||
|
|
| Minimum value: | The amount (in seconds) in which the service’s collection is scheduled.
| ||||
|
|
| For the secure_scores service: For the rest of the services: | This will allow you to start from a specific date in case you want to ingest historic events. If not set, it will start at the current time.
| ||||
|
|
| Only accepts | The
The detailed table destination depending on the
|
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 |
---|---|
|
Use the following command to add the Docker image to the system:
Code Block |
---|
gunzip -c <collector-ms-graph-collector-if-docker-image>-<1.2.0>.tgz | docker load |
Note |
---|
Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace |
The Docker image can be deployed on the following services:
Docker
Execute the following command on the root directory <any_directory>/devo-collectors/<product_name>/
Code Block |
---|
docker run --name collector-<product_name> --volume $PWD/certs:/devo-collector/certs --volume $PWD/config:/devo-collector/config --volume $PWD/state:/devo-collector/state --env CONFIG_FILE=config.yaml --rm --interactive --tty <image_name>:<version> |
Note |
---|
Replace |
Docker Compose
The following Docker Compose file can be used to execute the Docker container. It must be created in the <any_directory>/devo-collectors/<product_name>/
directory.
Code Block |
---|
version: '3' services: collector-<product_name>: image: <image_name>:${IMAGE_VERSION:-latest} container_name: collector-<product_name> volumes: - ./certs:/devo-collector/certs - ./config:/devo-collector/config - ./credentials:/devo-collector/credentials - ./state:/devo-collector/state environment: - CONFIG_FILE=${CONFIG_FILE:-config.yaml} |
To run the container using docker-compose, execute the following command from the <any_directory>/devo-collectors/<product_name>/
directory:
Code Block |
---|
IMAGE_VERSION=<version> docker-compose up -d |
Note |
---|
Replace |
Rw tab | ||
---|---|---|
|
We use a piece of software called Collector Server to host and manage all our available collectors. If you want us to host this collector for you, get in touch with us and we will guide you through the configuration.
...
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
InitializationThe 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:
Events delivery and Devo ingestionThe 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:
Events delivery and Devo ingestionThe 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:
Sender servicesThe Integrations Factory Collector SDK has 3 different senders services depending on the event type to delivery ( | ||||||||
Sender services | Description | |||||||
| In charge of delivering internal metrics to Devo such as logging traces or metrics. | |||||||
| In charge of delivering pulled events to Devo. | |||||||
Logging trace | Description | |||||||
| Displays the number of concurrent senders available for the given Sender Service. | |||||||
| Displays the items available in the internal sender queue.
| |||||||
| Displayes the number of events from the last time and following the given example, the following conclusions can be obtained:
|
Expand | ||||
---|---|---|---|---|
| ||||
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.
|
Expand | ||
---|---|---|
| ||
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.
For more information, visit the configuration and parameterization section corresponding to the chosen deployment mode. |
Change log
...
Release
...
Released on
...
Release type
...
Details
...
Sender servicesThe Integrations Factory Collector SDK has 3 different senders services depending on the event type to delivery (
Sender statisticsEach service displays its own performance statistics that allow checking how many events have been delivered to Devo by type:
|
Expand | ||||
---|---|---|---|---|
| ||||
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.
|
Expand | ||
---|---|---|
| ||
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.
For more information, visit the configuration and parameterization section corresponding to the chosen deployment mode. |
Change log
Release | Released on | Release type | Details | Recommendations | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| New features
Improvements
Bug Fixing
|
| |||||||||||||||||||
|
|
| New features:
Improvements:
Bug Fixing:
|
| ||||||||||||||||||
|
| Improvements:
Bug Fixing:
|
| |||||||||||||||||||
|
| New features:
Improvements:
|
| |||||||||||||||||||
|
| Fixed bugs:
|
| |||||||||||||||||||
|
| Fixed bugs:
|
| |||||||||||||||||||
|
| Improvements:
|
| |||||||||||||||||||
|
| Improvements:
Bug fixing:
|
| |||||||||||||||||||
|
| New features:
Improvements:
|
|