Architecture Configuration

Logpoint On-premise SIEM consists of three components that perform three important tasks:

  • Log Management & Analytics or Search Head

  • Log Ingestion through Collectors or Fetchers

  • Storage Nodes or Repos

They can be deployed to a single physical appliance or split across multiple dedicated physical servers, virtual servers or cloud-based servers. Smaller organizations may deploy all three components within a single virtual appliance. Larger organizations can divide the components across various network zones to balance load and ensure resiliency.

Connection between your Logpoint appliances or servers can be through Open VPN or through Logpoint Open Door.

Before you setup your environment, consider:

  1. data

  2. location

  3. data access

  4. agents

  5. devices

  6. cloud

  7. retention

  8. legal requirements

  9. load balancing

  10. high availability

  11. security zones

  12. organizational structure

  13. multi-tenancy

  14. geography

Log Management & Analytics or Search Head

The Search Head is the user interface where you control and manage other Logpoint servers and Logpoint products (SIEM, SOAR Automation, Case Management). It distributes queries to relevant repos (storage nodes), collates results, and displays them in the GUI. The Search Head does not store data.

circle-exclamation

For scalability or failover, you can include more than one search head that independently runs and aggregates queries to/from the repos.

Log Ingestion through Collectors

Collectors retrieve log data and buffer it. A Collector listens on dedicated ports, retrieves logs, normalizes (splits messages into key/value pairs), and forwards logs to a Storage Node. Collectors work together with Windows agents to retrieve, encrypt, buffer, and monitor files and the Windows Registry. Collectors also support static enrichment.

A Collector can be deployed at a remote site to aggregate local log streams and perform caching, buffering, and compression before sending the aggregate stream over a single VPN port to the Search Head.

In a Distributed Environment, add a Logpoint Node and convert it to a Collector or Fetcher.

Storage Nodes or Repos

All ingested logs are stored as flat files in individual repositories (repos) in a NoSQL-based database.

When you setup a repo, configure:

  • How long to retain or store log data before automatic discard.

  • Which users or user groups have access to the log data in the repo

  • Whether log data is replicated so you can still access log data even when a server or repository is down or unresponsive.

  • What storage tier data is kept from and moved to automatically. For example, moving older data to a cheaper storage tier.

    • A repo can use multiple storage tiers located on one or more underlying disks because repos are logical spaces rather than physical disk spaces.

Which logs are forwarded to which repos is setup through a Routing Policy that divides incoming log data so it can be forwarded to different repos.

Repos or storage nodes can be located close to their data sources to minimize log traffic egress costs from cloud locations and to minimize network bandwidth requirements. When repos are located close to their data source, only search queries and search responses are transmitted over the WAN.

Your Environment

Environments entirely depend on your data traffic, events per second and geographical location to name just a few. Logpoint Customer Success works closely with our customers to design and apply the right architecture. Your Logpoint Architecture can span On-premise deployments, the Cloud, and off-site locations.

Standalone / All-in-One

Standalone or all-in-one deployments combine collection, normalization, and analytics in a single Logpoint instance.

Example of Standalone or All in One Architecture

If you have an all-in-one/standalone, the same interface is used to:

Sizing

Considerations before setup:

  • Geographic Distribution - where the search head(s), data nodes and collectors will be.

  • Number of events per second - Logpoint can provide you with a spreadsheet to help you or you can also get a general idea using our sizing calculatorarrow-up-right.

  • High Availability and load balancing requirements.

  • Number of live searches you will perform, including dashboards, alert rules, searches and the number of users who will perform these live searches.

  • Number of SOAR Automation playbooks you will use.

  • Number of Repos you need.

  • Log Retention Period.

circle-exclamation

Logpoint Search Head

  • Average live searches: 100

  • Hardware: 4 CPU cores, 18 GB RAM

  • Typical disk use < 200 GB

Data Node (no collector)

HW for 1000 EPS

  • 8 CPU cores

  • 32 GB RAM

  • Disk according to type and retention. Compressed logs and indexes take up the same amount of disk space as raw logs stored directly. Even when raw logs are compressed, the index will require a space ratio of 1:1.

  • HA or shadow repositories require additional resources. Generally speaking, you will need to double the amount of storage and increase CPU cores and RAM.

