Record. Replay. Test.

^{Documentation · Bug Bounty · Maven · IntelliJ Plugin}

Unlogged Server

The unlogged server is a self-hosted service, that can be used with plugin and SDK. Deploy the production service with SDK and it will push the logs to unlogged server. Then the IntelliJ IDEA can download the test candidates, and the production traffic can be replayed locally.

Deployment from local file system

• The server can be deployed without a minio and S3 configuration. All files will be stored in the local file system.

Docker Deployment

• To deploy the server from docker run the following commands:

# create a docker volume 
docker volume create unlogged_volume

# run the docker container
docker run -dp 8123:8123 \
-v unlogged_volume:/usr/src/app/local-session \
ghcr.io/unloggedio/unlogged_server:latest

Docker-compose Deployment

• The server can be deployed using docker compose. An example docker-compose file is as follows:

version: '2'

services:
  unlogged_server:
    image: ghcr.io/unloggedio/unlogged_server:latest
    ports:
      - "8123:8123"
    volumes:
      - unlogged_volume:/usr/src/app/local-session

volumes:
  unlogged_volume:
    external: true

• Create a volume using docker volume create unlogged_volume
• Run the container using docker compose -f path_to_file up -d

Jar Deployment

• The jar can be downloaded from here.
• The command to run from JAR is:

java -jar unlogged_server.jar

Deployment with minio server

Docker Compose Approach

• The server can be deployed with a minio instance. This is a sample docker-compose file for the same:

version: '2'

services:
  unlogged_server:
	image: ghcr.io/unloggedio/unlogged_server:latest
	ports:
	  - "8123:8123"
	environment:
	  - spring.profiles.active=minio
	  - cloud.bucketName=session-logs
	  - cloud.endpoint=http://minio:9000
	  - cloud.aws.region.static=ap-south-1
	  - cloud.aws.credentials.access-key=minio_user
	  - cloud.aws.credentials.secret-key=minio_password
	networks:
	  - unlogged_network
	volumes:
	  - unlogged_volume:/usr/src/app/local-session

  minio:
	image: minio/minio
	container_name: minio
	ports:
	  - "9000:9000"
	command: server /data
	environment:
	  - MINIO_ROOT_USER=minio_user
	  - MINIO_ROOT_PASSWORD=minio_password
	networks:
	  - unlogged_network
	volumes:
	  - unlogged_volume:/usr/src/app/local-session

networks:
  unlogged_network:
    driver: bridge

volumes:
  unlogged_volume:
    external: true

Deployment with a S3 bucket

A S3 bucket needs to created for storing the logs.

Creating a S3 bucket.

• Create a private S3 bucket in AWS. This step is optional, since the server will create a bucket by itself, if a bucket with the given name in region is not found.
• To use the server following environment variables are needed:
  1. bucket_name: Name of the s3 bucket
  2. bucket_region_url: This is the URL of s3 region. For example https://s3.eu-west-1.amazonaws.com
  3. bucket_region: This is region of S3 bucket. For example: eu-west-1.
  4. To get the access_key and secret_key go to the security credentials of you account and create an access key.

Deploying the server

The server can be deployed using docker or the jar file. It can be done on both a private pc for personal testing and an instance of EC2 with public IP for company wide deployment.

Docker Deployment

• To deploy the server from docker run the following commands:

# create a docker volume 
docker volume create unlogged_volume

# run the docker container
docker run -dp 8123:8123 
-v unlogged_volume:/usr/src/app/local-session
-e spring.profiles.active=minio
-e cloud.bucketName=bucket_name
-e cloud.endpoint=bucket_region_url
-e cloud.aws.region.static=bucket_region
-e cloud.aws.credentials.access-key=access_key
-e cloud.aws.credentials.secret-key=secret_key
ghcr.io/unloggedio/unlogged_server:latest

Docker-compose Deployment

• The server can be deployed using docker compose. An example docker-compose file is as follows:

version: '2'

services:
  unlogged_server:
    image: ghcr.io/unloggedio/unlogged_server:latest
    ports:
      - "8123:8123"
    volumes:
      - unlogged_volume:/usr/src/app/local-session
    environment:
	  - spring.profiles.active=minio
      - cloud.bucketName=bucket_name
      - cloud.endpoint=bucket_region_url
      - cloud.aws.region.static=bucket_region
      - cloud.aws.credentials.access-key=access_key
      - cloud.aws.credentials.secret-key=secret_key

volumes:
  unlogged_volume:
    external: true

• Create a volume using docker volume create unlogged_volume
• Run the container using docker compose -f path_to_file up -d

Deployment from JAR

• The jar can be downloaded from here.
• To deploy the service using jar use the following command:

java -jar -Dspring.profiles.active=minio \
	-Dcloud.bucketName=bucket_name \
    -Dcloud.endpoint=bucket_region_url \
    -Dcloud.aws.region.static=bucket_region \
    -Dcloud.aws.credentials.access-key=access_key \
    -Dcloud.aws.credentials.secret-key=secret_key \
    unlogged_server.jar

Verifying the status of deployed service

• If deployed on local machine go to http://localhost:8123/session/ping
• If deployed on an EC2 instance go to http://public_ip:8123/session/ping

Docker Registries

The unlogged docker image is available on the following registries:

• Github GHCR: ghcr.io/unloggedio/unlogged_server:latest

Hardware Requirements

• Minimum: t2.micro
• Recommanded: t2.xlarge

Server Type	Number of vCPU	Memory	Disk Space	Network Performance	Concurrent Sessions	Concurrent Users
t2.micro	1	1 GiB	30 GiB (gp3)	Low to Moderate	1	5
t2.xlarge	4	16 GiB	120 GiB (gp3)	Moderate	4	20