Quickstart guide

This document describes the steps needed to bring up the LOGIQ observability stack using docker-compose

Please read and agree with the EULA before proceeding.

Install Docker compose

You can spin-up LOGIQ using docker-compose. Install guide for docker-compose can be found here - https://docs.docker.com/compose/install/

NOTE: the docker-compose quick-start YAML files are intended for demo and trial use only. If you want to run a production deployment, we recommend you use Kubernetes with HELM to deploy the LOGIQ stack. Please contact us at : s a l e s @ l o g i q . a i

Running LOGIQ

NOTE: LOGIQ services use approximately 2GB of memory. Please have sufficient memory in your system before proceeding

The first step is to get the appropriate docker-compose YAML file from the URL below.

Download LOGIQ compose file

The latest version of LOGIQ quickstart docker compose image is 2.2.11

You are now ready to bring up the LOGIQ stack.

Download container images

$docker-compose -f docker-compose.quickstart.yml pull

Bring up the stack

$docker-compose -f docker-compose.quickstart.yml up -d

NOTE: If you have been running previous versions of LOGIQ docker-compose, you should stop and remove the existing containers by running docker-compose -f docker-compose.quickstart.yml down and remove any older docker volume via docker-compose -f docker-compose.quickstart.yml rm && docker-compose -f docker-compose.quickstart.yml rm -v

Test using LOGIQ UI

Once the LOGIQ server is up and running, the LOGIQ UI can be accessed as described above on port 80 on the server docker-compose. You will be presented with a login screen as shown below.

Use [email protected] / flash-password to login

Ingesting data

Please refer to section on data ingestion for more details.

Prometheus monitoring and alerting

The LOGIQ quickstart file includes Prometheus and Alertmanager services.

Firewall ports and URLs

Ports

LOGIQ exposes the below ports

  • 7514 - Syslog / TCP - TLS

  • 514 - Syslog / TCP - Non TLS

  • 2514 - RELP/Rsyslog / TCP - TLS

  • 20514 - RELP/Rsyslog / TCP - Non TLS

  • 9998 - Server administration web cli

  • 9999 - REST API

  • 8081 - GRPC ( needed for logiqctl CLI )

  • 80 - http

  • 443 - https

  • 24224/24225 - FluentForward protocol port / TLS

  • 3000 - Grafana instance (optional), not available with quickstart

The ports used to bind are configurable via the server configuration file. See Server options for more details.