Fortinet white logo
Fortinet white logo

User Guide

ClickHouse Storage Regions

ClickHouse Storage Regions

Before Release 7.5.0, when a Collector or an external device sends events to a (Event Upload) Worker, that worker will distribute events to all ClickHouse Data Nodes. Starting with Release 7.5.0, you can have storage separation, meaning that events from specific collectors/devices can be stored in specific ClickHouse Data Nodes, with no overlap.

To accomplish this:

  1. You need to form ClickHouse Regions. Each ClickHouse Region includes

    • One or more Event Upload Workers

    • One or more ClickHouse Shards

    Event Upload Workers and ClickHouse Shards must be non-overlapping across ClickHouse Regions.

  2. You need to configure a Collector or an external device to send events to any Event Upload Worker of the region.

Step 1: Creating a ClickHouse Region

Make sure that you have already configured the ClickHouse Cluster and defined the Shards.

To configure a ClickHouse Region, take the following steps.

  1. Navigate to Admin > Settings > Database > ClickHouse Regions.

  2. If you have not configured any regions, you will see a Default Region that includes all Shards and Event Upload Workers. Click + to create a new ClickHouse Region configuration.

  3. In the Name field, enter a name for the ClickHouse Region storage configuration.

  4. From the Shards drop-down, select the shards belonging to the region. Click + to add more Shards for the region.

  5. From the Event Upload Workers drop-down, select the event upload workers for the region. Click + to add more Event Upload Workers.

  6. When done, click Save.

  7. Click the Apply () icon to apply the saved changes.

Step 2: Configuring Collector to Forward Events to a Worker Belonging to a Region

If your Collectors are directly sending events to a Worker, then

  1. For Service Provider deployments, navigate to Admin > Setup > Organization. For Enterprise deployments, navigate to Admin > Setup > Collector.

  2. Select the Collector and click the Edit () icon.

  3. Set Event Worker to the IP address of an Event Upload Worker in the region. This will enable the Collector to send to the specific Workers in the Region.

  4. Click Save.

If your Collectors are sending via a Load Balancer, then configure the Load Balancer so that Collectors events are only sent to the Workers in the Region.

ClickHouse Storage Regions

ClickHouse Storage Regions

Before Release 7.5.0, when a Collector or an external device sends events to a (Event Upload) Worker, that worker will distribute events to all ClickHouse Data Nodes. Starting with Release 7.5.0, you can have storage separation, meaning that events from specific collectors/devices can be stored in specific ClickHouse Data Nodes, with no overlap.

To accomplish this:

  1. You need to form ClickHouse Regions. Each ClickHouse Region includes

    • One or more Event Upload Workers

    • One or more ClickHouse Shards

    Event Upload Workers and ClickHouse Shards must be non-overlapping across ClickHouse Regions.

  2. You need to configure a Collector or an external device to send events to any Event Upload Worker of the region.

Step 1: Creating a ClickHouse Region

Make sure that you have already configured the ClickHouse Cluster and defined the Shards.

To configure a ClickHouse Region, take the following steps.

  1. Navigate to Admin > Settings > Database > ClickHouse Regions.

  2. If you have not configured any regions, you will see a Default Region that includes all Shards and Event Upload Workers. Click + to create a new ClickHouse Region configuration.

  3. In the Name field, enter a name for the ClickHouse Region storage configuration.

  4. From the Shards drop-down, select the shards belonging to the region. Click + to add more Shards for the region.

  5. From the Event Upload Workers drop-down, select the event upload workers for the region. Click + to add more Event Upload Workers.

  6. When done, click Save.

  7. Click the Apply () icon to apply the saved changes.

Step 2: Configuring Collector to Forward Events to a Worker Belonging to a Region

If your Collectors are directly sending events to a Worker, then

  1. For Service Provider deployments, navigate to Admin > Setup > Organization. For Enterprise deployments, navigate to Admin > Setup > Collector.

  2. Select the Collector and click the Edit () icon.

  3. Set Event Worker to the IP address of an Event Upload Worker in the region. This will enable the Collector to send to the specific Workers in the Region.

  4. Click Save.

If your Collectors are sending via a Load Balancer, then configure the Load Balancer so that Collectors events are only sent to the Workers in the Region.