CueObserve

(โ˜… 235)

Timeseries Anomaly detection and Root Cause Analysis on data in SQL data warehouses and databases

  • .env
  • .env.dev
  • .gitignore
  • anomalies.md
  • anomaly-definitions.md
  • anomaly-detection.md
  • aws_lambda_setup.sh
  • CODE_OF_CONDUCT.md
  • datasets.md
  • development.md
  • docker-compose-dev.yml
  • docker-compose-prod.yml
  • docker-compose.yml
  • Dockerfile
  • getting-started.md
  • installation.md
  • LICENSE
  • README.md
  • root-cause-analysis.md
  • settings.md
  • sources.md
  • SUMMARY.md
  • why-cueobserve.md

# Installation Guide

1. Get the code
git clone https://github.com/cuebook/CueObserve

Downloads the entire project code from GitHub to your computer.

cd CueObserve

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
wget https://raw.githubusercontent.com/cuebook/CueObserve/latest_release/docker-compose-prod.yml -q -O ~/cuebook/docker-compose-prod.yml

Runs the command against the services defined in the compose file.

docker-compose -f docker-compose-prod.yml --env-file .env up -d

Runs the command against the services defined in the compose file.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd ui

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -r alerts-api/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <์‹คํ–‰ํ•  ํŒŒ์ผ๋ช…>.py # README์—์„œ ์ •ํ™•ํ•œ ์‹คํ–‰ ํŒŒ์ผ๋ช…์„ ํ™•์ธํ•˜์„ธ์š”

Runs the Python script (or module).

โœ… If it runs without errors and prints output in the terminal, it worked.
// repository documentation