--- title: "ExtraHop Reveal(x) collector" canonical: "https://docs.devo.com/space/latest/513474600/ExtraHop%20Reveal(x)%20collector" format: markdown --- > Macro (toc) ## Overview ExtraHop Reveal(x) provides complete east-west visibility, real-time threat detection inside the perimeter, and intelligent response at scale. Use this collector to send ExtraHop Reveal(x) logs to Devo. ## 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** | | --- | --- | --- | --- | --- | --- | | `Alerts` | `Get all the alert events` | `v1/alerts` | `alerts` | `ndr.extrahop.``revealx360.alerts` | `v1.2.0` | | Detections | `Get all the detection events` | `v1/detections` | `detections` | `ndr.extrahop.revealx360.detection` | `v1.2.0` | For more information on how the events are parsed, [visit our page](https://devodocs.atlassian.net/wiki/spaces/latest/pages/357990442). ## Flattening preprocessing | **Data source** | **Collector service** | **Optional** | **Flattening details** | | --- | --- | --- | --- | | `alerts` | `alerts` | yes | Not required | | `detection` | `detection` | yes | Not 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** | | --- | --- | | `hostname` | The hostname to ExtraHop Reveal(x) 360 API. (Ex : Base URL- `https://{hostname}.api.cloud.extrahop.com/api/v1`) | | `client_id` | The ID for ExtraHop Reveal(x) 360 API. | | `token_endpoint` | The token endpoint for to get the access token. ( Ex:-`https://{hostname}.api.cloud.extrahop.com/oauth2/token)` | | `secret` | The secret to ExtraHop Reveal(x) 360 API | > ℹ️ See the **Accepted authentication methods** section to verify what settings are required based on the desired authentication method. ## Accepted authentication methods | **Authentication method** | **hostname** | **token_endpoint** | **client_id** | **secret** | | --- | --- | --- | --- | --- | | `credentials` | [REQUIRED] | [REQUIRED] | [REQUIRED] | [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 (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector). > 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. If you want us to host this collector for you, [get in touch with us](mailto:support@devo.com) and we will guide you through the configuration. > > > 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: > > ``` > > └── devo-collectors/ > └── / > ├── certs/ > │ ├── chain.crt > │ ├── .key > │ └── .crt > ├── state/ > └── config/ > └── config.yaml > ``` > > > ⚠️ Replace `` 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 `/certs/`. Learn more about security credentials in Devo [here](#). > > ![image-20240221-082004.png](media://57bf11e2-ff55-4030-98ed-f965ca77e13b) > > > ⚠️ Replace `` with the proper value. > > ### Editing the config.yaml file > > ``` > globals: > debug: false > id: not_used > name: extrahop_revealx_collector > persistence: > type: filesystem > config: > directory_name: state > > outputs: > devo_1: > type: devo_platform > config: > address: > port: 443 > type: SSL > chain: chain.crt > cert: .crt > key: .key > inputs: > extrahop_revealx: > id: > enabled: true > credentials: > hostname: > token_endpoint: > client_id: > secret: > services: > alerts: > request_period_in_seconds: > override_tag: > ``` > > > ℹ️ 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** | > | --- | --- | --- | --- | --- | > | `` | `int` | `Mandatory` | `Minimum Lenght 5` | Use this param to give a unique id to this input service.
> ⚠️ This parameter is used to build the persistence address, do not use the same value for multiple collectors. It could cause a collision. | > | `` | `bool` | `Mandatory` | `false` / `true` | Use this param to enable or disable the given input logic when running the collector. If the value is `true`, the input will be run. If the value is `false`, it will be ignored. | > | `` | `str` | `Mandatory` | `Minimum Length 1` | Host name for ExtraHop Revealx | > | `` | `str` | `Mandatory` | `Minimum Length 1` | Token_endpoint for ExtraHop Revealx API to get access token | > | `` | `str` | `Mandatory` | `Minimum Length 1` | This configuration helps to get the required client id | > | `` | `str` | `Mandatory` | `Minimum Length 1` | Secret of the ExtraHop Reveal API to get the access_token | > | `` | `int` | `Optional` | `Minimum Length 1` | Period in seconds used between each data pulling, this value will overwrite the default value 60 seconds | > | `` | `str` | `Optional` | A Devo tag | This parameter allows to define a custom Devo tag. | > > ### 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-extrahop_revealx_if-docker-image-1.2.0](https://drive.google.com/file/d/1ZVLg0qpMyjiGDdqNInt9FngigLNR4hb6/view?usp=drive_link) | `6b1ac61dbe3d6d2867e9f9bb92668652a7dc3df07712ae6eda17076b8a56e9c2` | > > Use the following command to add the Docker image to the system: > > ``` > gunzip -c -.tgz | docker load > ``` > > > ⚠️ Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace `` and `` with a proper value. > > The Docker image can be deployed on the following services: > > #### Docker > > Execute the following command on the root directory `/devo-collectors//` > > ``` > docker run > --name collector- > --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 > : > ``` > > > ⚠️ Replace ``, `` and `` 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 `/devo-collectors//` directory. > > ``` > version: '3' > services: > collector-: > image: :${IMAGE_VERSION:-latest} > container_name: collector- > 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 `/devo-collectors//` directory: > > ``` > IMAGE_VERSION= docker-compose up -d > ``` > > > ⚠️ Replace ``, `` and `` with the proper values. ## Collector services detail This section is intended to explain how to proceed with specific actions for services. ### Alerts
Verify data collection 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: ``` DevoSenderManager(internal_senders,manager,devo_us_1) -> Starting thread 2024-02-16T11:55:03.476 INFO InputProcess::MainThread -> Validating the rate limiter config given by the user 2024-02-16T11:55:03.476 INFO InputProcess::MainThread -> setting has not been defined. The generic settings will be used instead. 2024-02-16T11:55:03.476 INFO InputProcess::MainThread -> Adding raw config to the collector store 2024-02-16T11:55:03.476 INFO InputProcess::MainThread -> Running custom validation rules 2024-02-16T11:55:03.476 INFO InputProcess::MainThread -> Creating API client. 2024-02-16T11:55:03.477 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputInternalConsumer(internal_senders_consumer_0) -> Nothing retrieved from the persistence. 2024-02-16T11:55:03.477 INFO InputProcess::MainThread -> Created request client: 2024-02-16T11:55:03.477 INFO InputProcess::MainThread -> ExtraHopPuller(extrahop_revealx,1212345,alerts,predefined) Finalizing the execution of init_variables() 2024-02-16T11:55:03.477 INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_us_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(internal_senders,manager,devo_us_1) -> Nothing retrieved from the persistence. 2024-02-16T11:55:03.478 INFO InputProcess::MainThread -> InputThread(extrahop_revealx,1212345) - Starting thread (execution_period=60s) 2024-02-16T11:55:03.478 INFO InputProcess::MainThread -> ServiceThread(extrahop_revealx,1212345,alerts,predefined) - Starting thread (execution_period=60s) 2024-02-16T11:55:03.478 INFO InputProcess::MainThread -> ExtraHopPullerSetup(exatrhop_revealx_collector,extrahop_revealx#1212345,alerts#predefined) -> Starting thread 2024-02-16T11:55:03.478 INFO InputProcess::MainThread -> ExtraHopPuller(extrahop_revealx,1212345,alerts,predefined) - Starting thread 2024-02-16T11:55:03.478 WARNING InputProcess::ExtraHopPuller(extrahop_revealx,1212345,alerts,predefined) -> Waiting until setup will be executed 2024-02-16T11:55:03.478 WARNING InputProcess::ExtraHopPullerSetup(exatrhop_revealx_collector,extrahop_revealx#1212345,alerts#predefined) -> The token/header/authentication has not been created yet 2024-02-16T11:55:03.479 INFO InputProcess::ExtraHopPullerSetup(exatrhop_revealx_collector,extrahop_revealx#1212345,alerts#predefined) -> First run of the collector. Generating new access token. 2024-02-16T11:55:03.490 INFO OutputProcess::MainThread -> [GC] global: 34.2% -> 34.3%, process: RSS(43.61MiB -> 44.36MiB), VMS(929.29MiB -> 929.29MiB) 2024-02-16T11:55:03.498 INFO InputProcess::MainThread -> [GC] global: 34.2% -> 34.3%, process: RSS(43.26MiB -> 43.26MiB), VMS(497.02MiB -> 497.02MiB) 2024-02-16T11:55:04.007 INFO OutputProcess::DevoSender(internal_senders,devo_sender_0) -> Created a sender: {"name": "DevoSender(internal_senders,devo_sender_0)", "url": "collector-eu.devo.io:443", "chain_path": "/home/mdtausif/Gitlab/devo-collector-extrahop-reveal/certs/chain.crt", "cert_path": "/home/mdtausif/Gitlab/devo-collector-extrahop-reveal/certs/int-if-integrations-india.crt", "key_path": "/home/mdtausif/Gitlab/devo-collector-extrahop-reveal/certs/int-if-integrations-india.key", "transport_layer_type": "SSL", "last_usage_timestamp": null, "socket_status": null}, hostname: "2023-apac-0046", session_id: "139886749536368" 2024-02-16T11:55:06.489 INFO InputProcess::ExtraHopPullerSetup(exatrhop_revealx_collector,extrahop_revealx#1212345,alerts#predefined) -> Setup for module has been successfully executed ``` #### Puller output A successful initial run has the following output messages for the puller module: ``` 2024-02-16T12:29:07.496 INFO InputProcess::ExtraHopPuller(extrahop_revealx,1212345,alerts,predefined) -> Pull Started 2024-02-16T12:29:07.497 INFO InputProcess::ExtraHopPuller(extrahop_revealx,1212345,alerts,predefined) -> Fetching the data for extraHop 2024-02-16T12:29:09.029 INFO InputProcess::ExtraHopPuller(extrahop_revealx,1212345,alerts,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1708066747496):Number of requests made: 1; Number of events received: 9; Number of duplicated events filtered out: 9; Number of events generated and sent: 0; Average of events per second: 0.000. 2024-02-16T12:29:09.029 INFO InputProcess::ExtraHopPuller(extrahop_revealx,1212345,alerts,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1708066747496):Number of requests made: 1; Number of events received: 9; Number of duplicated events filtered out: 9; Number of events generated and sent: 0; Average of events per second: 0.000. ``` After a successful collector’s execution (that is, no error logs found), you will see the following log message: ``` 2024-02-16T12:29:09.029 INFO InputProcess::ExtraHopPuller(extrahop_revealx,1212345,alerts,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1708066747496):Number of requests made: 1; Number of events received: 9; Number of duplicated events filtered out: 9; Number of events generated and sent: 0; Average of events per second: 0.000. ```
Restart the persistence 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 `request_period_in_seconds` 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.
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. | **Error type** | **Error ID** | **Error message** | **Cause** | **Solution** | | --- | --- | --- | --- | --- | | SetupError | 100 | HTTP Error occurred while retrieving events from ExtraHop server | Client_id, Secret or token_endpoint are not correct | Make sure that credentials are correct. | | 101 | Error occurred while retrieving events from ExtraHop server | Access_token is expired or invalid | Contact team in this case | | PullError | 300 | HTTP Error occurred while retrieving events from ExtraHop server : {summery} , {details} | This error happens when the collector tries to fetch the data from API. | In this error you will find the HTTP error code as well as the summary and details. | | 301 | Some Error occurred while retrieving events from ExtraHop server : {Exception} | Some exceptions occurred while making the API request. | Reach out to the developer with the exact error message. |
## Collector operations This section is intended to explain how to proceed with specific operations of this collector.
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: ``` DevoSenderManager(standard_senders,manager,devo_us_1) -> Starting thread 2024-02-16T11:55:03.475 INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> Starting thread 2024-02-16T11:55:03.475 INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_us_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(standard_senders,manager,devo_us_1) -> Nothing retrieved from the persistence. 2024-02-16T11:55:03.475 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(lookup_senders,devo_us_1) -> Starting thread (every 300 seconds) 2024-02-16T11:55:03.475 INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputStandardConsumer(standard_senders_consumer_0) -> Nothing retrieved from the persistence. 2024-02-16T11:55:03.476 INFO InputProcess::MainThread -> Validating service input config 2024-02-16T11:55:03.476 INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_us_1) -> Starting thread 2024-02-16T11:55:03.476 INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread 2024-02-16T11:55:03.476 INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputLookupConsumer(lookup_senders_consumer_0) -> Nothing retrieved from the persistence. 2024-02-16T11:55:03.476 INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_us_1) -> Starting thread (every 300 seconds) 2024-02-16T11:55:03.476 INFO InputProcess::MainThread -> Running overriding rules 2024-02-16T11:55:03.476 INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_us_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(lookup_senders,manager,devo_us_1) -> Nothing retrieved from the persistence. 2024-02-16T11:55:03.476 INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_us_1) -> Starting thread 2024-02-16T11:55:03.476 INFO InputProcess::MainThread -> Validating the rate limiter config given by the user 2024-02-16T11:55:03.476 INFO InputProcess::MainThread -> setting has not been defined. The generic settings will be used instead. 2024-02-16T11:55:03.476 INFO InputProcess::MainThread -> Adding raw config to the collector store 2024-02-16T11:55:03.476 INFO InputProcess::MainThread -> Running custom validation rules 2024-02-16T11:55:03.476 INFO InputProcess::MainThread -> Creating API client. 2024-02-16T11:55:03.477 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputInternalConsumer(internal_senders_consumer_0) -> Nothing retrieved from the persistence. 2024-02-16T11:55:03.477 INFO InputProcess::MainThread -> Created request client: 2024-02-16T11:55:03.477 INFO InputProcess::MainThread -> ExtraHopPuller(extrahop_revealx,1212345,alerts,predefined) Finalizing the execution of init_variables()Events delivery and Devo ingestion ``` ### 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: ``` 2024-02-16T12:30:03.484 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_us_1) -> Number of available senders: 1, sender manager internal queue size: 0 2024-02-16T12:30:03.485 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_us_1) -> enqueued_elapsed_times_in_seconds_stats: {} 2024-02-16T12:30:03.485 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_us_1) -> Sender: DevoSender(lookup_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": False} 2024-02-16T12:30:03.485 INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_us_1) -> Lookup - Total number of messages sent: 0, messages sent since "2024-02-16 06:55:03.484110+00:00": 0 (elapsed 0.000 seconds) 2024-02-16T12:30:03.535 INFO InputProcess::InputStatsThread -> Input metrics sent: 3 2024-02-16T12:30:03.536 INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> Consumed messages: 9, total_bytes: 6919 (60.001823 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.
> ℹ️ 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: 0, messages sent since "2024-02-16 06:55:03.484110+00:00": 0 (elapsed 0.000 seconds)` | Displays the number of events from the last time and following the given example, the following conclusions can be obtained:
- 44 events were sent to Devo since the collector started. - The last checkpoint timestamp was `2024-02-16 06:55:03.484110+00:00`. - 0 events where sent to Devo between the last UTC checkpoint and now. - Those 0 events required `0.000 seconds` to be delivered.
> ℹ️ By default these traces will be shown every 10 minutes. |
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` ``` 2024-02-16T11:55:03.490 INFO OutputProcess::MainThread -> [GC] global: 34.2% -> 34.3%, process: RSS(43.61MiB -> 44.36MiB), VMS(929.29MiB -> 929.29MiB) 2024-02-16T11:55:03.498 INFO InputProcess::MainThread -> [GC] global: 34.2% -> 34.3%, process: RSS(43.26MiB -> 43.26MiB), VMS(497.02MiB -> 497.02MiB) ``` > ℹ️ Differences between `RSS` and `VMS` memory usage: > ℹ️ > ℹ️ - `RSS` is the Resident Set Size, which is the actual physical memory the process is using > ℹ️ - `VMS` is the Virtual Memory Size which is the virtual memory that process is using
## Change log | **Release** | **Released on** | **Release type** | **Details** | **Recommendations** | | --- | --- | --- | --- | --- | | `v1.2.0` | 3/21/2024 | [IMPROVEMENTS] [FEATURES] | - Updated the DCSDK version to 1.11.1 - Added a new service `detections` - Added auto-update feature | `Recommended version` | | `v1.1.0` | 2/20/2024 | [IMPROVEMENTS] | Updated the DCSDK version to 1.11.0 | `Update` | | `v1.0.0` | 2/16/2024 | [FIRST RELEASE] | Released the first version of the ExtraHop Revealx collector. | `Initial release` |