Collector Node

HW for 1000 EPS

  • 6 CPU cores

  • 16 GB RAM

  • Sufficient disk space for buffering during lost connectivity

Virtual Logpoint

To use a virtual environment, be aware:

  • Some virtual environments have a large number of servers sharing disk access, which can impact I/O.

  • There needs to be enough reserved resources and I/O, or you need to use SSD, if not performance will be poor even if sizing is correctly calculated.

Distributed Logpoint

A full Logpoint server operating with another Logpoint server with Search Head is termed Distributed Logpoint or environment. It segregates indexing and searching between separate instances or servers. The Search Head performs its search searches throughout the logs' index files across your environment's repos.

In distributed environments you can connect multiple nodes operating in different modes to store and analyze logs centrally.

High Availability should be configured to duplicate and store configurations and logs as backups.

Setup Distributed Logpoint

  1. Activate Open Door.

  2. Configure the Search Head.

  3. Add Data Node Connections.

  4. Configure Collector and/or Syslog forwarder.

Open Door

Open Door is the gateway for communication between two Logpoints. It must be activated for a Logpoint to be on a distributed architecture. When activated, it creates a virtual interface (tun10000) that allows secure communication between the two Logpoints.

  1. If the connection is between Distributed Logpoint (DLP) server or instance and Search Head, enable Open Door on the server or instance.

  2. If the connection is between Logpoint Collector (LPC) and Search Head, activate Open Door on the Search Head or main Logpoint.

  3. The private network address must be unique for each Logpoint.

Before activating open door, open the following ports:

Port/Protocol
Reason
Direction

1194/UDP

Allow Open VPN to access the distributed Logpoint

Inbound for DLP-Search Head connection; Outbound for LPC-Search Head connection

443/TCP (HTTPS)

Secure communication for Logpoint

Allow request/response communication to the Search Head/Main Logpoint from the Distributed Logpoint

chevron-rightActivate Open Door hashtag
  1. Go to Settings >> System Settings from the navigation bar and click Open Door.

  2. Activate Open Door.

  3. Copy or enter your Private IP address and Netmask. The IP address must end with .1. Remember it as you must add it when configuring the DLP server.

circle-info

You cannot use the following netmask: 255.255.255.248, 255.255.255.252, 255.255.255.254, 255.255.255.255.

  1. Enter the Maximum Transmissions Unit (MTU) in bytes. This is the maximum packet size that is transferred between Logpoints. The default value is 1500. You can enter a value between 46 and 1500. We recommend you enter a value higher than 1000 to maintain a stable connection. Small values lead to high network overhead, and may cause network failure or instability.

  2. Enter a Password. Remember it as you must add it when configuring the DLP server.

    1. In Logpoint Collector, you must re-enter password under Settings >> Configuration >> Distributed Logpoint in the connected Logpoint Collectors.

    2. In the server or instance in a Distributed Logpoint, you must re-enter password under Settings >> Configuration >> Distributed Logpoint in the main Logpoint.

Activate Open Door in Distributed Logpoint
  1. Click Save Changes.

Search Head or Main Logpoint

The Search Head is the user interface where you control and manage all the other Logpoint machines in your environment in addition to all Logpoint products, including SIEM, SOAR Automation and Case Management. You can collect, index, and store logs from multiple Logpoint machines and search through them from a single, main Search Head.

