Installation

System Requirements

  • Distribution: Debian 10+

Minimum:

  • CPU: x86_64, 4 cores, SSE 4.2
  • RAM: 4 Gb
  • HDD: 2 Gb

Recommended:

  • CPU: x86_64, 4 cores, SSE 4.2
  • RAM: 16+ Gb
  • HDD: 1+ Tb

Installation

Collector is distributed as Docker images stored on our server. To access them, contact us

You need access from the target machine to the distribution repositories.

Run commands as root.

1. Configure hugepages

Collector requires configured hugepages (large memory pages).

Example of allocating 128 pages × 2 MB:

sysctl -w vm.nr_hugepages=128

Example of setting up the allocation on system boot:

echo 'vm.nr_hugepages = 128' > /etc/sysctl.d/hugepages.conf

2. Install Docker and Docker Compose

Following the official installation documentation for your OS:

3. Download docker-compose.yml file

mkdir -p /srv/collector && cd /srv/collector
wget https://docs.mitigator.ru/collector/v23.08/dist/docker-compose.yml

4. Download GeoIP databases (optional)

Collector comes with several customized Grafana panels. Some of them use GeoIP. In order for them to work, you need to download the free database GeoLite2 in CSV format and unzip files to the geolite2 directory:

/srv/collector/
    docker-compose.yml
    geolite2/
        GeoLite2-City-Blocks-IPv4.csv
        (Other GeoLite2 files)

Unpacked files need to be processed with the command:

find geolite2 -name '*.csv' -exec sed -e "s|,\('[^,]\+\)|,\"\1\"|g" -i {} \;

If GeoIP database is added to an already working Collector installation, remove geolite2 directory with all of its content before deploying the files. After deploying, restart ClickHouse as follows:
docker-compose rm -sf clickhouse && docker-compose up -d clickhouse

5. Configure the environment

Create .env file in /srv/collector directory with following content:

```
COMPOSE_FILE=docker-compose.yml
COLLECTOR_HOST_ADDRESS=X.X.X.X
VERSION=vXX.XX.X
```

Set VERSION to a specific [Collector version]({{ ref “/versions” }}).

Set COLLECTOR_HOST_ADDRESS to a specific host IP address.

6. Login to docker.mitigator.ru

docker login docker.mitigator.ru

7. Run Collector

docker-compose up -d