README.md

soy-log-generator

Introduction

This project sends the messages got from the log files to soy_log_collector.

Build

Prepare the build environment. we use the go with 1.16 version.

sudo apt update -y && sudo apt install -y python3
rm -rf /usr/local/go && tar -C /usr/local -xzf go1.16.7.linux-amd64.tar.gz
export PATH=$PATH:/usr/local/go/bin

Build this program by using the below commands.

git clone --recurse-submodules https://github.com/soyoslab/soy_log_generator.git
cd soy_log_generator
make test && make

Usage

Set the valid environment variables.

export GENERATOR_NAMESPACE=test-server
export GENERATOR_TARGET_IP=${LOG_COLLCETOR_IP}
export GENERATOR_TARGET_PORT=${LOG_COLLCETOR_PORT}
export GENERATOR_HOT_RING_CAPACITY=8 # Max lines ring can contain
export GENERATOR_COLD_RING_CAPACITY=32
export GENERATOR_HOT_RING_THRESHOLD=2 # Max lines from ring to extract
export GENERATOR_COLD_RING_THRESHOLD=2
export GENERATOR_COLD_TIMEOUT_MILLIS=3000 # Maximum time to be able to exist in ring
export GENERATOR_COLD_SEND_THRESHOLD_BYTES=4096
export GENERATOR_POLLING_INTERVAL_MILLIS=1000
export GENERATOR_FILES='[{"filename":"/var/log/*log","hotFilter":["error","failed","critical"]},]'

Generate the configuration file by using the configuration generator script.

python3 ./scripts/config-file-generator.py

Now, the config.json file is generated and you can run the program.

sudo make generator-run

If you want to modify the configuration, you open the config.json file and fix the parameter. Each parameter meaning is described below. In other words, you only create the config.json file to the working directory is ok without using the auto-configuration generator.

{
    "namespace": $GENERATOR_NAMESPACE,
    "targetIp": $GENERATOR_TARGET_IP,
    "targetPort": $GENERATOR_TARGET_PORT,
    "hotRingCapacity": $GENERATOR_HOT_RING_CAPACITY,
    "coldRingCapacity": $GENERATOR_COLD_RING_CAPACITY,
    "coldTimeoutMilli": $GENERATOR_POLLING_INTERVAL_MILLIS,
    "hotRingThreshold": $GENERATOR_HOT_RING_THRESHOLD,
    "coldRingThreshold": $GENERATOR_COLD_RING_THRESHOLD,
    "coldSendThresholdBytes": $GENERATOR_COLD_SEND_THRESHOLD_BYTES,
    "pollingIntervalMilli": $GENERATOR_POLLING_INTERVAL_MILLIS,
    "files": [
        {
            "filename": "/var/log/*log",
            "hotFilter": [
                "error",
                "failed",
                "critical"
            ]
        }
    ]
}

Docker

You can build the docker image.

sudo pip install git-archive-all
sudo make gen-src-archive
sudo mkdir -p /tmp/dockerize/generator
sudo tar xvzf build/generator.src.tar.gz --strip 1 -C /tmp/dockerize/generator
sudo docker build -t generator:latest -f scripts/Dockerfile /tmp/dockerize

Now you need the docker environment file named .env in your localhost machine. Its contents are like below.

GENERATOR_NAMESPACE=test-server
GENERATOR_TARGET_IP=${LOG_COLLCETOR_IP}
GENERATOR_TARGET_PORT=${LOG_COLLCETOR_PORT}
GENERATOR_HOT_RING_CAPACITY=8
GENERATOR_COLD_RING_CAPACITY=32
GENERATOR_HOT_RING_THRESHOLD=2
GENERATOR_COLD_RING_THRESHOLD=2
GENERATOR_COLD_TIMEOUT_MILLIS=3000
GENERATOR_COLD_SEND_THRESHOLD_BYTES=4096
GENERATOR_POLLING_INTERVAL_MILLIS=1000
GENERATOR_FILES=[{"filename":"/var/log/*log","hotFilter":["error","failed","critical"]},]

Run the docker image by using the below command.

sudo docker run --env-file ./.env --name generator-test generator

If you want to change the config setting in the container, you can restart by sending the interrupt signal to process

sudo kill -s SIGINT $PID

However, you must not give a relative path in the container configuration file. It will cause unexpected behavior in the analysis.