chevron-rightConfigure the Search Headhashtag
  1. Go to Settings >> System Settings from the navigation bar and click System Settings.

  2. Select General.

  3. Enter a Logpoint Name.

  4. Enter a Browser tab title, a name appended to the tab's title.

  5. Enter or update the Server Alias. Updating it does not update the system IP Address or the DNS.

    1. Identifier is the unique value given to each Logpoint.

    2. Modes ignore. Only relevant for Logpoint Director.

  6. Select the Default Login Screen for the Logpoint.

  7. In Session Inactivity Timeout, Timeout (minutes), enter a specific period of time, in minutes, when Logpoint users are timed out.

  8. Enter the Base Repo Path for High Availability to alter the default path /opt/immune/storage/. It is the base path for the repos from the remote machine.

  9. Select whether the timestamp for searches is:

    1. Collection Timestamp (col_ts) to mark the time when Logpoint collected the log.

    2. Log Timestamp (log_ts) to mark the time when a device generated the log. The time conversion of log_ts occurs when a Normalization Policy is applied to the Collectors/Fetchers.

  10. Choose the Over Scan Period (in minutes and a Time Zone. The overscan period is the extra period (apart from the selected period) when Logpoint searches for logs. Both the col_ts and the log_ts fields are saved in UTC and displayed according to the selected time zone.

    1. Both the log_ts and col_ts key-value pairs are displayed in the search results.

    2. The Time Range is applied either on the col_ts or the log_ts across all the Distributed Logpoints.

  11. Select a Time Zone.

  12. Select Enable SOAR in Logpoint to enable incident investigation with Playbooks and Cases. Go to Getting Started with SOAR for details.

    1. Enabling or disabling SOAR may take some time depending on available memory.

    2. SOAR is always disabled in the Logpoint Collector and Syslog Forwarder modes.

  13. Click Save.

Add Data Nodes

After setting up the Search Head or Main Logpoint, add the additional nodes or distributed Logpoints to create your environment. You will need to add at least one node and then configure it as a collector or forwarder. You can add any additional nodes to make up your environment, you can add data nodes and later convert them to a collector or forwarder. After you have added other nodes, you can switch between them in your main Logpoint. Go to Settings, use the drop-down at the top right.

You can always modify or delete existing nodes.

chevron-rightAdding Data Nodeshashtag
  1. Go to Settings >> Configuration from the navigation bar and click Distributed Logpoint.

  2. Click Add Remote Logpoint.

  3. Enter the IP Address or DNS Name of the remote Logpoint.

  4. Enter the Password and the Private IP from Enabling Open Door on the remote machine.

  1. Click Submit.

The status changes to Connected. If it doesn't, refresh the page.

chevron-rightEditing and Deleting a nodehashtag

Editing a node

  1. Go to Settings >> Configuration from the navigation bar and click Distributed Logpoint.

  2. Click the Name of the Logpoint.

  3. Update the information.

  4. Click Submit.

Deleting a node

  1. Go to Settings >> Configuration from the navigation bar and click Distributed Logpoint.

  2. Click Delete.

  3. Click Yes.

Add a Collector and/or Syslog Forwarder

After you setup the Search Head or main Logpoint and add the nodes for your environment, Setup one of the nodes as a Collector or Syslog Forwarder to get your log data into Logpoint.

Converting Logpoint to a Collector or Syslog Forwarder is done through Modes of Operation.

Modes available:

  1. Logpoint Collector

  2. Syslog Forwarder

You can also convert a regular Logpoint into either a Logpoint Collector or a Syslog Forwarder.

When a Logpoint node accepts incoming log data via Syslog and forwards it to another target, for example a Logpoint Collector you can use a Raw Sys Log Forwarder to export the raw logs to a remote target. Useful when a lot of incoming log streams need to be aggregated and forwarded over the network without each source device having direct connectivity to the destination Logpoint Collector node.

Collector

Collectors ingest normalize, and forward logs to a remote Logpoint. In a standalone Logpoint, add a collector as a device in the Main Logpoint.

Distributed Collectors only collect logs, they have no dashboards. search or report generation capabilities. The remote Logpoint then configures the sources and storage locations for the logs. Before configuring a Distributed Collector, remember to activate Open Door in the remote Logpoint first.

After setting up Distributed Collectors you need to add a device to determine where or from which location the collector will ingest the logs.

You can also add a Syslog Collector Collects logs from the sources that follow the Syslog protocol. These logs are then forwarded to Logpoint for storage and analysis. Users can create syslog collector log sources from scratch or use templates tailored to specific devices or applications.

chevron-rightSet up a Collector hashtag
  1. In Main Logpoint, go to Settings >> Configuration from the navigation bar and click Devices.

  2. Click ADD.

  3. Specify the Collector as a Distributed Collector.

To verify the connection between the devices, switch to the Collector Logpoint.

  1. Go to View Devices from the navigation bar.

chevron-rightConverting the Instance or Server to Collectorhashtag
  1. Go to Settings >> System Settings from the navigation bar and click System Settings.

  2. Select Modes of Operation.

  3. In LOGPOINT COLLECTOR CONFIGURATION, select Is this a Logpoint Collector installation?

  4. Click Enable Buffering to store the data in local persistence storage during a network outage. By default, the logs are stored in the buffer for 7 days. To change the default retention period, contact Logpoint Support.

  1. Click Save Changes.

Switch to the Main Logpoint or Search Head.

  1. Go to Settings >> System Settings from the navigation bar and click Open Door.

  2. Select Open Door.

  3. Note the Private IP and the Password.

Go to Settings >> Configuration from the navigation bar and click Remote Logpoint.

  1. Enter the IP Address of the Main Logpoint, the Password, and the Private IP.

The Collector is added under Settings >> Configuration from the navigation bar.

  1. Click Distributed Collector in the Main Logpoint and activate it from the Actions column.

Fetchers

Syslog Forwarder File Fetcher is configured to fetch logs from remote targets. Once fetched, the logs are stored in Logpoint for centralized management and analysis.

chevron-rightAdding a Logpoint Collector in Standalone or All in One Environmenthashtag
  1. In the Main Logpoint, go to Settings >> Configuration from the navigation bar and click Devices.

  2. Click Add.

  3. Specify the Collector as a Distributed Collector.

  4. To verify the connection between the devices, switch to the Collector Logpoint.

  5. Go to View Devices.

  • If you disable the Collector, make sure that you remove it from the list of devices on the Main Logpoint.

  • If you change the password on the Collector machine from Settings >> Remote Logpoint, all the services of the Collector restart. The logs are not collected until the Collectors and Fetchers are up and running.

chevron-rightConfiguring Distributed Collectorshashtag
  1. Log in to the Logpoint to add as a Collector.

  2. Go to Settings >> System Settings from the navigation bar and click System Settings.

  3. Click Modes of Operation.

  4. Select Is this Logpoint Collector Installation?.

  1. Click Enable Buffering to store data locally during network disruptions and have access to it once the network is restored. By default, the logs are stored in the buffer for 7 days. If you want to change the default retention period, contact Logpoint Support.

  2. Click Save.

  3. Go to Settings >> Configuration from the navigation bar and click Remote Logpoint.

  4. Enter the IP address or DNS Name of the remote Logpoint.

  5. Enter the Password and Private IP provided while enabling Open Door.

  1. Click Submit.

To view that the collector is added, login to the remote Logpoint and go to Settings >> Configuration>>Distributed Collector. The collector is listed under Distributed Collectors.

chevron-rightAdding Deviceshashtag

To determine the devices from which a Distributor Collector collects logs, you need to add devices in the remote Logpoint.

To add a device:

  1. In the remote Logpoint, go to Settings >> Configuration from the navigation bar and click Devices.

  2. At the top-left, click ADD.

  3. Enter Name, Device Address(es), Device Groups, and Log Collection Policy.

  4. In Distributed Collector, enter the Logpoint Collector's name.

  5. Select your Time Zone.

  6. Click Submit.

To view the added devices, go to View Devices in the Logpoint Collector.

Syslog Collector

Syslog Collector collects logs from the sources that follow the Syslog protocol. Users can create syslog collector log sources from scratch or use templates tailored to specific devices or applications. Syslog Collector is typically used when logs need to be standardised, normalized, and enhanced before forwarding.

chevron-rightConfiguring a Syslog Collectorhashtag

You can add a custom TLS certificate for log collection via Syslog. The added certificate is used by the Syslog collector to collect logs through TLS on port 6514.

  1. Go to Settings >> System Settings from the navigation bar and click System Settings.

  2. Select Syslog.

  3. Upload your TLS Certificate and Key. The certificate must have the .crt extension and the key must have the .key extension. Only Logpoint Administrators can add a certificate and key. The certificate must be of PEM encoded x.509 standard.

  4. Select Add sequence numbers on log received from syslog collector to enter a sequence number to the syslogs. The number is assigned on a device per protocol basis to each log collected from the Syslog Collector.

  5. In Message length, you can define the size for Syslog messages. The maximum message size can be 64 KB, with a default size of 12 KB. Any message that exceeds the maximum size is divided into multiple events and truncated at the defined size. For example, if the message length is 40 KB, logs larger than that size are chunked into 40 KB segments.

Add or Configure Syslog Collector
  1. Click Save.

Syslog Forwarder

Syslog Forwarder collects logs from different sources, normalizes them using the signatures applied, and forwards them to a configured Logpoints and a target storage. Unlike Logpoint Collectors, Syslog Forwarder can not act as a buffer.

Syslog Forwarder supports Air Gap. The Main Logpoints are usually located in high-security zones whereas Syslog Forwarders and other devices are in low-security zones.

chevron-rightConverting Logpoint to Syslog Forwarder hashtag
  1. Go to Settings >> System settings from the navigation bar and click System Settings.

  2. Select Modes of Operation.

  3. In Syslog Forwarder, select the Is this a Syslog Forwarder installation?.

  1. Click Save.

Using a Syslog Forwarder

Before using a Syslog Forwarder:

  • Export a config file from Main Logpoint

  • Import the config file on the Syslog Forwarder

  • Add target(s)

  • Add target storage for air gap

  • Add devices

chevron-rightExporting a config filehashtag
  1. Switch to the Main Logpoint and go to Settings >> Configuration from the navigation bar and click Distributed Logpoints.

  2. Add a Syslog Forwarder. See Adding a Syslog Forwarder.

  3. Click the Export configuration icon in the Actions column of the relevant Syslog Forwarder.

  4. The config file is downloaded on your machine.

  5. Save the config file.

chevron-rightImporting a config filehashtag
  1. Switch to the Syslog Forwarder and go to Settings >> System Settings from the navigation bar and click Sync.

  2. Click Import Data.

  3. Browse to the config file saved earlier.

chevron-rightAdding a Targethashtag

Targets are Logpoints nodes that receive logs from Syslog Forwarder.

  1. On the Syslog Forwarder, go to Settings >> Configuration from the navigation bar and click Syslog Forwarder.

  2. Click Targets.

  3. Click Add IP.

  4. Enter the Name and IP address of the target.

  5. Specify the Pattern of the logs to be forwarded. If you do not specify a pattern, all the logs are forwarded.

  6. Enter a Port number for the input port of the remote target machine.

  7. Select Enable UDP to use the User Datagram Protocol (UDP). TCP is used by default. After selecting UDP, choose the UDP size in bytes.

  1. Click Submit.

chevron-rightAdding Target Storagehashtag

Target storage enables airgap in low-security zones. You can add multiple Remote Targets but only oneTarget Storage. For each IP added as a Remote Target, add Syslog Forwarder in the target Logpoint.

  1. On the Syslog Forwarder, go to Settings >> Configuration from the navigation bar and click Syslog Forwarder.

  2. Click Targets. Click Add Storage.

  3. Enter a Name for the storage.

  4. Specify the Path to the remote storage. The format should be:

//<IP Address>/<Path>/

For example: //192.168.2.247/storage/

  1. Enter or type the Pattern of the forwarded logs. If you do not specify a pattern, all the logs are forwarded.

  2. Enter a Username and Password.

  1. Click Submit.

chevron-rightAdding a Devicehashtag
  1. On the Syslog Forwarder, go to Settings >> Configuration from the navigation bar and click Syslog Forwarder.

  2. Click Add.

  3. Device lists all the devices configured as a Syslog Forwarder in the Main Logpoint. To select a device, double-click it.

  4. In Remote Target(s) enter the IP or a remote storage IP address.

  5. Click Submit.

Syslog Forwarder File Fetcher

Syslog Forwarder File Fetcher is configured to fetch logs from remote targets. Once fetched, the logs are stored in Logpoint for centralized management and analysis.

chevron-rightConfiguring a Syslog Forwarderhashtag
  1. Go to Settings >> Configuration and click on Devices.

  2. Find the Remote Target and click on the "+" icon in the Actions column.

  3. Select Syslog Forwarder File Fetcher.

  4. Enter or type

    1. Charset: <relevant charset> . Default is utf8.

    2. Remote Path: <remote storage path>

    3. Username: <username of remote machine>

    4. Password: <password of remote machine>

  1. Click Submit.

Raw Syslog Forwarder

Raw Syslog Forwarders collect and forward raw logs from a Logpoint to a remote target.

You can enable IP Spoofing to directly add the log collection devices in the target Logpoint instead of adding them in the raw syslogforwarder and still distinguish the Logpoint where the logs are collected.

To use Raw Syslog Forwarders, you must configure

  • target(s) or which devices the raw syslog messages are forwarded

  • device(s) or where Logpoint will collect and forward the raw syslog messages

To view logs forwarded from a localhost, you must add the IP of the Raw Syslog Forwarder to the remote target. You have to add a device in target logpoint and configure its syslog collector to view the logs forwarded from that device. A remote target supports both TCP and UCP for localhost; however, it supports only UDP for other devices.

chevron-rightAdding a Targethashtag
  1. Go to Settings >> Configuration from the navigation bar and click Raw Syslog Forwarder.

  2. Click Targets.

  3. Click Add IP.

  4. Provide the Name, IP address, and Port number for the input port of the target.

  5. Select the Protocol to send the syslog message. If you choose TCP IP spoofing is disabled.

  6. Click Submit.

Repeat steps to add more targets.

chevron-rightView Logs in Remote Targethashtag

To view logs from localhost, you must add the IP of the Raw Syslog Forwarder to the remote target. You must also configure its Syslog Collector.

When forwarding localhost logs, Logpoint adds additional data in the header and sends the original message in the following format:

Example:

Original: 2016-01-29_06:00:20.70969 Starting report_jobs Forwarded: <13> Jan 29 06:00:25 localhost 2016-01-29_06:00:20.70969 Starting report_jobs.

chevron-rightEditing a Targethashtag
  1. Go to Settings >> Configuration from the navigation bar and click Raw Syslog Forwarder.

  2. Click Targets.

  3. Click the Name of the relecant target.

  4. Update the information.

  5. Click Submit.

chevron-rightDeleting a Targethashtag

Before you delete a target, make sure it isn't in use.

  1. Go to Settings >> Configuration from the navigation bar and click Raw Syslog Forwarder.

  2. Click Targets.

  3. Click Delete.

  4. Click Yes.

chevron-rightAdding Deviceshashtag
  1. Go to Settings >> Configuration from the navigation bar and click Raw Syslog Forwarder.

  2. Click Add.

  3. Double-click the devices or device groups to select them. If you select All for a device group, any device added to it in the future is automatically selected as a target.

  4. Select the Remote Target(s).

  5. Enter a regex Pattern to match before forwarding logs. Only the logs matching the specified pattern are forwarded. For example:

  • [ 0-9 ]+ forwards a log only if a digit is present in logs.

  • [ a-z A-Z 0-9 ]+ forwards a log only if it contains either a-z, A-Z, or 0-9.

  • \S+ forwards all the logs.

  1. Click Submit.

The Raw Syslog Forwarder now collects logs from the selected devices and forwards the raw logs to the designated targets.

chevron-rightEditing Deviceshashtag
  1. Go to Settings >> Configuration from the navigation bar and click Raw Syslog Forwarder.

  2. Click the Device of the required Raw Syslog Forwarder.

  3. Update the information.

  4. Click Submit.

chevron-rightDeleting Deviceshashtag
  1. Go to Settings >> Configuration from the navigation bar and click Raw Syslog Forwarder.

  2. Click Delete.

    1. To delete multiple Raw Syslog Forwarders, select the concerned forwarders, click More and select Delete Selected.

    2. To delete all the forwarders, click More and select Delete All.

  3. Click Yes

Last updated

Was this helpful?